Class RewardClaimService

Manage reward claims

This model is not persisted outside its corresponding workflow so we cannot offer many of the methods you would typically see here

Hierarchy (View Summary)

RewardClaimQueryService
- RewardClaimService

Index

Constructors

constructor

Properties

Methods

create get getByRewardIdempotencyKey

Constructors

constructor

new RewardClaimService(
    __namedParameters: {
        db: B2bDatabase;
        eventPublisher: CustomerEventPublisher;
        rewardProgramQueryService: RewardProgramQueryService;
        rewardService: RewardService;
        temporalClient: Client;
        temporalTaskQueue: string;
    },
): RewardClaimService
Parameters
- __namedParameters: {
      db: B2bDatabase;
      eventPublisher: CustomerEventPublisher;
      rewardProgramQueryService: RewardProgramQueryService;
      rewardService: RewardService;
      temporalClient: Client;
      temporalTaskQueue: string;
  }
Returns RewardClaimService
Overrides RewardClaimQueryService.constructor
- Defined in packages/reward-services/src/RewardClaimService.ts:153

Properties

`Protected` `Readonly`db

db: B2bDatabase

Methods

create

create(
    __namedParameters: Pick<Reward, "category" | "amount" | "note"> & {
        customerId: string;
        entityId: string;
        idempotencyKey?: string;
        targetWallet: Address;
    },
): Promise<
    | { ok: true; value: RewardClaim }
    | {
        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;
    },
>
Create a reward claim

Claims deduct from reward balance and deposit MOVEUSD into target wallets
Parameters
- __namedParameters: Pick<Reward, "category" | "amount" | "note"> & {
      customerId: string;
      entityId: string;
      idempotencyKey?: string;
      targetWallet: Address;
  }
Returns Promise<
    | { ok: true; value: RewardClaim }
    | {
        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;
    },
>
- Defined in packages/reward-services/src/RewardClaimService.ts:182

get

get(
__namedParameters: { customerId: string; id: string },
): Promise<{ ok: true; value: RewardClaim | null }>
Retrieves a reward claim

Can be used to check status of a reward claim workflow
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<{ ok: true; value: RewardClaim | null }>
Inherited from RewardClaimQueryService.get
- Defined in packages/reward-services/src/RewardClaimService.ts:41

getByRewardIdempotencyKey

getByRewardIdempotencyKey(
__namedParameters: { customerId: string; idempotencyKey: string },
): Promise<RewardClaim | null>
Retrieves a reward claim by it's reward ledger idempotency key

Can be used to check status of a reward claim workflow
Parameters
- __namedParameters: { customerId: string; idempotencyKey: string }
Returns Promise<RewardClaim | null>
Inherited from RewardClaimQueryService.getByRewardIdempotencyKey
- Defined in packages/reward-services/src/RewardClaimService.ts:91

Class RewardClaimService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RewardClaimService

Properties

`Protected` `Readonly`db

Methods

create

Parameters

get

Parameters

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

getByRewardIdempotencyKey

Parameters

Returns Promise<RewardClaim | null>

Settings

On This Page

Class RewardClaimService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RewardClaimService

Properties

Protected Readonlydb

Methods

create

Parameters

get

Parameters

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

getByRewardIdempotencyKey

Parameters

Returns Promise<RewardClaim | null>

Settings

On This Page

`Protected` `Readonly`db