Class ProductRouteAdminService

Admin-tier CRUD over product_route.

Identity / version split: product_route is the lifecycle row (status, priority, deletedAt). product_route_version carries the routing decision: which vendor + which matcher. Per-vendor fee/limit deal terms live on product_vendor and are shared across every route pinned to that vendor; edit those through the vendor admin service.

Soft-delete is the terminal signal.

Index

Constructors

constructor

Properties

Methods

create delete get history search update

Constructors

constructor

new ProductRouteAdminService(
__namedParameters: { db: B2bDatabase },
): ProductRouteAdminService
Parameters
- __namedParameters: { db: B2bDatabase }
Returns ProductRouteAdminService
- Defined in packages/product-services/src/ProductRouteAdminService.ts:97

Properties

`Protected` `Readonly`db

db: B2bDatabase

Methods

create

create(
    input: {
        data?: ProductRouteVersionData;
        effectiveFrom?: Instant;
        label?: string | null;
        matcher?: Matcher;
        productName:
            | "organization.v1"
            | "identity.v1"
            | "card.physical_card.v1"
            | "card.virtual_card.v1"
            | "deposit.us_cash.v1"
            | "deposit.rtp.v1"
            | "deposit.us_bank_ach.v1"
            | "deposit.ach_credit.v1"
            | "deposit.us_wire.v1"
            | "deposit.swift_wire.v1"
            | "transfer.redemption.v1"
            | "swap.v1"
            | "withdraw.blockchain.v1"
            | "withdraw.ke_bank.v1"
            | "withdraw.ke_momo.v1"
            | "withdraw.mx_bank_spei.v1"
            | "withdraw.swift_wire.v1"
            | "withdraw.tg_momo.v1"
            | "withdraw.us_bank_ach.v1"
            | "withdraw.us_instant.v1"
            | "withdraw.us_wire.v1"
            | "withdraw.ach_pull.v1"
            | "withdraw.us_wire_drawdown.v1"
            | "account.virtual-account.v1"
            | "deposit.*"
            | "withdraw.*";
        vendor: Vendor;
    },
): Promise<
    | { ok: true; value: AdminProductRoute }
    | { error: ServiceError; ok: false },
>
Parameters
- input: {
      data?: ProductRouteVersionData;
      effectiveFrom?: Instant;
      label?: string | null;
      matcher?: Matcher;
      productName:
          | "organization.v1"
          | "identity.v1"
          | "card.physical_card.v1"
          | "card.virtual_card.v1"
          | "deposit.us_cash.v1"
          | "deposit.rtp.v1"
          | "deposit.us_bank_ach.v1"
          | "deposit.ach_credit.v1"
          | "deposit.us_wire.v1"
          | "deposit.swift_wire.v1"
          | "transfer.redemption.v1"
          | "swap.v1"
          | "withdraw.blockchain.v1"
          | "withdraw.ke_bank.v1"
          | "withdraw.ke_momo.v1"
          | "withdraw.mx_bank_spei.v1"
          | "withdraw.swift_wire.v1"
          | "withdraw.tg_momo.v1"
          | "withdraw.us_bank_ach.v1"
          | "withdraw.us_instant.v1"
          | "withdraw.us_wire.v1"
          | "withdraw.ach_pull.v1"
          | "withdraw.us_wire_drawdown.v1"
          | "account.virtual-account.v1"
          | "deposit.*"
          | "withdraw.*";
      vendor: Vendor;
  }
  - Optionaldata?: ProductRouteVersionData
    Per-route operational knobs (timezone, quote TTL, ...). Persisted to product_route_version.data. Defaults to {} when omitted.
  - OptionaleffectiveFrom?: Instant
    When this version becomes effective. Defaults to now() at the DB layer when omitted. Pass a future Temporal.Instant to schedule a route change.
  - Optionallabel?: string | null
  - Optionalmatcher?: Matcher
  - productName:
        | "organization.v1"
        | "identity.v1"
        | "card.physical_card.v1"
        | "card.virtual_card.v1"
        | "deposit.us_cash.v1"
        | "deposit.rtp.v1"
        | "deposit.us_bank_ach.v1"
        | "deposit.ach_credit.v1"
        | "deposit.us_wire.v1"
        | "deposit.swift_wire.v1"
        | "transfer.redemption.v1"
        | "swap.v1"
        | "withdraw.blockchain.v1"
        | "withdraw.ke_bank.v1"
        | "withdraw.ke_momo.v1"
        | "withdraw.mx_bank_spei.v1"
        | "withdraw.swift_wire.v1"
        | "withdraw.tg_momo.v1"
        | "withdraw.us_bank_ach.v1"
        | "withdraw.us_instant.v1"
        | "withdraw.us_wire.v1"
        | "withdraw.ach_pull.v1"
        | "withdraw.us_wire_drawdown.v1"
        | "account.virtual-account.v1"
        | "deposit.*"
        | "withdraw.*"
  - vendor: Vendor
Returns Promise<
| { ok: true; value: AdminProductRoute }
| { error: ServiceError; ok: false },
>
- Defined in packages/product-services/src/ProductRouteAdminService.ts:101

delete

delete(
input: { id: string },
): Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>
Soft-delete a route. Rules attached to the route persist until removed.
Parameters
- input: { id: string }
Returns Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>
- Defined in packages/product-services/src/ProductRouteAdminService.ts:338

get

get(input: { id: string }): Promise<AdminProductRoute | null>
Parameters
- input: { id: string }
Returns Promise<AdminProductRoute | null>
- Defined in packages/product-services/src/ProductRouteAdminService.ts:459

history

history(input: { id: string }): Promise<RouteVersion[] | null>
Read the full append-only version history for a route, newest first. Returns null when the route doesn't exist (or is soft-deleted).
Parameters
- input: { id: string }
Returns Promise<RouteVersion[] | null>
- Defined in packages/product-services/src/ProductRouteAdminService.ts:498

search

search(
    input: {
        bankIds?: string[];
        createdAt?: DbTimestampCriteria<Instant>;
        ids?: string[];
        orderBy?: "createdAt" | "updatedAt";
        page?: number;
        pageSize?: number;
        productNames?: (
            | "organization.v1"
            | "identity.v1"
            | "card.physical_card.v1"
            | "card.virtual_card.v1"
            | "deposit.us_cash.v1"
            | "deposit.rtp.v1"
            | "deposit.us_bank_ach.v1"
            | "deposit.ach_credit.v1"
            | "deposit.us_wire.v1"
            | "deposit.swift_wire.v1"
            | "transfer.redemption.v1"
            | "swap.v1"
            | "withdraw.blockchain.v1"
            | "withdraw.ke_bank.v1"
            | "withdraw.ke_momo.v1"
            | "withdraw.mx_bank_spei.v1"
            | "withdraw.swift_wire.v1"
            | "withdraw.tg_momo.v1"
            | "withdraw.us_bank_ach.v1"
            | "withdraw.us_instant.v1"
            | "withdraw.us_wire.v1"
            | "withdraw.ach_pull.v1"
            | "withdraw.us_wire_drawdown.v1"
            | "account.virtual-account.v1"
            | "deposit.*"
            | "withdraw.*"
        )[];
        updatedAt?: DbTimestampCriteria<Instant>;
        vendors?: Vendor[];
    },
): Promise<
    { ok: true; value: { hasNext: boolean; items: AdminProductRoute[] } },
>
Parameters
- input: {
      bankIds?: string[];
      createdAt?: DbTimestampCriteria<Instant>;
      ids?: string[];
      orderBy?: "createdAt" | "updatedAt";
      page?: number;
      pageSize?: number;
      productNames?: (
          | "organization.v1"
          | "identity.v1"
          | "card.physical_card.v1"
          | "card.virtual_card.v1"
          | "deposit.us_cash.v1"
          | "deposit.rtp.v1"
          | "deposit.us_bank_ach.v1"
          | "deposit.ach_credit.v1"
          | "deposit.us_wire.v1"
          | "deposit.swift_wire.v1"
          | "transfer.redemption.v1"
          | "swap.v1"
          | "withdraw.blockchain.v1"
          | "withdraw.ke_bank.v1"
          | "withdraw.ke_momo.v1"
          | "withdraw.mx_bank_spei.v1"
          | "withdraw.swift_wire.v1"
          | "withdraw.tg_momo.v1"
          | "withdraw.us_bank_ach.v1"
          | "withdraw.us_instant.v1"
          | "withdraw.us_wire.v1"
          | "withdraw.ach_pull.v1"
          | "withdraw.us_wire_drawdown.v1"
          | "account.virtual-account.v1"
          | "deposit.*"
          | "withdraw.*"
      )[];
      updatedAt?: DbTimestampCriteria<Instant>;
      vendors?: Vendor[];
  }
Returns Promise<{ ok: true; value: { hasNext: boolean; items: AdminProductRoute[] } }>
- Defined in packages/product-services/src/ProductRouteAdminService.ts:362

update

update(
    input: {
        data: {
            effectiveFrom?: Instant;
            priority?: number;
            status?: "ACTIVE" | "DISABLED";
        } & RouteVersionFields;
        id: string;
    },
): Promise<
    | { ok: true; value: AdminProductRoute }
    | { error: ServiceError; ok: false },
>
Update a route. priority and status edits update the identity row in place; matcher/vendor/label edits insert a new version and flip the pointer. Both can happen in the same transaction. productName is part of identity and not editable. Per-vendor fee/limit terms aren't editable here — those live on product_vendor (use the vendor admin service).
Parameters
- input: {
      data: {
          effectiveFrom?: Instant;
          priority?: number;
          status?: "ACTIVE" | "DISABLED";
      } & RouteVersionFields;
      id: string;
  }
Returns Promise<
| { ok: true; value: AdminProductRoute }
| { error: ServiceError; ok: false },
>
- Defined in packages/product-services/src/ProductRouteAdminService.ts:194

Class ProductRouteAdminService

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ProductRouteAdminService

Properties

`Protected` `Readonly`db

Methods

create

Parameters

`Optional`data?: ProductRouteVersionData

`Optional`effectiveFrom?: Instant

`Optional`label?: string | null

`Optional`matcher?: Matcher

vendor: Vendor

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

delete

Parameters

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

get

Parameters

Returns Promise<AdminProductRoute | null>

history

Parameters

Returns Promise<RouteVersion[] | null>

search

Parameters

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

update

Parameters

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

Settings

On This Page

Class ProductRouteAdminService

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ProductRouteAdminService

Properties

Protected Readonlydb

Methods

create

Parameters

Optionaldata?: ProductRouteVersionData

OptionaleffectiveFrom?: Instant

Optionallabel?: string | null

Optionalmatcher?: Matcher

vendor: Vendor

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

delete

Parameters

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

get

Parameters

Returns Promise<AdminProductRoute | null>

history

Parameters

Returns Promise<RouteVersion[] | null>

search

Parameters

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

update

Parameters

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

Settings

On This Page

`Protected` `Readonly`db

`Optional`data?: ProductRouteVersionData

`Optional`effectiveFrom?: Instant

`Optional`label?: string | null

`Optional`matcher?: Matcher

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

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