This version (v0.7) has not been published to npm yet.
Skip to content

Reference / @getenginex/sdk-igaming / CampaignParticipation

CampaignParticipation ​

The player's participation in a campaign, with the reward and the texts as they were when they joined.

Properties ​

campaignId ​

campaignId: string

Campaign id.


campaignVersionId ​

campaignVersionId: string

Campaign version the player joined.


completedAt? ​

optional completedAt?: string

When the reward was granted (status: 'completed').


expiredAt? ​

optional expiredAt?: string

When it expired (status: 'expired').


id ​

id: string

Participation id, for BonusApi.claim and BonusApi.getParticipation.


qualificationSnapshot? ​

optional qualificationSnapshot?: CampaignQualification

Required qualification (a copy from the time of joining).


qualifiedAt? ​

optional qualifiedAt?: string

When it qualified (status: 'qualified').


rewardKey ​

rewardKey: string

Reward key.


snapshot? ​

optional snapshot?: object

Reward, texts and terms acceptance as of the time of joining.

content? ​

optional content?: CampaignContent

Texts.

reward? ​

optional reward?: CampaignReward

Reward.

termsAcceptance? ​

optional termsAcceptance?: CampaignTermsAcceptanceRecord

Terms acceptance, if there was one.


status ​

status: CampaignParticipationStatus

Status.