Class AchBatchAdminService

Hierarchy (View Summary)

AchBatchAdminQueryService
- AchBatchAdminService

Index

Constructors

constructor

Properties

Methods

delete get search searchIterator update

Constructors

constructor

new AchBatchAdminService(
    args: {
        db: B2bDatabase;
        internalEventPublisher: InternalEventPublisher;
    },
): AchBatchAdminService
Parameters
- args: { db: B2bDatabase; internalEventPublisher: InternalEventPublisher }
Returns AchBatchAdminService
Overrides AchBatchAdminQueryService.constructor
- Defined in packages/ach-services/src/batch/AchBatchAdminService.ts:13

Properties

`Protected` `Readonly`db

db: B2bDatabase

Methods

delete

delete(
    args: { ids: string[] },
): Promise<
    | { ok: true; value: { count: number } }
    | { error: ServiceError; ok: false },
>
Parameters
- args: { ids: string[] }
Returns Promise<
| { ok: true; value: { count: number } }
| { error: ServiceError; ok: false },
>
- Defined in packages/ach-services/src/batch/AchBatchAdminService.ts:75

get

get(
args: { id: string },
): Promise<{ ok: true; value: AchBatch & { customerName: string } | null }>
Parameters
- args: { id: string }
Returns Promise<{ ok: true; value: AchBatch & { customerName: string } | null }>
Inherited from AchBatchAdminQueryService.get
- Defined in packages/ach-services/src/batch/AchBatchAdminQueryService.ts:136

search

search(
    __namedParameters: {
        achFileIds?: string[] | null;
        createdAt?: DbTimestampCriteria;
        customerIds?: string[];
        ids?: string[];
        orderBy?: DbOrderByCriterion<
            Omit<
                PgTableWithColumns<
                    {
                        columns: {
                            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";
                                },
                            >;
                            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";
                                },
                            >;
                            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";
                        name: "ach_batch";
                        schema: "b2b";
                    },
                >,
                "enableRLS",
            >,
            "createdAt"
            | "updatedAt",
        >[];
        page?: number;
        pageSize?: number;
        q?: string;
        statuses?: ("CREATED" | "PROCESSING" | "PROCESSED" | "DELETED")[];
        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[];
      orderBy?: DbOrderByCriterion<
          Omit<
              PgTableWithColumns<
                  {
                      columns: {
                          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";
                              },
                          >;
                          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";
                              },
                          >;
                          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";
                      name: "ach_batch";
                      schema: "b2b";
                  },
              >,
              "enableRLS",
          >,
          "createdAt"
          | "updatedAt",
      >[];
      page?: number;
      pageSize?: number;
      q?: string;
      statuses?: ("CREATED" | "PROCESSING" | "PROCESSED" | "DELETED")[];
      types?: ("DEPOSIT" | "WITHDRAWAL")[];
      updatedAt?: DbTimestampCriteria;
  }
  - OptionalachFileIds?: string[] | null
  - OptionalcreatedAt?: DbTimestampCriteria
  - OptionalcustomerIds?: string[]
  - Optionalids?: string[]
  - OptionalorderBy?: DbOrderByCriterion<
        Omit<
            PgTableWithColumns<
                {
                    columns: {
                        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";
                            },
                        >;
                        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";
                            },
                        >;
                        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";
                    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")[]
  - Optionaltypes?: ("DEPOSIT" | "WITHDRAWAL")[]
  - OptionalupdatedAt?: DbTimestampCriteria
Returns Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: (AchBatch & { customerName: string })[];
            total: number;
        };
    },
>
Inherited from AchBatchAdminQueryService.search
- Defined in packages/ach-services/src/batch/AchBatchAdminQueryService.ts:143

searchIterator

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

update

update(
    __namedParameters: {
        data: {
            achFileId?: string | null;
            status?: "CREATED" | "PROCESSING" | "PROCESSED" | "DELETED";
        };
        ids: string[];
    },
): Promise<{ ok: true; value: { hasNext: boolean; items: AchBatch[] } }>
Parameters
- __namedParameters: {
      data: {
          achFileId?: string | null;
          status?: "CREATED" | "PROCESSING" | "PROCESSED" | "DELETED";
      };
      ids: string[];
  }
Returns Promise<{ ok: true; value: { hasNext: boolean; items: AchBatch[] } }>
- Defined in packages/ach-services/src/batch/AchBatchAdminService.ts:21

Class AchBatchAdminService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AchBatchAdminService

Properties

`Protected` `Readonly`db

Methods

delete

Parameters

Returns Promise<
| { ok: true; value: { count: number } }
| { error: ServiceError; ok: false },
>

get

Parameters

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

search

Parameters

`Optional`achFileIds?: string[] | null

`Optional`createdAt?: DbTimestampCriteria

`Optional`customerIds?: string[]

`Optional`ids?: string[]

`Optional`page?: number

`Optional`pageSize?: number

`Optional`q?: string

`Optional`statuses?: ("CREATED" | "PROCESSING" | "PROCESSED" | "DELETED")[]

`Optional`types?: ("DEPOSIT" | "WITHDRAWAL")[]

`Optional`updatedAt?: DbTimestampCriteria

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

searchIterator

Parameters

Returns AsyncGenerator<AchBatch>

update

Parameters

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

Settings

On This Page

Class AchBatchAdminService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AchBatchAdminService

Properties

Protected Readonlydb

Methods

delete

Parameters

Returns Promise< | { ok: true; value: { count: number } } | { error: ServiceError; ok: false },>

get

Parameters

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

search

Parameters

OptionalachFileIds?: string[] | null

OptionalcreatedAt?: DbTimestampCriteria

OptionalcustomerIds?: string[]

Optionalids?: string[]

Optionalpage?: number

OptionalpageSize?: number

Optionalq?: string

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

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

OptionalupdatedAt?: DbTimestampCriteria

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

searchIterator

Parameters

Returns AsyncGenerator<AchBatch>

update

Parameters

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

Settings

On This Page

`Protected` `Readonly`db

Returns Promise<
| { ok: true; value: { count: number } }
| { error: ServiceError; ok: false },
>

`Optional`achFileIds?: string[] | null

`Optional`createdAt?: DbTimestampCriteria

`Optional`customerIds?: string[]

`Optional`ids?: string[]

`Optional`page?: number

`Optional`pageSize?: number

`Optional`q?: string

`Optional`statuses?: ("CREATED" | "PROCESSING" | "PROCESSED" | "DELETED")[]

`Optional`types?: ("DEPOSIT" | "WITHDRAWAL")[]

`Optional`updatedAt?: DbTimestampCriteria

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