@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
    create get getAccountId getCustomerBalance getEntityBalance search searchIterator

    • Parameters

      • __namedParameters: {
            db: B2bDatabase;
            entityService: EntityService;
            eventPublisher: CustomerEventPublisher;
            transactionCacheBuster: TransactionCacheBuster;
        }

      Returns RewardService

    db: B2bDatabase

    • Create a reward entry for an entity, credit or debit

      DEBITs are atomically validated against the entity's current balance and rejected with INSUFFICIENT_BALANCE if they would drive it negative. Concurrent writes on the same (customer, entity) pair are serialized via a postgres advisory lock held for the duration of the transaction.

      Usage:

      service.create({ phone, ... });
      service.create({ entityId, ... });

      Parameters

      • __namedParameters: PhoneOrEntityId<Omit<Reward, "id" | "createdAt">> & { customerId: string }

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

    • Parameters

      • __namedParameters: PhoneOrEntityId<Pick<Reward, "phone">> & { customerId: string }

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

      Current balance for the entity

    • Parameters

      • __namedParameters: Partial<PhoneOrEntityId<Pick<Reward, "phone">>> & {
            category?: string;
            createdAt?: DbTimestampCriteria;
            customerId: string;
            idempotencyKey?: string;
            ids?: string[];
            orderBy?: DbOrderByCriterion<
                Omit<
                    PgTableWithColumns<
                        {
                            columns: {
                                accountId: PgBuildColumn<
                                    "reward_ledger",
                                    SetNotNull<(...)>,
                                    {
                                        data: ...;
                                        dataType: ...;
                                        driverParam: ...;
                                        enumValues: ...;
                                        generated: ...;
                                        hasDefault: ...;
                                        hasRuntimeDefault: ...;
                                        identity: ...;
                                        isAutoincrement: ...;
                                        isPrimaryKey: ...;
                                        name: ...;
                                        notNull: ...;
                                        tableName: ...;
                                    },
                                >;
                                accountType: PgBuildColumn<
                                    "reward_ledger",
                                    Set$Type<(...), (...)>,
                                    {
                                        data: ...;
                                        dataType: ...;
                                        driverParam: ...;
                                        enumValues: ...;
                                        generated: ...;
                                        hasDefault: ...;
                                        hasRuntimeDefault: ...;
                                        identity: ...;
                                        isAutoincrement: ...;
                                        isPrimaryKey: ...;
                                        name: ...;
                                        notNull: ...;
                                        tableName: ...;
                                    },
                                >;
                                amount: PgBuildColumn<
                                    "reward_ledger",
                                    SetNotNull<(...)>,
                                    {
                                        data: ...;
                                        dataType: ...;
                                        driverParam: ...;
                                        enumValues: ...;
                                        generated: ...;
                                        hasDefault: ...;
                                        hasRuntimeDefault: ...;
                                        identity: ...;
                                        isAutoincrement: ...;
                                        isPrimaryKey: ...;
                                        name: ...;
                                        notNull: ...;
                                        tableName: ...;
                                    },
                                >;
                                category: PgBuildColumn<
                                    "reward_ledger",
                                    PgTextBuilder<(...)>,
                                    {
                                        data: ...;
                                        dataType: ...;
                                        driverParam: ...;
                                        enumValues: ...;
                                        generated: ...;
                                        hasDefault: ...;
                                        hasRuntimeDefault: ...;
                                        identity: ...;
                                        isAutoincrement: ...;
                                        isPrimaryKey: ...;
                                        name: ...;
                                        notNull: ...;
                                        tableName: ...;
                                    },
                                >;
                                createdAt: PgBuildColumn<
                                    "reward_ledger",
                                    SetHasDefault<(...)>,
                                    {
                                        data: ...;
                                        dataType: ...;
                                        driverParam: ...;
                                        enumValues: ...;
                                        generated: ...;
                                        hasDefault: ...;
                                        hasRuntimeDefault: ...;
                                        identity: ...;
                                        isAutoincrement: ...;
                                        isPrimaryKey: ...;
                                        name: ...;
                                        notNull: ...;
                                        tableName: ...;
                                    },
                                >;
                                currency: PgBuildColumn<
                                    "reward_ledger",
                                    Set$Type<(...), (...)>,
                                    {
                                        data: ...;
                                        dataType: ...;
                                        driverParam: ...;
                                        enumValues: ...;
                                        generated: ...;
                                        hasDefault: ...;
                                        hasRuntimeDefault: ...;
                                        identity: ...;
                                        isAutoincrement: ...;
                                        isPrimaryKey: ...;
                                        name: ...;
                                        notNull: ...;
                                        tableName: ...;
                                    },
                                >;
                                customerId: PgBuildColumn<
                                    "reward_ledger",
                                    SetNotNull<(...)>,
                                    {
                                        data: ...;
                                        dataType: ...;
                                        driverParam: ...;
                                        enumValues: ...;
                                        generated: ...;
                                        hasDefault: ...;
                                        hasRuntimeDefault: ...;
                                        identity: ...;
                                        isAutoincrement: ...;
                                        isPrimaryKey: ...;
                                        name: ...;
                                        notNull: ...;
                                        tableName: ...;
                                    },
                                >;
                                externalId: PgBuildColumn<
                                    "reward_ledger",
                                    SetNotNull<(...)>,
                                    {
                                        data: ...;
                                        dataType: ...;
                                        driverParam: ...;
                                        enumValues: ...;
                                        generated: ...;
                                        hasDefault: ...;
                                        hasRuntimeDefault: ...;
                                        identity: ...;
                                        isAutoincrement: ...;
                                        isPrimaryKey: ...;
                                        name: ...;
                                        notNull: ...;
                                        tableName: ...;
                                    },
                                >;
                                id: PgBuildColumn<
                                    "reward_ledger",
                                    HasIdentity<(...), (...)>,
                                    {
                                        data: ...;
                                        dataType: ...;
                                        driverParam: ...;
                                        enumValues: ...;
                                        generated: ...;
                                        hasDefault: ...;
                                        hasRuntimeDefault: ...;
                                        identity: ...;
                                        isAutoincrement: ...;
                                        isPrimaryKey: ...;
                                        name: ...;
                                        notNull: ...;
                                        tableName: ...;
                                    },
                                >;
                                idempotencyKey: PgBuildColumn<
                                    "reward_ledger",
                                    SetNotNull<(...)>,
                                    {
                                        data: ...;
                                        dataType: ...;
                                        driverParam: ...;
                                        enumValues: ...;
                                        generated: ...;
                                        hasDefault: ...;
                                        hasRuntimeDefault: ...;
                                        identity: ...;
                                        isAutoincrement: ...;
                                        isPrimaryKey: ...;
                                        name: ...;
                                        notNull: ...;
                                        tableName: ...;
                                    },
                                >;
                                note: PgBuildColumn<
                                    "reward_ledger",
                                    PgTextBuilder<(...)>,
                                    {
                                        data: ...;
                                        dataType: ...;
                                        driverParam: ...;
                                        enumValues: ...;
                                        generated: ...;
                                        hasDefault: ...;
                                        hasRuntimeDefault: ...;
                                        identity: ...;
                                        isAutoincrement: ...;
                                        isPrimaryKey: ...;
                                        name: ...;
                                        notNull: ...;
                                        tableName: ...;
                                    },
                                >;
                                transactionType: PgBuildColumn<
                                    "reward_ledger",
                                    Set$Type<(...), (...)>,
                                    {
                                        data: ...;
                                        dataType: ...;
                                        driverParam: ...;
                                        enumValues: ...;
                                        generated: ...;
                                        hasDefault: ...;
                                        hasRuntimeDefault: ...;
                                        identity: ...;
                                        isAutoincrement: ...;
                                        isPrimaryKey: ...;
                                        name: ...;
                                        notNull: ...;
                                        tableName: ...;
                                    },
                                >;
                                updatedAt: PgBuildColumn<
                                    "reward_ledger",
                                    SetHasDefault<(...)>,
                                    {
                                        data: ...;
                                        dataType: ...;
                                        driverParam: ...;
                                        enumValues: ...;
                                        generated: ...;
                                        hasDefault: ...;
                                        hasRuntimeDefault: ...;
                                        identity: ...;
                                        isAutoincrement: ...;
                                        isPrimaryKey: ...;
                                        name: ...;
                                        notNull: ...;
                                        tableName: ...;
                                    },
                                >;
                            };
                            dialect: "pg";
                            name: "reward_ledger";
                            schema: "b2b";
                        },
                    >,
                    "enableRLS",
                >,
                "createdAt"
                | "updatedAt"
                | "amount",
            >[];
            page?: number;
            pageSize?: number;
            transactionType?: "DEBIT" | "CREDIT";
            updatedAt?: DbTimestampCriteria;
        }
        • Optionalcategory?: string
        • OptionalcreatedAt?: DbTimestampCriteria
        • customerId: string
        • OptionalidempotencyKey?: string
        • Optionalids?: string[]
        • OptionalorderBy?: DbOrderByCriterion<
              Omit<
                  PgTableWithColumns<
                      {
                          columns: {
                              accountId: PgBuildColumn<
                                  "reward_ledger",
                                  SetNotNull<(...)>,
                                  {
                                      data: ...;
                                      dataType: ...;
                                      driverParam: ...;
                                      enumValues: ...;
                                      generated: ...;
                                      hasDefault: ...;
                                      hasRuntimeDefault: ...;
                                      identity: ...;
                                      isAutoincrement: ...;
                                      isPrimaryKey: ...;
                                      name: ...;
                                      notNull: ...;
                                      tableName: ...;
                                  },
                              >;
                              accountType: PgBuildColumn<
                                  "reward_ledger",
                                  Set$Type<(...), (...)>,
                                  {
                                      data: ...;
                                      dataType: ...;
                                      driverParam: ...;
                                      enumValues: ...;
                                      generated: ...;
                                      hasDefault: ...;
                                      hasRuntimeDefault: ...;
                                      identity: ...;
                                      isAutoincrement: ...;
                                      isPrimaryKey: ...;
                                      name: ...;
                                      notNull: ...;
                                      tableName: ...;
                                  },
                              >;
                              amount: PgBuildColumn<
                                  "reward_ledger",
                                  SetNotNull<(...)>,
                                  {
                                      data: ...;
                                      dataType: ...;
                                      driverParam: ...;
                                      enumValues: ...;
                                      generated: ...;
                                      hasDefault: ...;
                                      hasRuntimeDefault: ...;
                                      identity: ...;
                                      isAutoincrement: ...;
                                      isPrimaryKey: ...;
                                      name: ...;
                                      notNull: ...;
                                      tableName: ...;
                                  },
                              >;
                              category: PgBuildColumn<
                                  "reward_ledger",
                                  PgTextBuilder<(...)>,
                                  {
                                      data: ...;
                                      dataType: ...;
                                      driverParam: ...;
                                      enumValues: ...;
                                      generated: ...;
                                      hasDefault: ...;
                                      hasRuntimeDefault: ...;
                                      identity: ...;
                                      isAutoincrement: ...;
                                      isPrimaryKey: ...;
                                      name: ...;
                                      notNull: ...;
                                      tableName: ...;
                                  },
                              >;
                              createdAt: PgBuildColumn<
                                  "reward_ledger",
                                  SetHasDefault<(...)>,
                                  {
                                      data: ...;
                                      dataType: ...;
                                      driverParam: ...;
                                      enumValues: ...;
                                      generated: ...;
                                      hasDefault: ...;
                                      hasRuntimeDefault: ...;
                                      identity: ...;
                                      isAutoincrement: ...;
                                      isPrimaryKey: ...;
                                      name: ...;
                                      notNull: ...;
                                      tableName: ...;
                                  },
                              >;
                              currency: PgBuildColumn<
                                  "reward_ledger",
                                  Set$Type<(...), (...)>,
                                  {
                                      data: ...;
                                      dataType: ...;
                                      driverParam: ...;
                                      enumValues: ...;
                                      generated: ...;
                                      hasDefault: ...;
                                      hasRuntimeDefault: ...;
                                      identity: ...;
                                      isAutoincrement: ...;
                                      isPrimaryKey: ...;
                                      name: ...;
                                      notNull: ...;
                                      tableName: ...;
                                  },
                              >;
                              customerId: PgBuildColumn<
                                  "reward_ledger",
                                  SetNotNull<(...)>,
                                  {
                                      data: ...;
                                      dataType: ...;
                                      driverParam: ...;
                                      enumValues: ...;
                                      generated: ...;
                                      hasDefault: ...;
                                      hasRuntimeDefault: ...;
                                      identity: ...;
                                      isAutoincrement: ...;
                                      isPrimaryKey: ...;
                                      name: ...;
                                      notNull: ...;
                                      tableName: ...;
                                  },
                              >;
                              externalId: PgBuildColumn<
                                  "reward_ledger",
                                  SetNotNull<(...)>,
                                  {
                                      data: ...;
                                      dataType: ...;
                                      driverParam: ...;
                                      enumValues: ...;
                                      generated: ...;
                                      hasDefault: ...;
                                      hasRuntimeDefault: ...;
                                      identity: ...;
                                      isAutoincrement: ...;
                                      isPrimaryKey: ...;
                                      name: ...;
                                      notNull: ...;
                                      tableName: ...;
                                  },
                              >;
                              id: PgBuildColumn<
                                  "reward_ledger",
                                  HasIdentity<(...), (...)>,
                                  {
                                      data: ...;
                                      dataType: ...;
                                      driverParam: ...;
                                      enumValues: ...;
                                      generated: ...;
                                      hasDefault: ...;
                                      hasRuntimeDefault: ...;
                                      identity: ...;
                                      isAutoincrement: ...;
                                      isPrimaryKey: ...;
                                      name: ...;
                                      notNull: ...;
                                      tableName: ...;
                                  },
                              >;
                              idempotencyKey: PgBuildColumn<
                                  "reward_ledger",
                                  SetNotNull<(...)>,
                                  {
                                      data: ...;
                                      dataType: ...;
                                      driverParam: ...;
                                      enumValues: ...;
                                      generated: ...;
                                      hasDefault: ...;
                                      hasRuntimeDefault: ...;
                                      identity: ...;
                                      isAutoincrement: ...;
                                      isPrimaryKey: ...;
                                      name: ...;
                                      notNull: ...;
                                      tableName: ...;
                                  },
                              >;
                              note: PgBuildColumn<
                                  "reward_ledger",
                                  PgTextBuilder<(...)>,
                                  {
                                      data: ...;
                                      dataType: ...;
                                      driverParam: ...;
                                      enumValues: ...;
                                      generated: ...;
                                      hasDefault: ...;
                                      hasRuntimeDefault: ...;
                                      identity: ...;
                                      isAutoincrement: ...;
                                      isPrimaryKey: ...;
                                      name: ...;
                                      notNull: ...;
                                      tableName: ...;
                                  },
                              >;
                              transactionType: PgBuildColumn<
                                  "reward_ledger",
                                  Set$Type<(...), (...)>,
                                  {
                                      data: ...;
                                      dataType: ...;
                                      driverParam: ...;
                                      enumValues: ...;
                                      generated: ...;
                                      hasDefault: ...;
                                      hasRuntimeDefault: ...;
                                      identity: ...;
                                      isAutoincrement: ...;
                                      isPrimaryKey: ...;
                                      name: ...;
                                      notNull: ...;
                                      tableName: ...;
                                  },
                              >;
                              updatedAt: PgBuildColumn<
                                  "reward_ledger",
                                  SetHasDefault<(...)>,
                                  {
                                      data: ...;
                                      dataType: ...;
                                      driverParam: ...;
                                      enumValues: ...;
                                      generated: ...;
                                      hasDefault: ...;
                                      hasRuntimeDefault: ...;
                                      identity: ...;
                                      isAutoincrement: ...;
                                      isPrimaryKey: ...;
                                      name: ...;
                                      notNull: ...;
                                      tableName: ...;
                                  },
                              >;
                          };
                          dialect: "pg";
                          name: "reward_ledger";
                          schema: "b2b";
                      },
                  >,
                  "enableRLS",
              >,
              "createdAt"
              | "updatedAt"
              | "amount",
          >[]
        • Optionalpage?: number

          Defaults to 1

        • OptionalpageSize?: number

          Defaults to 100

        • OptionaltransactionType?: "DEBIT" | "CREDIT"
        • OptionalupdatedAt?: DbTimestampCriteria

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

      entity reward entries

      invalidPhone, notSupported and whatever EntityService throws

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods