Class RewardService

Manage rewards for entities

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

Hierarchy (View Summary)

RewardQueryService
- RewardService

Index

Constructors

constructor

Properties

Methods

create get getAccountId getCustomerBalance getEntityBalance search searchIterator

Constructors

constructor

new RewardService(
    __namedParameters: {
        db: B2bDatabase;
        entityService: EntityService;
        eventPublisher: EventPublisher;
    },
): RewardService
Parameters
- __namedParameters: {
      db: B2bDatabase;
      entityService: EntityService;
      eventPublisher: EventPublisher;
  }
Returns RewardService
Overrides RewardQueryService.constructor
- Defined in packages/reward-services/src/RewardService.ts:368

Properties

`Protected` `Readonly`db

db: B2bDatabase

Methods

create

create(
    __namedParameters: PhoneOrEntityId<Omit<Reward, "id" | "createdAt">> & {
        customerId: string;
    },
): Promise<
    | { ok: true; value: Reward }
    | {
        error:
            | ServiceError<
                | "INVALID_PHONE"
                | "INVALID_ENTITY_TYPE"
                | "ENTITY_NOT_FOUND"
                | "IDEMPOTENCY_ERROR"
                | "INVALID_AMOUNT",
            >
            | ServiceError<
                "INSUFFICIENT_BALANCE",
                {
                    balance: { amount: number; currency: "MOVEUSD" };
                    requested: { amount: number; currency: "MOVEUSD" };
                },
            >;
        ok: false;
    },
>
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",
            >
            | ServiceError<
                "INSUFFICIENT_BALANCE",
                {
                    balance: { amount: number; currency: "MOVEUSD" };
                    requested: { amount: number; currency: "MOVEUSD" };
                },
            >;
        ok: false;
    },
>
- Defined in packages/reward-services/src/RewardService.ts:398

get

get(
__namedParameters: { customerId: string; id: string },
): Promise<{ ok: true; value: Reward | null }>
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<{ ok: true; value: Reward | null }>
entity reward entry
Inherited from RewardQueryService.get
- Defined in packages/reward-services/src/RewardService.ts:39

`Protected`getAccountId

getAccountId(
    __namedParameters: PhoneOrEntityId<Pick<Reward, "phone">> & {
        customerId: string;
    },
): Promise<{ error: ServiceError; ok: false } | { ok: true; value: string }>
Parameters
- __namedParameters: PhoneOrEntityId<Pick<Reward, "phone">> & { customerId: string }
Returns Promise<{ error: ServiceError; ok: false } | { ok: true; value: string }>
Account ID for an identity, which is really their phone number
Inherited from RewardQueryService.getAccountId
- Defined in packages/reward-services/src/RewardService.ts:256

getCustomerBalance

getCustomerBalance(
__namedParameters: { customerId: string },
): Promise<{ amount: BigNumber; currency: "MOVEUSD" }>
Parameters
- __namedParameters: { customerId: string }
Returns Promise<{ amount: BigNumber; currency: "MOVEUSD" }>
Current balance for the customer
Inherited from RewardQueryService.getCustomerBalance
- Defined in packages/reward-services/src/RewardService.ts:240

getEntityBalance

getEntityBalance(
    __namedParameters: PhoneOrEntityId<Pick<Reward, "phone">> & {
        customerId: string;
    },
): Promise<
    | { error: ServiceError; ok: false }
    | { ok: true; value: { amount: BigNumber; currency: "MOVEUSD" } },
>
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
Inherited from RewardQueryService.getEntityBalance
- Defined in packages/reward-services/src/RewardService.ts:211

search

search(
    __namedParameters: Partial<PhoneOrEntityId<Pick<Reward, "phone">>> & {
        category?: string;
        createdAt?: DbTimestampCriteria;
        customerId: string;
        idempotencyKey?: string;
        orderBy?: DbOrderByCriterion<
            Omit<
                PgTableWithColumns<
                    {
                        columns: {
                            accountId: PgColumn<
                                {
                                    baseColumn: ...;
                                    columnType: ...;
                                    data: ...;
                                    dataType: ...;
                                    driverParam: ...;
                                    enumValues: ...;
                                    generated: ...;
                                    hasDefault: ...;
                                    hasRuntimeDefault: ...;
                                    identity: ...;
                                    isAutoincrement: ...;
                                    isPrimaryKey: ...;
                                    name: ...;
                                    notNull: ...;
                                    tableName: ...;
                                },
                                {},
                                {},
                            >;
                            accountType: PgColumn<
                                {
                                    baseColumn: ...;
                                    columnType: ...;
                                    data: ...;
                                    dataType: ...;
                                    driverParam: ...;
                                    enumValues: ...;
                                    generated: ...;
                                    hasDefault: ...;
                                    hasRuntimeDefault: ...;
                                    identity: ...;
                                    isAutoincrement: ...;
                                    isPrimaryKey: ...;
                                    name: ...;
                                    notNull: ...;
                                    tableName: ...;
                                },
                                {},
                                {},
                            >;
                            amount: PgColumn<
                                {
                                    baseColumn: ...;
                                    columnType: ...;
                                    data: ...;
                                    dataType: ...;
                                    driverParam: ...;
                                    enumValues: ...;
                                    generated: ...;
                                    hasDefault: ...;
                                    hasRuntimeDefault: ...;
                                    identity: ...;
                                    isAutoincrement: ...;
                                    isPrimaryKey: ...;
                                    name: ...;
                                    notNull: ...;
                                    tableName: ...;
                                },
                                {},
                                {},
                            >;
                            category: PgColumn<
                                {
                                    baseColumn: ...;
                                    columnType: ...;
                                    data: ...;
                                    dataType: ...;
                                    driverParam: ...;
                                    enumValues: ...;
                                    generated: ...;
                                    hasDefault: ...;
                                    hasRuntimeDefault: ...;
                                    identity: ...;
                                    isAutoincrement: ...;
                                    isPrimaryKey: ...;
                                    name: ...;
                                    notNull: ...;
                                    tableName: ...;
                                },
                                {},
                                {},
                            >;
                            createdAt: PgColumn<
                                {
                                    baseColumn: ...;
                                    columnType: ...;
                                    data: ...;
                                    dataType: ...;
                                    driverParam: ...;
                                    enumValues: ...;
                                    generated: ...;
                                    hasDefault: ...;
                                    hasRuntimeDefault: ...;
                                    identity: ...;
                                    isAutoincrement: ...;
                                    isPrimaryKey: ...;
                                    name: ...;
                                    notNull: ...;
                                    tableName: ...;
                                },
                                {},
                                {},
                            >;
                            currency: PgColumn<
                                {
                                    baseColumn: ...;
                                    columnType: ...;
                                    data: ...;
                                    dataType: ...;
                                    driverParam: ...;
                                    enumValues: ...;
                                    generated: ...;
                                    hasDefault: ...;
                                    hasRuntimeDefault: ...;
                                    identity: ...;
                                    isAutoincrement: ...;
                                    isPrimaryKey: ...;
                                    name: ...;
                                    notNull: ...;
                                    tableName: ...;
                                },
                                {},
                                { $type: ... },
                            >;
                            customerId: PgColumn<
                                {
                                    baseColumn: ...;
                                    columnType: ...;
                                    data: ...;
                                    dataType: ...;
                                    driverParam: ...;
                                    enumValues: ...;
                                    generated: ...;
                                    hasDefault: ...;
                                    hasRuntimeDefault: ...;
                                    identity: ...;
                                    isAutoincrement: ...;
                                    isPrimaryKey: ...;
                                    name: ...;
                                    notNull: ...;
                                    tableName: ...;
                                },
                                {},
                                {},
                            >;
                            externalId: PgColumn<
                                {
                                    baseColumn: ...;
                                    columnType: ...;
                                    data: ...;
                                    dataType: ...;
                                    driverParam: ...;
                                    enumValues: ...;
                                    generated: ...;
                                    hasDefault: ...;
                                    hasRuntimeDefault: ...;
                                    identity: ...;
                                    isAutoincrement: ...;
                                    isPrimaryKey: ...;
                                    name: ...;
                                    notNull: ...;
                                    tableName: ...;
                                },
                                {},
                                {},
                            >;
                            id: PgColumn<
                                {
                                    baseColumn: ...;
                                    columnType: ...;
                                    data: ...;
                                    dataType: ...;
                                    driverParam: ...;
                                    enumValues: ...;
                                    generated: ...;
                                    hasDefault: ...;
                                    hasRuntimeDefault: ...;
                                    identity: ...;
                                    isAutoincrement: ...;
                                    isPrimaryKey: ...;
                                    name: ...;
                                    notNull: ...;
                                    tableName: ...;
                                },
                                {},
                                {},
                            >;
                            idempotencyKey: PgColumn<
                                {
                                    baseColumn: ...;
                                    columnType: ...;
                                    data: ...;
                                    dataType: ...;
                                    driverParam: ...;
                                    enumValues: ...;
                                    generated: ...;
                                    hasDefault: ...;
                                    hasRuntimeDefault: ...;
                                    identity: ...;
                                    isAutoincrement: ...;
                                    isPrimaryKey: ...;
                                    name: ...;
                                    notNull: ...;
                                    tableName: ...;
                                },
                                {},
                                {},
                            >;
                            note: PgColumn<
                                {
                                    baseColumn: ...;
                                    columnType: ...;
                                    data: ...;
                                    dataType: ...;
                                    driverParam: ...;
                                    enumValues: ...;
                                    generated: ...;
                                    hasDefault: ...;
                                    hasRuntimeDefault: ...;
                                    identity: ...;
                                    isAutoincrement: ...;
                                    isPrimaryKey: ...;
                                    name: ...;
                                    notNull: ...;
                                    tableName: ...;
                                },
                                {},
                                {},
                            >;
                            transactionType: PgColumn<
                                {
                                    baseColumn: ...;
                                    columnType: ...;
                                    data: ...;
                                    dataType: ...;
                                    driverParam: ...;
                                    enumValues: ...;
                                    generated: ...;
                                    hasDefault: ...;
                                    hasRuntimeDefault: ...;
                                    identity: ...;
                                    isAutoincrement: ...;
                                    isPrimaryKey: ...;
                                    name: ...;
                                    notNull: ...;
                                    tableName: ...;
                                },
                                {},
                                { $type: ... },
                            >;
                            updatedAt: PgColumn<
                                {
                                    baseColumn: ...;
                                    columnType: ...;
                                    data: ...;
                                    dataType: ...;
                                    driverParam: ...;
                                    enumValues: ...;
                                    generated: ...;
                                    hasDefault: ...;
                                    hasRuntimeDefault: ...;
                                    identity: ...;
                                    isAutoincrement: ...;
                                    isPrimaryKey: ...;
                                    name: ...;
                                    notNull: ...;
                                    tableName: ...;
                                },
                                {},
                                {},
                            >;
                        };
                        dialect: "pg";
                        name: "reward_ledger";
                        schema: "b2b";
                    },
                >,
                "enableRLS",
            >,
            "createdAt"
            | "updatedAt",
        >[];
        page?: number;
        pageSize?: number;
        transactionType?: "CREDIT" | "DEBIT";
        updatedAt?: DbTimestampCriteria;
    },
): Promise<
    | { ok: true; value: { hasNext: boolean; items: Reward[] } }
    | { error: ServiceError; ok: false },
>
Parameters
- __namedParameters: Partial<PhoneOrEntityId<Pick<Reward, "phone">>> & {
      category?: string;
      createdAt?: DbTimestampCriteria;
      customerId: string;
      idempotencyKey?: string;
      orderBy?: DbOrderByCriterion<
          Omit<
              PgTableWithColumns<
                  {
                      columns: {
                          accountId: PgColumn<
                              {
                                  baseColumn: ...;
                                  columnType: ...;
                                  data: ...;
                                  dataType: ...;
                                  driverParam: ...;
                                  enumValues: ...;
                                  generated: ...;
                                  hasDefault: ...;
                                  hasRuntimeDefault: ...;
                                  identity: ...;
                                  isAutoincrement: ...;
                                  isPrimaryKey: ...;
                                  name: ...;
                                  notNull: ...;
                                  tableName: ...;
                              },
                              {},
                              {},
                          >;
                          accountType: PgColumn<
                              {
                                  baseColumn: ...;
                                  columnType: ...;
                                  data: ...;
                                  dataType: ...;
                                  driverParam: ...;
                                  enumValues: ...;
                                  generated: ...;
                                  hasDefault: ...;
                                  hasRuntimeDefault: ...;
                                  identity: ...;
                                  isAutoincrement: ...;
                                  isPrimaryKey: ...;
                                  name: ...;
                                  notNull: ...;
                                  tableName: ...;
                              },
                              {},
                              {},
                          >;
                          amount: PgColumn<
                              {
                                  baseColumn: ...;
                                  columnType: ...;
                                  data: ...;
                                  dataType: ...;
                                  driverParam: ...;
                                  enumValues: ...;
                                  generated: ...;
                                  hasDefault: ...;
                                  hasRuntimeDefault: ...;
                                  identity: ...;
                                  isAutoincrement: ...;
                                  isPrimaryKey: ...;
                                  name: ...;
                                  notNull: ...;
                                  tableName: ...;
                              },
                              {},
                              {},
                          >;
                          category: PgColumn<
                              {
                                  baseColumn: ...;
                                  columnType: ...;
                                  data: ...;
                                  dataType: ...;
                                  driverParam: ...;
                                  enumValues: ...;
                                  generated: ...;
                                  hasDefault: ...;
                                  hasRuntimeDefault: ...;
                                  identity: ...;
                                  isAutoincrement: ...;
                                  isPrimaryKey: ...;
                                  name: ...;
                                  notNull: ...;
                                  tableName: ...;
                              },
                              {},
                              {},
                          >;
                          createdAt: PgColumn<
                              {
                                  baseColumn: ...;
                                  columnType: ...;
                                  data: ...;
                                  dataType: ...;
                                  driverParam: ...;
                                  enumValues: ...;
                                  generated: ...;
                                  hasDefault: ...;
                                  hasRuntimeDefault: ...;
                                  identity: ...;
                                  isAutoincrement: ...;
                                  isPrimaryKey: ...;
                                  name: ...;
                                  notNull: ...;
                                  tableName: ...;
                              },
                              {},
                              {},
                          >;
                          currency: PgColumn<
                              {
                                  baseColumn: ...;
                                  columnType: ...;
                                  data: ...;
                                  dataType: ...;
                                  driverParam: ...;
                                  enumValues: ...;
                                  generated: ...;
                                  hasDefault: ...;
                                  hasRuntimeDefault: ...;
                                  identity: ...;
                                  isAutoincrement: ...;
                                  isPrimaryKey: ...;
                                  name: ...;
                                  notNull: ...;
                                  tableName: ...;
                              },
                              {},
                              { $type: ... },
                          >;
                          customerId: PgColumn<
                              {
                                  baseColumn: ...;
                                  columnType: ...;
                                  data: ...;
                                  dataType: ...;
                                  driverParam: ...;
                                  enumValues: ...;
                                  generated: ...;
                                  hasDefault: ...;
                                  hasRuntimeDefault: ...;
                                  identity: ...;
                                  isAutoincrement: ...;
                                  isPrimaryKey: ...;
                                  name: ...;
                                  notNull: ...;
                                  tableName: ...;
                              },
                              {},
                              {},
                          >;
                          externalId: PgColumn<
                              {
                                  baseColumn: ...;
                                  columnType: ...;
                                  data: ...;
                                  dataType: ...;
                                  driverParam: ...;
                                  enumValues: ...;
                                  generated: ...;
                                  hasDefault: ...;
                                  hasRuntimeDefault: ...;
                                  identity: ...;
                                  isAutoincrement: ...;
                                  isPrimaryKey: ...;
                                  name: ...;
                                  notNull: ...;
                                  tableName: ...;
                              },
                              {},
                              {},
                          >;
                          id: PgColumn<
                              {
                                  baseColumn: ...;
                                  columnType: ...;
                                  data: ...;
                                  dataType: ...;
                                  driverParam: ...;
                                  enumValues: ...;
                                  generated: ...;
                                  hasDefault: ...;
                                  hasRuntimeDefault: ...;
                                  identity: ...;
                                  isAutoincrement: ...;
                                  isPrimaryKey: ...;
                                  name: ...;
                                  notNull: ...;
                                  tableName: ...;
                              },
                              {},
                              {},
                          >;
                          idempotencyKey: PgColumn<
                              {
                                  baseColumn: ...;
                                  columnType: ...;
                                  data: ...;
                                  dataType: ...;
                                  driverParam: ...;
                                  enumValues: ...;
                                  generated: ...;
                                  hasDefault: ...;
                                  hasRuntimeDefault: ...;
                                  identity: ...;
                                  isAutoincrement: ...;
                                  isPrimaryKey: ...;
                                  name: ...;
                                  notNull: ...;
                                  tableName: ...;
                              },
                              {},
                              {},
                          >;
                          note: PgColumn<
                              {
                                  baseColumn: ...;
                                  columnType: ...;
                                  data: ...;
                                  dataType: ...;
                                  driverParam: ...;
                                  enumValues: ...;
                                  generated: ...;
                                  hasDefault: ...;
                                  hasRuntimeDefault: ...;
                                  identity: ...;
                                  isAutoincrement: ...;
                                  isPrimaryKey: ...;
                                  name: ...;
                                  notNull: ...;
                                  tableName: ...;
                              },
                              {},
                              {},
                          >;
                          transactionType: PgColumn<
                              {
                                  baseColumn: ...;
                                  columnType: ...;
                                  data: ...;
                                  dataType: ...;
                                  driverParam: ...;
                                  enumValues: ...;
                                  generated: ...;
                                  hasDefault: ...;
                                  hasRuntimeDefault: ...;
                                  identity: ...;
                                  isAutoincrement: ...;
                                  isPrimaryKey: ...;
                                  name: ...;
                                  notNull: ...;
                                  tableName: ...;
                              },
                              {},
                              { $type: ... },
                          >;
                          updatedAt: PgColumn<
                              {
                                  baseColumn: ...;
                                  columnType: ...;
                                  data: ...;
                                  dataType: ...;
                                  driverParam: ...;
                                  enumValues: ...;
                                  generated: ...;
                                  hasDefault: ...;
                                  hasRuntimeDefault: ...;
                                  identity: ...;
                                  isAutoincrement: ...;
                                  isPrimaryKey: ...;
                                  name: ...;
                                  notNull: ...;
                                  tableName: ...;
                              },
                              {},
                              {},
                          >;
                      };
                      dialect: "pg";
                      name: "reward_ledger";
                      schema: "b2b";
                  },
              >,
              "enableRLS",
          >,
          "createdAt"
          | "updatedAt",
      >[];
      page?: number;
      pageSize?: number;
      transactionType?: "CREDIT" | "DEBIT";
      updatedAt?: DbTimestampCriteria;
  }
  - Optionalcategory?: string
  - OptionalcreatedAt?: DbTimestampCriteria
  - customerId: string
  - OptionalidempotencyKey?: string
  - OptionalorderBy?: DbOrderByCriterion<
        Omit<
            PgTableWithColumns<
                {
                    columns: {
                        accountId: PgColumn<
                            {
                                baseColumn: ...;
                                columnType: ...;
                                data: ...;
                                dataType: ...;
                                driverParam: ...;
                                enumValues: ...;
                                generated: ...;
                                hasDefault: ...;
                                hasRuntimeDefault: ...;
                                identity: ...;
                                isAutoincrement: ...;
                                isPrimaryKey: ...;
                                name: ...;
                                notNull: ...;
                                tableName: ...;
                            },
                            {},
                            {},
                        >;
                        accountType: PgColumn<
                            {
                                baseColumn: ...;
                                columnType: ...;
                                data: ...;
                                dataType: ...;
                                driverParam: ...;
                                enumValues: ...;
                                generated: ...;
                                hasDefault: ...;
                                hasRuntimeDefault: ...;
                                identity: ...;
                                isAutoincrement: ...;
                                isPrimaryKey: ...;
                                name: ...;
                                notNull: ...;
                                tableName: ...;
                            },
                            {},
                            {},
                        >;
                        amount: PgColumn<
                            {
                                baseColumn: ...;
                                columnType: ...;
                                data: ...;
                                dataType: ...;
                                driverParam: ...;
                                enumValues: ...;
                                generated: ...;
                                hasDefault: ...;
                                hasRuntimeDefault: ...;
                                identity: ...;
                                isAutoincrement: ...;
                                isPrimaryKey: ...;
                                name: ...;
                                notNull: ...;
                                tableName: ...;
                            },
                            {},
                            {},
                        >;
                        category: PgColumn<
                            {
                                baseColumn: ...;
                                columnType: ...;
                                data: ...;
                                dataType: ...;
                                driverParam: ...;
                                enumValues: ...;
                                generated: ...;
                                hasDefault: ...;
                                hasRuntimeDefault: ...;
                                identity: ...;
                                isAutoincrement: ...;
                                isPrimaryKey: ...;
                                name: ...;
                                notNull: ...;
                                tableName: ...;
                            },
                            {},
                            {},
                        >;
                        createdAt: PgColumn<
                            {
                                baseColumn: ...;
                                columnType: ...;
                                data: ...;
                                dataType: ...;
                                driverParam: ...;
                                enumValues: ...;
                                generated: ...;
                                hasDefault: ...;
                                hasRuntimeDefault: ...;
                                identity: ...;
                                isAutoincrement: ...;
                                isPrimaryKey: ...;
                                name: ...;
                                notNull: ...;
                                tableName: ...;
                            },
                            {},
                            {},
                        >;
                        currency: PgColumn<
                            {
                                baseColumn: ...;
                                columnType: ...;
                                data: ...;
                                dataType: ...;
                                driverParam: ...;
                                enumValues: ...;
                                generated: ...;
                                hasDefault: ...;
                                hasRuntimeDefault: ...;
                                identity: ...;
                                isAutoincrement: ...;
                                isPrimaryKey: ...;
                                name: ...;
                                notNull: ...;
                                tableName: ...;
                            },
                            {},
                            { $type: ... },
                        >;
                        customerId: PgColumn<
                            {
                                baseColumn: ...;
                                columnType: ...;
                                data: ...;
                                dataType: ...;
                                driverParam: ...;
                                enumValues: ...;
                                generated: ...;
                                hasDefault: ...;
                                hasRuntimeDefault: ...;
                                identity: ...;
                                isAutoincrement: ...;
                                isPrimaryKey: ...;
                                name: ...;
                                notNull: ...;
                                tableName: ...;
                            },
                            {},
                            {},
                        >;
                        externalId: PgColumn<
                            {
                                baseColumn: ...;
                                columnType: ...;
                                data: ...;
                                dataType: ...;
                                driverParam: ...;
                                enumValues: ...;
                                generated: ...;
                                hasDefault: ...;
                                hasRuntimeDefault: ...;
                                identity: ...;
                                isAutoincrement: ...;
                                isPrimaryKey: ...;
                                name: ...;
                                notNull: ...;
                                tableName: ...;
                            },
                            {},
                            {},
                        >;
                        id: PgColumn<
                            {
                                baseColumn: ...;
                                columnType: ...;
                                data: ...;
                                dataType: ...;
                                driverParam: ...;
                                enumValues: ...;
                                generated: ...;
                                hasDefault: ...;
                                hasRuntimeDefault: ...;
                                identity: ...;
                                isAutoincrement: ...;
                                isPrimaryKey: ...;
                                name: ...;
                                notNull: ...;
                                tableName: ...;
                            },
                            {},
                            {},
                        >;
                        idempotencyKey: PgColumn<
                            {
                                baseColumn: ...;
                                columnType: ...;
                                data: ...;
                                dataType: ...;
                                driverParam: ...;
                                enumValues: ...;
                                generated: ...;
                                hasDefault: ...;
                                hasRuntimeDefault: ...;
                                identity: ...;
                                isAutoincrement: ...;
                                isPrimaryKey: ...;
                                name: ...;
                                notNull: ...;
                                tableName: ...;
                            },
                            {},
                            {},
                        >;
                        note: PgColumn<
                            {
                                baseColumn: ...;
                                columnType: ...;
                                data: ...;
                                dataType: ...;
                                driverParam: ...;
                                enumValues: ...;
                                generated: ...;
                                hasDefault: ...;
                                hasRuntimeDefault: ...;
                                identity: ...;
                                isAutoincrement: ...;
                                isPrimaryKey: ...;
                                name: ...;
                                notNull: ...;
                                tableName: ...;
                            },
                            {},
                            {},
                        >;
                        transactionType: PgColumn<
                            {
                                baseColumn: ...;
                                columnType: ...;
                                data: ...;
                                dataType: ...;
                                driverParam: ...;
                                enumValues: ...;
                                generated: ...;
                                hasDefault: ...;
                                hasRuntimeDefault: ...;
                                identity: ...;
                                isAutoincrement: ...;
                                isPrimaryKey: ...;
                                name: ...;
                                notNull: ...;
                                tableName: ...;
                            },
                            {},
                            { $type: ... },
                        >;
                        updatedAt: PgColumn<
                            {
                                baseColumn: ...;
                                columnType: ...;
                                data: ...;
                                dataType: ...;
                                driverParam: ...;
                                enumValues: ...;
                                generated: ...;
                                hasDefault: ...;
                                hasRuntimeDefault: ...;
                                identity: ...;
                                isAutoincrement: ...;
                                isPrimaryKey: ...;
                                name: ...;
                                notNull: ...;
                                tableName: ...;
                            },
                            {},
                            {},
                        >;
                    };
                    dialect: "pg";
                    name: "reward_ledger";
                    schema: "b2b";
                },
            >,
            "enableRLS",
        >,
        "createdAt"
        | "updatedAt",
    >[]
  - Optionalpage?: number
    Defaults to 1
  - OptionalpageSize?: number
    Defaults to 100
  - OptionaltransactionType?: "CREDIT" | "DEBIT"
  - OptionalupdatedAt?: DbTimestampCriteria
Returns Promise<
| { ok: true; value: { hasNext: boolean; items: Reward[] } }
| { error: ServiceError; ok: false },
>
entity reward entries

Throws
invalidPhone, notSupported and whatever EntityService throws
Inherited from RewardQueryService.search
- Defined in packages/reward-services/src/RewardService.ts:73

searchIterator

searchIterator(
params: Omit<Parameters<RewardQueryService["search"]>[0], "page">,
): AsyncGenerator<Reward>
Parameters
- params: Omit<Parameters<RewardQueryService["search"]>[0], "page">
Returns AsyncGenerator<Reward>
Inherited from RewardQueryService.searchIterator
- Defined in packages/reward-services/src/RewardService.ts:184

Class RewardService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RewardService

Properties

Protected Readonlydb

Methods

create

Parameters

get

Parameters

Returns Promise<{ ok: true; value: Reward | null }>

ProtectedgetAccountId

Parameters

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

getCustomerBalance

Parameters

Returns Promise<{ amount: BigNumber; currency: "MOVEUSD" }>

getEntityBalance

Parameters

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

search

Parameters

Optionalcategory?: string

OptionalcreatedAt?: DbTimestampCriteria

customerId: string

OptionalidempotencyKey?: string

Optionalpage?: number

OptionalpageSize?: number

OptionaltransactionType?: "CREDIT" | "DEBIT"

OptionalupdatedAt?: DbTimestampCriteria

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

Throws

searchIterator

Parameters

Returns AsyncGenerator<Reward>

Settings

On This Page

`Protected` `Readonly`db

`Protected`getAccountId

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

`Optional`category?: string

`Optional`createdAt?: DbTimestampCriteria

`Optional`idempotencyKey?: string

`Optional`page?: number

`Optional`pageSize?: number

`Optional`transactionType?: "CREDIT" | "DEBIT"

`Optional`updatedAt?: DbTimestampCriteria

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