Class ProductAdminService

Index

Constructors

constructor

Properties

Methods

get search update

Constructors

constructor

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

Properties

`Protected` `Readonly`db

db: B2bDatabase

Methods

get

get(
    __namedParameters: {
        id:
            | "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.*";
    },
): Promise<Product | null>
Parameters
- __namedParameters: {
      id:
          | "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.*";
  }
Returns Promise<Product | null>
- Defined in packages/product-services/src/ProductAdminService.ts:64

search

search(
    input?: {
        ids?: (
            | "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.*"
        )[];
        orderBy?: {
            direction: "ASC"
            | "DESC";
            field: "updatedAt" | "externalId" | "name";
        }[];
        page?: number;
        pageSize?: number;
        q?: string;
    },
): Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: Product[]; total: number };
    },
>
List products. Always paginated (pageSize defaults to 50) — a caller that wants every row pages through with searchIterator, never by omitting the page size. An "unpaginated when you don't ask" mode is exactly the shape that let fetchVendorList silently truncate at 50 rows.
Parameters
- input: {
      ids?: (
          | "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.*"
      )[];
      orderBy?: {
          direction: "ASC"
          | "DESC";
          field: "updatedAt" | "externalId" | "name";
      }[];
      page?: number;
      pageSize?: number;
      q?: string;
  } = {}
  - Optionalids?: (
        | "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.*"
    )[]
  - OptionalorderBy?: { direction: "ASC" | "DESC"; field: "updatedAt" | "externalId" | "name" }[]
  - Optionalpage?: number
  - OptionalpageSize?: number
  - Optionalq?: string
    
    Case-insensitive substring over externalId and name.
Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: Product[]; total: number };
    },
>
- Defined in packages/product-services/src/ProductAdminService.ts:75

update

update(
    input: {
        data: {
            apiStage?: string | null;
            description?: string | null;
            name?: string;
        };
        id: | "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.*";
    },
): Promise<
    { ok: true; value: Product }
    | { error: ServiceError; ok: false },
>
Update mutable fields on a product. Only name, description, and apiStage are editable; id/externalId is the seeded ProductName enum value and immutable. Pass null for description or apiStage to clear it (e.g. unlink the api stage).
Parameters
- input: {
      data: {
          apiStage?: string | null;
          description?: string | null;
          name?: string;
      };
      id: | "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.*";
  }
Returns Promise<{ ok: true; value: Product } | { error: ServiceError; ok: false }>
- Defined in packages/product-services/src/ProductAdminService.ts:147

Class ProductAdminService

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ProductAdminService

Properties

`Protected` `Readonly`db

Methods

get

Parameters

Returns Promise<Product | null>

search

Parameters

`Optional`orderBy?: { direction: "ASC" | "DESC"; field: "updatedAt" | "externalId" | "name" }[]

`Optional`page?: number

`Optional`pageSize?: number

`Optional`q?: string

Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: Product[]; total: number };
    },
>

update

Parameters

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

Settings

On This Page

Class ProductAdminService

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ProductAdminService

Properties

Protected Readonlydb

Methods

get

Parameters

Returns Promise<Product | null>

search

Parameters

OptionalorderBy?: { direction: "ASC" | "DESC"; field: "updatedAt" | "externalId" | "name" }[]

Optionalpage?: number

OptionalpageSize?: number

Optionalq?: string

Returns Promise< { ok: true; value: { hasNext: boolean; items: Product[]; total: number }; },>

update

Parameters

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

Settings

On This Page

`Protected` `Readonly`db

`Optional`orderBy?: { direction: "ASC" | "DESC"; field: "updatedAt" | "externalId" | "name" }[]

`Optional`page?: number

`Optional`pageSize?: number

`Optional`q?: string

Returns Promise<
{
ok: true;
value: { hasNext: boolean; items: Product[]; total: number };
},
>