Class RewardEventConfigService

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

Hierarchy (View Summary)

RewardEventConfigQueryService
- RewardEventConfigService

Index

Constructors

Properties

db rewardEventNamesCache

Methods

delete get getConfiguredEvents getReward search upsert

Constructors

constructor

new RewardEventConfigService(
__namedParameters: { sqlClient: Sql },
): RewardEventConfigService
Parameters
- __namedParameters: { sqlClient: Sql }
Returns RewardEventConfigService
Overrides RewardEventConfigQueryService.constructor
- Defined in packages/reward-services/src/RewardEventConfigService.ts:172

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`rewardEventNamesCache

rewardEventNamesCache: Keyv<string[]>

Methods

delete

delete(__namedParameters: { customerId: string; event: string }): Promise<void>
Parameters
- __namedParameters: { customerId: string; event: string }
Returns Promise<void>
- Defined in packages/reward-services/src/RewardEventConfigService.ts:235

get

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

getConfiguredEvents

getConfiguredEvents(): Promise<Set<string>>
Returns Promise<Set<string>>
Inherited from RewardEventConfigQueryService.getConfiguredEvents
- 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.
Inherited from RewardEventConfigQueryService.getReward
- 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[]>
Inherited from RewardEventConfigQueryService.search
- Defined in packages/reward-services/src/RewardEventConfigService.ts:65

upsert

upsert(
    __namedParameters: Omit<RewardEventConfig, "createdAt" | "updatedAt"> & {
        customerId: string;
    },
): Promise<RewardEventConfig>
Creates or updates reward event config for the given customer ID and event

In case of update, rules replace the previous values (rather than merge)
Parameters
- __namedParameters: Omit<RewardEventConfig, "createdAt" | "updatedAt"> & { customerId: string }
Returns Promise<RewardEventConfig>
- Defined in packages/reward-services/src/RewardEventConfigService.ts:184