@cfxlabsinc/b2b-services
    Preparing search index...

    Class AchFileService

    Hierarchy (View Summary)

    Index
    constructor
    db
    archive create get mapDbToAchFile search searchIterator stat submit

    • Parameters

      • args: {
            achBatchAdminService: AchBatchAdminService;
            achBatchTransactionService: AchBatchTransactionService;
            achFileS3Service: AchFileS3Service;
            achOriginator: { accountNumber: string; name: string };
            bankAdminService: BankAdminService;
            db: B2bDatabase;
            internalEventPublisher: InternalEventPublisher;
            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.

        • bankAdminService: BankAdminService
        • db: B2bDatabase
        • internalEventPublisher: InternalEventPublisher
        • nachaFileGenerator: NachaFileGenerator

      Returns AchFileService

    db: B2bDatabase

    • Parameters

      • args: { id: string[] }

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

    • Parameters

      • args: { batchIds: string[]; type: "DEPOSIT" | "WITHDRAWAL" }

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

    • Parameters

      • dbRow: Omit<
            {
                createdAt: Date;
                externalId: string;
                id: number;
                metadata: AchFileMetadata;
                status: "CREATED"
                | "SUBMITTED"
                | "ARCHIVED";
                type: "DEPOSIT" | "WITHDRAWAL";
                updatedAt: Date;
            },
            "id",
        > & { id: string }

      Returns 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;
            q?: string;
            statuses?: ("CREATED" | "SUBMITTED" | "ARCHIVED")[];
            types?: ("DEPOSIT" | "WITHDRAWAL")[];
            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

        • Optionalq?: string

          Free-text filter: case-insensitive substring on the ach_file external id. Backs the admin list's command-search hero.

        • Optionalstatuses?: ("CREATED" | "SUBMITTED" | "ARCHIVED")[]
        • Optionaltypes?: ("DEPOSIT" | "WITHDRAWAL")[]
        • OptionalupdatedAt?: DbTimestampCriteria

      Returns Promise<
          {
              ok: true;
              value: { hasNext: boolean; items: AchFile[]; total: 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 } }>

    • Parameters

      • args: { ids: string[] }

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

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods