Class ProductFeeConfigAdminService

Configure fees applied to each product

This service is scoped to the admin (cross-customer). customer should use ProductLimitConfigService instead.

Index

Constructors

constructor

new ProductFeeConfigAdminService(
__namedParameters: { sqlClient: Sql },
): ProductFeeConfigAdminService
Parameters
- __namedParameters: { sqlClient: Sql }
Returns ProductFeeConfigAdminService
- Defined in product-services/src/ProductFeeConfigAdminService.ts:33

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`dbHelper

dbHelper: DbHelper

Methods

delete

delete(
    __namedParameters: Pick<ProductFeeConfig, "type" | "productName"> & {
        customerId: string | null;
    },
): Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>
Parameters
- __namedParameters: Pick<ProductFeeConfig, "type" | "productName"> & { customerId: string | null }
  - customerId: string | null
    null for global config (applies to all customers)
Returns Promise<{ ok: true; value: void } | { error: ServiceError; ok: false }>
- Defined in product-services/src/ProductFeeConfigAdminService.ts:109

search

search(
    __namedParameters: {
        customerIds?: (string | null)[];
        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"
        )[];
        statuses?: ("ACTIVE" | "DISABLED")[];
        types?: ("ADMIN" | "CUSTOMER")[];
    },
): Promise<
    {
        ok: true;
        value: (
            Omit<
                {
                    config: {
                        rules: {
                            matcher: object;
                            status: "ACTIVE"
                            | "DISABLED";
                            value: ((...) & (...))[];
                        }[];
                    };
                    createdAt: Date;
                    customerId: number
                    | null;
                    id: number;
                    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";
                    status: "ACTIVE"
                    | "DISABLED";
                    type: "ADMIN" | "CUSTOMER";
                    updatedAt: Date;
                },
                "id"
                | "customerId"
                | "config",
            > & {
                rules: (
                    Omit<
                        {
                            matcher: object;
                            status: "ACTIVE"
                            | "DISABLED";
                            value: ((...) & (...))[];
                        },
                        "value",
                    > & { value: ({ receiver: ... } & ((...) | (...)))[] }
                )[];
            } & { customerId: string
            | null }
        )[];
    },
>
Parameters
- __namedParameters: {
      customerIds?: (string | null)[];
      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"
      )[];
      statuses?: ("ACTIVE" | "DISABLED")[];
      types?: ("ADMIN" | "CUSTOMER")[];
  }
  - OptionalcustomerIds?: (string | null)[]
    null for global config (applies to all customers). Omit to return both all customers and all globals.
  - OptionalproductNames?: (
        | "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"
    )[]
  - Optionalstatuses?: ("ACTIVE" | "DISABLED")[]
  - Optionaltypes?: ("ADMIN" | "CUSTOMER")[]
Returns Promise<
    {
        ok: true;
        value: (
            Omit<
                {
                    config: {
                        rules: {
                            matcher: object;
                            status: "ACTIVE"
                            | "DISABLED";
                            value: ((...) & (...))[];
                        }[];
                    };
                    createdAt: Date;
                    customerId: number
                    | null;
                    id: number;
                    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";
                    status: "ACTIVE"
                    | "DISABLED";
                    type: "ADMIN" | "CUSTOMER";
                    updatedAt: Date;
                },
                "id"
                | "customerId"
                | "config",
            > & {
                rules: (
                    Omit<
                        {
                            matcher: object;
                            status: "ACTIVE"
                            | "DISABLED";
                            value: ((...) & (...))[];
                        },
                        "value",
                    > & { value: ({ receiver: ... } & ((...) | (...)))[] }
                )[];
            } & { customerId: string
            | null }
        )[];
    },
>
- Defined in product-services/src/ProductFeeConfigAdminService.ts:144

upsert

upsert(
    __namedParameters: { customerId: string | null } & Omit<
        ProductFeeConfig,
        "type"
        | "createdAt"
        | "updatedAt",
    >,
): Promise<{ ok: true; value: ProductFeeConfig }>
Create or update admin rules for product limits
Parameters
- __namedParameters: { customerId: string | null } & Omit<
      ProductFeeConfig,
      "type"
      | "createdAt"
      | "updatedAt",
  >
  - customerId: string | null
    For global (applies to all customers), set to null
Returns Promise<{ ok: true; value: ProductFeeConfig }>
- Defined in product-services/src/ProductFeeConfigAdminService.ts:39

Class ProductFeeConfigAdminService

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ProductFeeConfigAdminService

Properties

`Protected` `Readonly`db

`Protected` `Readonly`dbHelper

Methods

delete

Parameters

customerId: string | null

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

search

Parameters

`Optional`customerIds?: (string | null)[]

`Optional`statuses?: ("ACTIVE" | "DISABLED")[]

`Optional`types?: ("ADMIN" | "CUSTOMER")[]

upsert

Parameters

customerId: string | null

Returns Promise<{ ok: true; value: ProductFeeConfig }>

Settings

On This Page

Class ProductFeeConfigAdminService

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ProductFeeConfigAdminService

Properties

Protected Readonlydb

Protected ReadonlydbHelper

Methods

delete

Parameters

customerId: string | null

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

search

Parameters

OptionalcustomerIds?: (string | null)[]

Optionalstatuses?: ("ACTIVE" | "DISABLED")[]

Optionaltypes?: ("ADMIN" | "CUSTOMER")[]

upsert

Parameters

customerId: string | null

Returns Promise<{ ok: true; value: ProductFeeConfig }>

Settings

On This Page

`Protected` `Readonly`db

`Protected` `Readonly`dbHelper

`Optional`customerIds?: (string | null)[]

`Optional`statuses?: ("ACTIVE" | "DISABLED")[]

`Optional`types?: ("ADMIN" | "CUSTOMER")[]