Class AchFileService

Hierarchy (View Summary)

AchFileQueryService
- AchFileService

Index

Constructors

constructor

Properties

Methods

archive create get mapDbToAchFile search searchIterator stat submit

Constructors

constructor

new AchFileService(
    args: {
        achBatchAdminService: AchBatchAdminService;
        achBatchTransactionService: AchBatchTransactionService;
        achFileS3Service: AchFileS3Service;
        achOriginator: { accountNumber: string; name: string };
        adminEventPublisher: AdminEventPublisher;
        bankAdminService: BankAdminService;
        db: B2bDatabase;
        nachaFileGenerator: NachaFileGenerator;
    },
): AchFileService
Parameters
- args: {
      achBatchAdminService: AchBatchAdminService;
      achBatchTransactionService: AchBatchTransactionService;
      achFileS3Service: AchFileS3Service;
      achOriginator: { accountNumber: string; name: string };
      adminEventPublisher: AdminEventPublisher;
      bankAdminService: BankAdminService;
      db: B2bDatabase;
      nachaFileGenerator: NachaFileGenerator;
  }
  - achBatchAdminService: AchBatchAdminService
  - achBatchTransactionService: AchBatchTransactionService
  - achFileS3Service: AchFileS3Service
  - achOriginator: { accountNumber: string; name: string }
    CFX's own ACH originator account: account number + sender name. The ODFI routing number is resolved from the bank config at file-generation time, not supplied here.
  - adminEventPublisher: AdminEventPublisher
  - bankAdminService: BankAdminService
  - db: B2bDatabase
  - nachaFileGenerator: NachaFileGenerator
Returns AchFileService
Overrides AchFileQueryService.constructor
- Defined in packages/ach-services/src/AchFileService.ts:35

Properties

`Protected` `Readonly`db

db: B2bDatabase

Methods

create

create(
    args: { batchIds: string[]; type: "WITHDRAWAL" | "DEPOSIT" },
): Promise<
    { ok: true; value: AchFile }
    | { error: ServiceError; ok: false },
>
Parameters
- args: { batchIds: string[]; type: "WITHDRAWAL" | "DEPOSIT" }
Returns Promise<{ ok: true; value: AchFile } | { error: ServiceError; ok: false }>
- Defined in packages/ach-services/src/AchFileService.ts:60

get

get(args: { id: string }): Promise<{ ok: true; value: AchFile | null }>
Parameters
- args: { id: string }
Returns Promise<{ ok: true; value: AchFile | null }>
Inherited from AchFileQueryService.get
- Defined in packages/ach-services/src/AchFileQueryService.ts:53

`Protected`mapDbToAchFile

mapDbToAchFile(
    dbRow: Omit<
        {
            createdAt: Date;
            externalId: string;
            id: number;
            metadata: AchFileMetadata;
            status: "CREATED"
            | "SUBMITTED"
            | "ARCHIVED";
            type: "WITHDRAWAL" | "DEPOSIT";
            updatedAt: Date;
        },
        "id",
    > & { id: string },
): AchFile
Parameters
- dbRow: Omit<
      {
          createdAt: Date;
          externalId: string;
          id: number;
          metadata: AchFileMetadata;
          status: "CREATED"
          | "SUBMITTED"
          | "ARCHIVED";
          type: "WITHDRAWAL" | "DEPOSIT";
          updatedAt: Date;
      },
      "id",
  > & { id: string }
Returns AchFile
Inherited from AchFileQueryService.mapDbToAchFile
- Defined in packages/ach-services/src/AchFileQueryService.ts:162

search

search(
    __namedParameters: {
        createdAt?: DbTimestampCriteria;
        ids?: string[];
        orderBy?: DbOrderByCriterion<
            Omit<
                PgTableWithColumns<
                    {
                        columns: {
                            createdAt: PgBuildColumn<
                                "ach_file",
                                SetHasDefault<SetNotNull<(...)>>,
                                {
                                    data: Date;
                                    dataType: "object date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ach_file";
                                },
                            >;
                            externalId: PgBuildColumn<
                                "ach_file",
                                SetHasGenerated<SetNotNull<(...)>>,
                                {
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: true;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ach_file";
                                },
                            >;
                            id: PgBuildColumn<
                                "ach_file",
                                HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...) | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: "byDefault";
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ach_file";
                                },
                            >;
                            metadata: PgBuildColumn<
                                "ach_file",
                                SetHasDefault<SetNotNull<(...)>>,
                                {
                                    data: AchFileMetadata;
                                    dataType: "object json";
                                    driverParam: unknown;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ach_file";
                                },
                            >;
                            status: PgBuildColumn<
                                "ach_file",
                                SetHasDefault<Set$Type<(...), (...)>>,
                                {
                                    data: (...) | (...) | (...);
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ach_file";
                                },
                            >;
                            type: PgBuildColumn<
                                "ach_file",
                                SetNotNull<Set$Type<(...), (...)>>,
                                {
                                    data: (...) | (...);
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ach_file";
                                },
                            >;
                            updatedAt: PgBuildColumn<
                                "ach_file",
                                SetHasDefault<SetHasDefault<(...)>>,
                                {
                                    data: Date;
                                    dataType: "object date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: true;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ach_file";
                                },
                            >;
                        };
                        dialect: "pg";
                        name: "ach_file";
                        schema: "b2b";
                    },
                >,
                "enableRLS",
            >,
            "createdAt"
            | "updatedAt",
        >[];
        page?: number;
        pageSize?: number;
        status?: "CREATED" | "SUBMITTED" | "ARCHIVED";
        updatedAt?: DbTimestampCriteria;
    },
): Promise<{ ok: true; value: { hasNext: boolean; items: AchFile[] } }>
Parameters
- __namedParameters: {
      createdAt?: DbTimestampCriteria;
      ids?: string[];
      orderBy?: DbOrderByCriterion<
          Omit<
              PgTableWithColumns<
                  {
                      columns: {
                          createdAt: PgBuildColumn<
                              "ach_file",
                              SetHasDefault<SetNotNull<(...)>>,
                              {
                                  data: Date;
                                  dataType: "object date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ach_file";
                              },
                          >;
                          externalId: PgBuildColumn<
                              "ach_file",
                              SetHasGenerated<SetNotNull<(...)>>,
                              {
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: true;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ach_file";
                              },
                          >;
                          id: PgBuildColumn<
                              "ach_file",
                              HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...) | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: "byDefault";
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ach_file";
                              },
                          >;
                          metadata: PgBuildColumn<
                              "ach_file",
                              SetHasDefault<SetNotNull<(...)>>,
                              {
                                  data: AchFileMetadata;
                                  dataType: "object json";
                                  driverParam: unknown;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ach_file";
                              },
                          >;
                          status: PgBuildColumn<
                              "ach_file",
                              SetHasDefault<Set$Type<(...), (...)>>,
                              {
                                  data: (...) | (...) | (...);
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ach_file";
                              },
                          >;
                          type: PgBuildColumn<
                              "ach_file",
                              SetNotNull<Set$Type<(...), (...)>>,
                              {
                                  data: (...) | (...);
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ach_file";
                              },
                          >;
                          updatedAt: PgBuildColumn<
                              "ach_file",
                              SetHasDefault<SetHasDefault<(...)>>,
                              {
                                  data: Date;
                                  dataType: "object date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: true;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ach_file";
                              },
                          >;
                      };
                      dialect: "pg";
                      name: "ach_file";
                      schema: "b2b";
                  },
              >,
              "enableRLS",
          >,
          "createdAt"
          | "updatedAt",
      >[];
      page?: number;
      pageSize?: number;
      status?: "CREATED" | "SUBMITTED" | "ARCHIVED";
      updatedAt?: DbTimestampCriteria;
  }
  - OptionalcreatedAt?: DbTimestampCriteria
  - Optionalids?: string[]
  - OptionalorderBy?: DbOrderByCriterion<
        Omit<
            PgTableWithColumns<
                {
                    columns: {
                        createdAt: PgBuildColumn<
                            "ach_file",
                            SetHasDefault<SetNotNull<(...)>>,
                            {
                                data: Date;
                                dataType: "object date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "ach_file";
                            },
                        >;
                        externalId: PgBuildColumn<
                            "ach_file",
                            SetHasGenerated<SetNotNull<(...)>>,
                            {
                                data: string;
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: true;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "ach_file";
                            },
                        >;
                        id: PgBuildColumn<
                            "ach_file",
                            HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                            {
                                data: number;
                                dataType: "number int32";
                                driverParam: (...) | (...);
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: "byDefault";
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "ach_file";
                            },
                        >;
                        metadata: PgBuildColumn<
                            "ach_file",
                            SetHasDefault<SetNotNull<(...)>>,
                            {
                                data: AchFileMetadata;
                                dataType: "object json";
                                driverParam: unknown;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "ach_file";
                            },
                        >;
                        status: PgBuildColumn<
                            "ach_file",
                            SetHasDefault<Set$Type<(...), (...)>>,
                            {
                                data: (...) | (...) | (...);
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "ach_file";
                            },
                        >;
                        type: PgBuildColumn<
                            "ach_file",
                            SetNotNull<Set$Type<(...), (...)>>,
                            {
                                data: (...) | (...);
                                dataType: "string";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: false;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "ach_file";
                            },
                        >;
                        updatedAt: PgBuildColumn<
                            "ach_file",
                            SetHasDefault<SetHasDefault<(...)>>,
                            {
                                data: Date;
                                dataType: "object date";
                                driverParam: string;
                                enumValues: undefined;
                                generated: undefined;
                                hasDefault: true;
                                hasRuntimeDefault: false;
                                identity: undefined;
                                isAutoincrement: false;
                                isPrimaryKey: false;
                                name: string;
                                notNull: true;
                                tableName: "ach_file";
                            },
                        >;
                    };
                    dialect: "pg";
                    name: "ach_file";
                    schema: "b2b";
                },
            >,
            "enableRLS",
        >,
        "createdAt"
        | "updatedAt",
    >[]
  - Optionalpage?: number
    Defaults to 1
  - OptionalpageSize?: number
    Defaults to 100
  - Optionalstatus?: "CREATED" | "SUBMITTED" | "ARCHIVED"
  - OptionalupdatedAt?: DbTimestampCriteria
Returns Promise<{ ok: true; value: { hasNext: boolean; items: AchFile[] } }>
Inherited from AchFileQueryService.search
- Defined in packages/ach-services/src/AchFileQueryService.ts:64

searchIterator

searchIterator(
params: Omit<Parameters<AchFileQueryService["search"]>[0], "page">,
): AsyncGenerator<AchFile>
Parameters
- params: Omit<Parameters<AchFileQueryService["search"]>[0], "page">
Returns AsyncGenerator<AchFile>
Inherited from AchFileQueryService.searchIterator
- Defined in packages/ach-services/src/AchFileQueryService.ts:120

stat

stat(
args?: { status?: "CREATED" | "SUBMITTED" | "ARCHIVED" },
): Promise<{ ok: true; value: { count: number } }>
Scalar count of ach_file rows, optionally filtered by status. Used by operator dashboards (work-queue tiles) where iterating search just to derive a count would be wasteful.
Parameters
- args: { status?: "CREATED" | "SUBMITTED" | "ARCHIVED" } = {}
Returns Promise<{ ok: true; value: { count: number } }>
Inherited from AchFileQueryService.stat
- Defined in packages/ach-services/src/AchFileQueryService.ts:148

submit

submit(
    args: { ids: string[] },
): Promise<
    { ok: true; value: undefined }
    | { error: ServiceError; ok: false },
>
Parameters
- args: { ids: string[] }
Returns Promise<{ ok: true; value: undefined } | { error: ServiceError; ok: false }>
- Defined in packages/ach-services/src/AchFileService.ts:291

Class AchFileService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

achBatchAdminService: AchBatchAdminService

achBatchTransactionService: AchBatchTransactionService

achFileS3Service: AchFileS3Service

achOriginator: { accountNumber: string; name: string }

adminEventPublisher: AdminEventPublisher

bankAdminService: BankAdminService

db: B2bDatabase

nachaFileGenerator: NachaFileGenerator

Returns AchFileService

Properties

Protected Readonlydb

Methods

archive

Parameters

Returns Promise< | { ok: true; value: { affectedBatchIds: string[] } } | { error: ServiceError; ok: false },>

create

Parameters

Returns Promise<{ ok: true; value: AchFile } | { error: ServiceError; ok: false }>

get

Parameters

Returns Promise<{ ok: true; value: AchFile | null }>

ProtectedmapDbToAchFile

Parameters

Returns AchFile

search

Parameters

OptionalcreatedAt?: DbTimestampCriteria

Optionalids?: string[]

Optionalpage?: number

OptionalpageSize?: number

Optionalstatus?: "CREATED" | "SUBMITTED" | "ARCHIVED"

OptionalupdatedAt?: DbTimestampCriteria

Returns Promise<{ ok: true; value: { hasNext: boolean; items: AchFile[] } }>

searchIterator

Parameters

Returns AsyncGenerator<AchFile>

stat

Parameters

Returns Promise<{ ok: true; value: { count: number } }>

submit

Parameters

Returns Promise<{ ok: true; value: undefined } | { error: ServiceError; ok: false }>

Settings

On This Page

`Protected` `Readonly`db

Returns Promise<
| { ok: true; value: { affectedBatchIds: string[] } }
| { error: ServiceError; ok: false },
>

`Protected`mapDbToAchFile

`Optional`createdAt?: DbTimestampCriteria

`Optional`ids?: string[]

`Optional`page?: number

`Optional`pageSize?: number

`Optional`status?: "CREATED" | "SUBMITTED" | "ARCHIVED"

`Optional`updatedAt?: DbTimestampCriteria