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

    Class RewardService

    Manage rewards for entities

    Internally, this is using a ledger so each reward causes a double-entry.

    Hierarchy (View Summary)

    Index
    constructor
    db rewardAccountService instance
    create get getCustomerBalance getEntityBalance search searchIterator
    db: B2bDatabase
    rewardAccountService: RewardAccountService
    instance: (...args: []) => RewardService = ...

    The process default: built from each dependency's own instance().

    • Create a reward entry, credit or debit, on a recipient's reward account

      DEBITs are atomically validated against the account's current balance and rejected with INSUFFICIENT_BALANCE if they would drive it negative. Concurrent writes on one account are serialized via a postgres advisory lock held for the duration of the transaction.

      service.create({ recipient: { entityId }, ... });
      service.create({ recipient: { email }, ... }); // a pending signup promo

      Parameters

      • __namedParameters: Pick<
            Reward,
            "transactionType"
            | "amount"
            | "idempotencyKey"
            | "category"
            | "note",
        > & { customerId: string; recipient: RewardRecipient }

      Returns Promise<
          | { ok: true; value: Reward }
          | {
              error:
                  | RewardAccountError
                  | ServiceError<
                      | "IDEMPOTENCY_ERROR"
                      | "INVALID_AMOUNT"
                      | "REWARD_PROGRAM_NOT_FOUND"
                      | "RECIPIENT_NOT_REGISTERED",
                  >
                  | ServiceError<
                      "INSUFFICIENT_BALANCE",
                      {
                          balance: { amount: number; currency: "MOVEUSD" };
                          requested: { amount: number; currency: "MOVEUSD" };
                      },
                  >;
              ok: false;
          },
      >

    • Parameters

      • __namedParameters: {
            customerId: string;
            recipient: { entityId: string } | { email: string } | { phone: string };
        }

      Returns Promise<
          | { error: RewardAccountError; ok: false }
          | { ok: true; value: { amount: BigNumber; currency: "MOVEUSD" } },
      >

      Current balance of a recipient's reward account

    • Parameters

      • __namedParameters: {
            category?: string;
            createdAt?: DbTimestampCriteria;
            customerId: string;
            idempotencyKey?: string;
            ids?: string[];
            orderBy?: DbOrderByCriterion<
                Omit<
                    PgTableWithColumns<
                        {
                            columns: {
                                accountId: PgBuildColumn<
                                    "reward_ledger",
                                    SetNotNull<PgTextBuilder<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "reward_ledger";
                                    },
                                >;
                                accountType: PgBuildColumn<
                                    "reward_ledger",
                                    Set$Type<SetNotNull<(...)>, (...) | (...)>,
                                    {
                                        data: (...) | (...);
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "reward_ledger";
                                    },
                                >;
                                amount: PgBuildColumn<
                                    "reward_ledger",
                                    SetNotNull<PgNumericBuilder>,
                                    {
                                        data: string;
                                        dataType: "string numeric";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "reward_ledger";
                                    },
                                >;
                                category: PgBuildColumn<
                                    "reward_ledger",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "reward_ledger";
                                    },
                                >;
                                createdAt: PgBuildColumn<
                                    "reward_ledger",
                                    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: "reward_ledger";
                                    },
                                >;
                                currency: PgBuildColumn<
                                    "reward_ledger",
                                    Set$Type<SetNotNull<(...)>, "MOVEUSD">,
                                    {
                                        data: "MOVEUSD";
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "reward_ledger";
                                    },
                                >;
                                customerExternalId: PgBuildColumn<
                                    "reward_ledger",
                                    SetNotNull<PgTextBuilder<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "reward_ledger";
                                    },
                                >;
                                customerId: PgBuildColumn<
                                    "reward_ledger",
                                    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: "reward_ledger";
                                    },
                                >;
                                externalId: PgBuildColumn<
                                    "reward_ledger",
                                    SetNotNull<PgTextBuilder<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "reward_ledger";
                                    },
                                >;
                                id: PgBuildColumn<
                                    "reward_ledger",
                                    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: "reward_ledger";
                                    },
                                >;
                                idempotencyKey: PgBuildColumn<
                                    "reward_ledger",
                                    SetNotNull<PgTextBuilder<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "reward_ledger";
                                    },
                                >;
                                note: PgBuildColumn<
                                    "reward_ledger",
                                    PgTextBuilder<[(...), ...(...)[]]>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "reward_ledger";
                                    },
                                >;
                                promotedFromAccountId: PgBuildColumn<
                                    "reward_ledger",
                                    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: "reward_ledger";
                                    },
                                >;
                                rewardAccountId: PgBuildColumn<
                                    "reward_ledger",
                                    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: "reward_ledger";
                                    },
                                >;
                                transactionType: PgBuildColumn<
                                    "reward_ledger",
                                    Set$Type<SetNotNull<(...)>, (...) | (...)>,
                                    {
                                        data: (...) | (...);
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "reward_ledger";
                                    },
                                >;
                                updatedAt: PgBuildColumn<
                                    "reward_ledger",
                                    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: "reward_ledger";
                                    },
                                >;
                            };
                            dialect: "pg";
                            isAlias: false;
                            name: "reward_ledger";
                            schema: "b2b";
                        },
                    >,
                    "enableRLS",
                >,
                "createdAt"
                | "updatedAt"
                | "amount",
            >[];
            page?: number;
            pageSize?: number;
            recipient?: { entityId: string } | { email: string } | { phone: string };
            transactionType?: "DEBIT" | "CREDIT";
            updatedAt?: DbTimestampCriteria;
            withPhone?: boolean;
        }
        • Optionalcategory?: string
        • OptionalcreatedAt?: DbTimestampCriteria
        • customerId: string
        • OptionalidempotencyKey?: string
        • Optionalids?: string[]
        • OptionalorderBy?: DbOrderByCriterion<
              Omit<
                  PgTableWithColumns<
                      {
                          columns: {
                              accountId: PgBuildColumn<
                                  "reward_ledger",
                                  SetNotNull<PgTextBuilder<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "reward_ledger";
                                  },
                              >;
                              accountType: PgBuildColumn<
                                  "reward_ledger",
                                  Set$Type<SetNotNull<(...)>, (...) | (...)>,
                                  {
                                      data: (...) | (...);
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "reward_ledger";
                                  },
                              >;
                              amount: PgBuildColumn<
                                  "reward_ledger",
                                  SetNotNull<PgNumericBuilder>,
                                  {
                                      data: string;
                                      dataType: "string numeric";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "reward_ledger";
                                  },
                              >;
                              category: PgBuildColumn<
                                  "reward_ledger",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "reward_ledger";
                                  },
                              >;
                              createdAt: PgBuildColumn<
                                  "reward_ledger",
                                  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: "reward_ledger";
                                  },
                              >;
                              currency: PgBuildColumn<
                                  "reward_ledger",
                                  Set$Type<SetNotNull<(...)>, "MOVEUSD">,
                                  {
                                      data: "MOVEUSD";
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "reward_ledger";
                                  },
                              >;
                              customerExternalId: PgBuildColumn<
                                  "reward_ledger",
                                  SetNotNull<PgTextBuilder<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "reward_ledger";
                                  },
                              >;
                              customerId: PgBuildColumn<
                                  "reward_ledger",
                                  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: "reward_ledger";
                                  },
                              >;
                              externalId: PgBuildColumn<
                                  "reward_ledger",
                                  SetNotNull<PgTextBuilder<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "reward_ledger";
                                  },
                              >;
                              id: PgBuildColumn<
                                  "reward_ledger",
                                  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: "reward_ledger";
                                  },
                              >;
                              idempotencyKey: PgBuildColumn<
                                  "reward_ledger",
                                  SetNotNull<PgTextBuilder<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "reward_ledger";
                                  },
                              >;
                              note: PgBuildColumn<
                                  "reward_ledger",
                                  PgTextBuilder<[(...), ...(...)[]]>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "reward_ledger";
                                  },
                              >;
                              promotedFromAccountId: PgBuildColumn<
                                  "reward_ledger",
                                  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: "reward_ledger";
                                  },
                              >;
                              rewardAccountId: PgBuildColumn<
                                  "reward_ledger",
                                  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: "reward_ledger";
                                  },
                              >;
                              transactionType: PgBuildColumn<
                                  "reward_ledger",
                                  Set$Type<SetNotNull<(...)>, (...) | (...)>,
                                  {
                                      data: (...) | (...);
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "reward_ledger";
                                  },
                              >;
                              updatedAt: PgBuildColumn<
                                  "reward_ledger",
                                  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: "reward_ledger";
                                  },
                              >;
                          };
                          dialect: "pg";
                          isAlias: false;
                          name: "reward_ledger";
                          schema: "b2b";
                      },
                  >,
                  "enableRLS",
              >,
              "createdAt"
              | "updatedAt"
              | "amount",
          >[]
        • Optionalpage?: number

          Defaults to 1

        • OptionalpageSize?: number

          Defaults to 100

        • Optionalrecipient?: { entityId: string } | { email: string } | { phone: string }
        • OptionaltransactionType?: "DEBIT" | "CREDIT"
        • OptionalupdatedAt?: DbTimestampCriteria
        • OptionalwithPhone?: boolean

          Only rewards with a phone to publish, the only ones /v1 can express.

      Returns Promise<
          | { error: RewardAccountError; ok: false }
          | { ok: true; value: { hasNext: boolean; items: Reward[]; total: number } },
      >

      reward entries, all of them or one recipient's

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods