Class AchBatchAdminQueryService

constructor

• new AchBatchAdminQueryService(
      args: { db: B2bDatabase },
  ): AchBatchAdminQueryService

  Parameters

  • args: { db: B2bDatabase }

  Returns AchBatchAdminQueryService

Staticinstance

get

• get(
      args: {
          id: string;
          tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
      },
  ): Promise<{ ok: true; value: AchBatch & { customerName: string } | null }>

  Parameters

  • args: { id: string; tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations> }

  Returns Promise<{ ok: true; value: AchBatch & { customerName: string } | null }>

search

• search(
      __namedParameters: {
          achFileIds?: string[] | null;
          createdAt?: DbTimestampCriteria;
          customerIds?: string[];
          ids?: string[];
          includeDeleted?: boolean;
          orderBy?: DbOrderByCriterion<
              Omit<
                  PgTableWithColumns<
                      {
                          columns: {
                              achFileExternalId: PgBuildColumn<
                                  "ach_batch",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "ach_batch";
                                  },
                              >;
                              achFileId: PgBuildColumn<
                                  "ach_batch",
                                  PgIntegerBuilder,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...)
                                      | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "ach_batch";
                                  },
                              >;
                              createdAt: PgBuildColumn<
                                  "ach_batch",
                                  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_batch";
                                  },
                              >;
                              customerExternalId: PgBuildColumn<
                                  "ach_batch",
                                  SetNotNull<PgTextBuilder<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "ach_batch";
                                  },
                              >;
                              customerId: PgBuildColumn<
                                  "ach_batch",
                                  SetNotNull<PgIntegerBuilder>,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...) | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "ach_batch";
                                  },
                              >;
                              deletedAt: PgBuildColumn<
                                  "ach_batch",
                                  PgTimestampBuilder,
                                  {
                                      data: Date;
                                      dataType: "object date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "ach_batch";
                                  },
                              >;
                              externalId: PgBuildColumn<
                                  "ach_batch",
                                  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_batch";
                                  },
                              >;
                              id: PgBuildColumn<
                                  "ach_batch",
                                  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_batch";
                                  },
                              >;
                              searchDocument: PgBuildColumn<
                                  "ach_batch",
                                  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_batch";
                                  },
                              >;
                              status: PgBuildColumn<
                                  "ach_batch",
                                  SetHasDefault<SetNotNull<(...)>>,
                                  {
                                      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_batch";
                                  },
                              >;
                              type: PgBuildColumn<
                                  "ach_batch",
                                  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_batch";
                                  },
                              >;
                              updatedAt: PgBuildColumn<
                                  "ach_batch",
                                  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_batch";
                                  },
                              >;
                          };
                          dialect: "pg";
                          isAlias: false;
                          name: "ach_batch";
                          schema: "b2b";
                      },
                  >,
                  "enableRLS",
              >,
              "createdAt"
              | "updatedAt",
          >[];
          page?: number;
          pageSize?: number;
          q?: string;
          statuses?: ("CREATED" | "PROCESSING" | "PROCESSED" | "DELETED")[];
          tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
          types?: ("DEPOSIT" | "WITHDRAWAL")[];
          updatedAt?: DbTimestampCriteria;
      },
  ): Promise<
      {
          ok: true;
          value: {
              hasNext: boolean;
              items: (AchBatch & { customerName: string })[];
              total: number;
          };
      },
  >

  Parameters

  • __namedParameters: {
        achFileIds?: string[] | null;
        createdAt?: DbTimestampCriteria;
        customerIds?: string[];
        ids?: string[];
        includeDeleted?: boolean;
        orderBy?: DbOrderByCriterion<
            Omit<
                PgTableWithColumns<
                    {
                        columns: {
                            achFileExternalId: PgBuildColumn<
                                "ach_batch",
                                PgTextBuilder<[(...), ...(...)[]]>,
                                {
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "ach_batch";
                                },
                            >;
                            achFileId: PgBuildColumn<
                                "ach_batch",
                                PgIntegerBuilder,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...)
                                    | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "ach_batch";
                                },
                            >;
                            createdAt: PgBuildColumn<
                                "ach_batch",
                                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_batch";
                                },
                            >;
                            customerExternalId: PgBuildColumn<
                                "ach_batch",
                                SetNotNull<PgTextBuilder<(...)>>,
                                {
                                    data: string;
                                    dataType: "string";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ach_batch";
                                },
                            >;
                            customerId: PgBuildColumn<
                                "ach_batch",
                                SetNotNull<PgIntegerBuilder>,
                                {
                                    data: number;
                                    dataType: "number int32";
                                    driverParam: (...) | (...);
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: true;
                                    tableName: "ach_batch";
                                },
                            >;
                            deletedAt: PgBuildColumn<
                                "ach_batch",
                                PgTimestampBuilder,
                                {
                                    data: Date;
                                    dataType: "object date";
                                    driverParam: string;
                                    enumValues: undefined;
                                    generated: undefined;
                                    hasDefault: false;
                                    hasRuntimeDefault: false;
                                    identity: undefined;
                                    isAutoincrement: false;
                                    isPrimaryKey: false;
                                    name: string;
                                    notNull: false;
                                    tableName: "ach_batch";
                                },
                            >;
                            externalId: PgBuildColumn<
                                "ach_batch",
                                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_batch";
                                },
                            >;
                            id: PgBuildColumn<
                                "ach_batch",
                                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_batch";
                                },
                            >;
                            searchDocument: PgBuildColumn<
                                "ach_batch",
                                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_batch";
                                },
                            >;
                            status: PgBuildColumn<
                                "ach_batch",
                                SetHasDefault<SetNotNull<(...)>>,
                                {
                                    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_batch";
                                },
                            >;
                            type: PgBuildColumn<
                                "ach_batch",
                                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_batch";
                                },
                            >;
                            updatedAt: PgBuildColumn<
                                "ach_batch",
                                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_batch";
                                },
                            >;
                        };
                        dialect: "pg";
                        isAlias: false;
                        name: "ach_batch";
                        schema: "b2b";
                    },
                >,
                "enableRLS",
            >,
            "createdAt"
            | "updatedAt",
        >[];
        page?: number;
        pageSize?: number;
        q?: string;
        statuses?: ("CREATED" | "PROCESSING" | "PROCESSED" | "DELETED")[];
        tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
        types?: ("DEPOSIT" | "WITHDRAWAL")[];
        updatedAt?: DbTimestampCriteria;
    }

    • OptionalachFileIds?: string[] | null

    • OptionalcreatedAt?: DbTimestampCriteria

    • OptionalcustomerIds?: string[]

    • Optionalids?: string[]

    • OptionalincludeDeleted?: boolean

      With no statuses, deleted batches are left out unless this is true.

    • OptionalorderBy?: DbOrderByCriterion<
          Omit<
              PgTableWithColumns<
                  {
                      columns: {
                          achFileExternalId: PgBuildColumn<
                              "ach_batch",
                              PgTextBuilder<[(...), ...(...)[]]>,
                              {
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "ach_batch";
                              },
                          >;
                          achFileId: PgBuildColumn<
                              "ach_batch",
                              PgIntegerBuilder,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...)
                                  | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "ach_batch";
                              },
                          >;
                          createdAt: PgBuildColumn<
                              "ach_batch",
                              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_batch";
                              },
                          >;
                          customerExternalId: PgBuildColumn<
                              "ach_batch",
                              SetNotNull<PgTextBuilder<(...)>>,
                              {
                                  data: string;
                                  dataType: "string";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ach_batch";
                              },
                          >;
                          customerId: PgBuildColumn<
                              "ach_batch",
                              SetNotNull<PgIntegerBuilder>,
                              {
                                  data: number;
                                  dataType: "number int32";
                                  driverParam: (...) | (...);
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: true;
                                  tableName: "ach_batch";
                              },
                          >;
                          deletedAt: PgBuildColumn<
                              "ach_batch",
                              PgTimestampBuilder,
                              {
                                  data: Date;
                                  dataType: "object date";
                                  driverParam: string;
                                  enumValues: undefined;
                                  generated: undefined;
                                  hasDefault: false;
                                  hasRuntimeDefault: false;
                                  identity: undefined;
                                  isAutoincrement: false;
                                  isPrimaryKey: false;
                                  name: string;
                                  notNull: false;
                                  tableName: "ach_batch";
                              },
                          >;
                          externalId: PgBuildColumn<
                              "ach_batch",
                              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_batch";
                              },
                          >;
                          id: PgBuildColumn<
                              "ach_batch",
                              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_batch";
                              },
                          >;
                          searchDocument: PgBuildColumn<
                              "ach_batch",
                              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_batch";
                              },
                          >;
                          status: PgBuildColumn<
                              "ach_batch",
                              SetHasDefault<SetNotNull<(...)>>,
                              {
                                  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_batch";
                              },
                          >;
                          type: PgBuildColumn<
                              "ach_batch",
                              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_batch";
                              },
                          >;
                          updatedAt: PgBuildColumn<
                              "ach_batch",
                              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_batch";
                              },
                          >;
                      };
                      dialect: "pg";
                      isAlias: false;
                      name: "ach_batch";
                      schema: "b2b";
                  },
              >,
              "enableRLS",
          >,
          "createdAt"
          | "updatedAt",
      >[]

    • Optionalpage?: number

      Defaults to 1

    • OptionalpageSize?: number

      Defaults to 50

    • Optionalq?: string

      Free-text filter: case-insensitive substring across the batch external id, the owning customer's name, and the attached ACH file's external id.

    • Optionalstatuses?: ("CREATED" | "PROCESSING" | "PROCESSED" | "DELETED")[]

    • Optionaltx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>

      Reads inside the caller's transaction, under the row locks it holds.

    • Optionaltypes?: ("DEPOSIT" | "WITHDRAWAL")[]

    • OptionalupdatedAt?: DbTimestampCriteria

  Returns Promise<
      {
          ok: true;
          value: {
              hasNext: boolean;
              items: (AchBatch & { customerName: string })[];
              total: number;
          };
      },
  >

searchIterator

• searchIterator(
      params: Omit<Parameters<AchBatchAdminQueryService["search"]>[0], "page">,
  ): AsyncGenerator<AchBatch>

  Parameters

  • params: Omit<Parameters<AchBatchAdminQueryService["search"]>[0], "page">

  Returns AsyncGenerator<AchBatch>