Class RewardEventConfigQueryService

Rules that are configured per customer to trigger rewards on certain events

Hierarchy (View Summary)

RewardEventConfigQueryService
- RewardEventConfigService

Index

Constructors

Properties

db rewardEventNamesCache

Methods

get getConfiguredEvents getReward search

Constructors

constructor

new RewardEventConfigQueryService(
__namedParameters: { keyvStore?: KeyvStoreAdapter; sqlClient: Sql },
): RewardEventConfigQueryService
Parameters
- __namedParameters: { keyvStore?: KeyvStoreAdapter; sqlClient: Sql }
Returns RewardEventConfigQueryService
- Defined in packages/reward-services/src/RewardEventConfigService.ts:23

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`rewardEventNamesCache

rewardEventNamesCache: Keyv<string[]>

Methods

get

get(
__namedParameters: { customerId: string; event: string },
): Promise<RewardEventConfig | null>
Parameters
- __namedParameters: { customerId: string; event: string }
Returns Promise<RewardEventConfig | null>
- Defined in packages/reward-services/src/RewardEventConfigService.ts:39

getConfiguredEvents

getConfiguredEvents(): Promise<Set<string>>
Returns Promise<Set<string>>
- Defined in packages/reward-services/src/RewardEventConfigService.ts:144

getReward

getReward(
__namedParameters: { customerId: string; data: object; event: string },
): Promise<RewardAmount | null>
Match event and event data to the rules defined for the given customer

If multiple rules match, the first one is returned
Parameters
- __namedParameters: { customerId: string; data: object; event: string }
  - customerId: string
  - data: object
    Data associated with the event, compared against rule matchers
  - event: string
Returns Promise<RewardAmount | null>
Reward amount that this event qualifies for. null if no active rules match.
- Defined in packages/reward-services/src/RewardEventConfigService.ts:100

search

search(
    __namedParameters: {
        customerId: string;
        status?: "ACTIVE" | "DISABLED";
    },
): Promise<RewardEventConfig[]>
Parameters
- __namedParameters: { customerId: string; status?: "ACTIVE" | "DISABLED" }
Returns Promise<RewardEventConfig[]>
- Defined in packages/reward-services/src/RewardEventConfigService.ts:65