@cfxlabsinc/b2b-services
    Preparing search index...

    Manages blocking an entity from using a product

    This is scoped to the admin. Use ProductBlockService to act as a customer.

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    Methods

    • Parameters

      • __namedParameters: Pick<ProductBlock, "productName" | "entityId"> & { customerId: string }

      Returns Promise<
          Promise<
              | { status: "UNBLOCKED" }
              | {
                  note: string;
                  reason: "BLOCKED_BY_CUSTOMER" | "BLOCKED_BY_ADMIN";
                  status: "BLOCKED";
              },
          >,
      >

    • Parameters

      • __namedParameters: {
            customerIds?: string[];
            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.*"
            )[];
            statuses?: ("BLOCKED" | "UNBLOCKED")[];
            types?: ("ADMIN" | "CUSTOMER")[];
        }
        • OptionalcustomerIds?: string[]

          Omit to return blocks across all customers.

        • 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"
              | "deposit.*"
              | "withdraw.*"
          )[]
        • Optionalstatuses?: ("BLOCKED" | "UNBLOCKED")[]
        • Optionaltypes?: ("ADMIN" | "CUSTOMER")[]

      Returns Promise<
          (
              Omit<
                  {
                      createdAt: Date;
                      customerId: number;
                      id: number;
                      identityId: number
                      | null;
                      note: string;
                      organizationId: number | null;
                      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.*";
                      status: "BLOCKED"
                      | "UNBLOCKED";
                      type: "ADMIN" | "CUSTOMER";
                      updatedAt: Date;
                  },
                  "id"
                  | "organizationId"
                  | "customerId"
                  | "identityId",
              > & { entityId: string } & { customerId: string }
          )[],
      >