Class RewardQueryService

Hierarchy (View Summary)

RewardQueryService
- RewardService

Index

Constructors

constructor

Properties

Methods

get getAccountId getCustomerBalance getEntityBalance search searchIterator

Constructors

constructor

new RewardQueryService(
args: { db: B2bDatabase; entityService: EntityService },
): RewardQueryService
Parameters
- args: { db: B2bDatabase; entityService: EntityService }
Returns RewardQueryService
- Defined in packages/reward-services/src/RewardService.ts:41

Properties

`Protected` `Readonly`db

db: B2bDatabase

Methods

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
- Defined in packages/reward-services/src/RewardService.ts:47

`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
- Defined in packages/reward-services/src/RewardService.ts:275

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
- Defined in packages/reward-services/src/RewardService.ts:259

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
- Defined in packages/reward-services/src/RewardService.ts:230

search

search(
    __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;
    },
): Promise<
    | {
        ok: true;
        value: { hasNext: boolean; items: Reward[]; total: number };
    }
    | { error: ServiceError; ok: false },
>
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

Throws
invalidPhone, notSupported and whatever EntityService throws
- Defined in packages/reward-services/src/RewardService.ts:66

searchIterator

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

Class RewardQueryService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RewardQueryService

Properties

Protected Readonlydb

Methods

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

Optionalids?: string[]

Optionalpage?: number

OptionalpageSize?: number

OptionaltransactionType?: "DEBIT" | "CREDIT"

OptionalupdatedAt?: DbTimestampCriteria

Returns Promise< | { ok: true; value: { hasNext: boolean; items: Reward[]; total: number }; } | { 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`ids?: string[]

`Optional`page?: number

`Optional`pageSize?: number

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

`Optional`updatedAt?: DbTimestampCriteria

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