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

Reference / @getenginex/sdk-igaming / CampaignOffer

CampaignOffer ​

Bonus campaign offer (a published version of the campaign).

Properties ​

campaignId ​

campaignId: string

Campaign id, for BonusApi.getOffer and BonusApi.optIn.


campaignVersionId ​

campaignVersionId: string

Published version, required in BonusApi.optIn.


claimWindow? ​

optional claimWindow?: CampaignTimeWindow

When it is possible to redeem (player_claim policy).


content? ​

optional content?: CampaignContent

Texts (name, description, terms) by language.


enrollmentWindow? ​

optional enrollmentWindow?: CampaignTimeWindow

When it is possible to join.


entryPolicy? ​

optional entryPolicy?: CampaignPolicy<CampaignEntryPolicyCode>

How to join: automatic, opt_in, promo_code or manual.


productScope ​

productScope: CampaignProductScope

Product where it applies.


publicationEndsAt? ​

optional publicationEndsAt?: string

Publication end, ISO 8601 (UTC).


publicationId ​

publicationId: string

Publication id.


publicationStartsAt? ​

optional publicationStartsAt?: string

Publication start, ISO 8601 (UTC).


qualification? ​

optional qualification?: CampaignQualification

What is needed to qualify.


qualificationWindow? ​

optional qualificationWindow?: CampaignTimeWindow

When it is possible to qualify.


reward? ​

optional reward?: CampaignReward

Reward.


rewardClaimPolicy? ​

optional rewardClaimPolicy?: CampaignPolicy<CampaignRewardClaimPolicyCode>

How to receive the reward: automatic or player_claim.


timezone ​

timezone: string

Time zone of the windows.