PERS SDK - v2.3.26 / Exports / CampaignService

Platform-Agnostic Campaign Service

Contains campaign business logic and operations that work across platforms. No framework dependencies - pure TypeScript business logic.

Focuses only on actual backend capabilities.

• constructor

• getCampaignById
• claimCampaign
• getClaimsForLoggedUser
• getCampaigns
• getCampaignTriggers
• getCampaignTriggerById
• createCampaignTrigger
• updateCampaignTrigger
• deleteCampaignTrigger
• toggleCampaignActive
• toggleCampaignTestnet
• createCampaign
• setCampaignTrigger
• removeCampaignTrigger
• updateCampaign
• createCampaignTokenUnit
• deleteCampaignTokenUnit
• addBusinessEngagementToCampaign
• updateCampaignBusinessEngagement
• deleteCampaignBusinessEngagement
• getCampaignClaims
• getCampaignClaimsByUserId
• getCampaignClaimsByBusinessId
• assignTriggerSourceToCampaign
• removeTriggerSourceFromCampaign

• new CampaignService(campaignApi): CampaignService

CampaignService

campaign/services/campaign-service.ts:43

▸ getCampaignById(id, include?): Promise<CampaignDTO>

PUBLIC: Get campaign by ID

Promise<CampaignDTO>

campaign/services/campaign-service.ts:54

▸ claimCampaign(request): Promise<CampaignClaimDTO>

AUTH: Claim campaign

Promise<CampaignClaimDTO>

campaign/services/campaign-service.ts:65

▸ getClaimsForLoggedUser(options?, include?): Promise<PaginatedResponseDTO<CampaignClaimDTO>>

AUTH: Get claims for logged user with pagination

Promise<PaginatedResponseDTO<CampaignClaimDTO>>

campaign/services/campaign-service.ts:74

▸ getCampaigns(options?): Promise<PaginatedResponseDTO<CampaignDTO>>

Get campaigns with pagination support Intelligent access: Public gets active only, Business gets own campaigns, Admin gets all

Promise<PaginatedResponseDTO<CampaignDTO>>

See

CampaignFilterOptions for available filter options

campaign/services/campaign-service.ts:90

▸ getCampaignTriggers(options?): Promise<PaginatedResponseDTO<CampaignTriggerDTO>>

ADMIN: Get campaign triggers with pagination

Promise<PaginatedResponseDTO<CampaignTriggerDTO>>

campaign/services/campaign-service.ts:97

▸ getCampaignTriggerById(triggerId): Promise<CampaignTriggerDTO>

ADMIN: Get campaign trigger by ID

Promise<CampaignTriggerDTO>

campaign/services/campaign-service.ts:104

▸ createCampaignTrigger(data): Promise<CampaignTriggerDTO>

ADMIN: Create campaign trigger

Promise<CampaignTriggerDTO>

campaign/services/campaign-service.ts:111

▸ updateCampaignTrigger(triggerId, data): Promise<CampaignTriggerDTO>

ADMIN: Update campaign trigger

Promise<CampaignTriggerDTO>

campaign/services/campaign-service.ts:118

▸ deleteCampaignTrigger(triggerId): Promise<boolean>

ADMIN: Delete campaign trigger

Promise<boolean>

campaign/services/campaign-service.ts:125

▸ toggleCampaignActive(campaignId): Promise<CampaignDTO>

ADMIN: Toggle campaign active status

Promise<CampaignDTO>

campaign/services/campaign-service.ts:132

▸ toggleCampaignTestnet(campaignId): Promise<CampaignDTO>

ADMIN: Toggle campaign testnet environment

Promise<CampaignDTO>

campaign/services/campaign-service.ts:139

▸ createCampaign(campaign): Promise<CampaignDTO>

ADMIN: Create campaign

Promise<CampaignDTO>

campaign/services/campaign-service.ts:146

▸ setCampaignTrigger(campaignId, triggerId): Promise<CampaignDTO>

ADMIN: Set campaign trigger

Promise<CampaignDTO>

campaign/services/campaign-service.ts:153

▸ removeCampaignTrigger(campaignId, triggerId): Promise<CampaignDTO>

ADMIN: Remove trigger from campaign (unassign)

Promise<CampaignDTO>

campaign/services/campaign-service.ts:160

▸ updateCampaign(campaignId, campaign): Promise<CampaignDTO>

ADMIN: Update campaign

Promise<CampaignDTO>

campaign/services/campaign-service.ts:167

▸ createCampaignTokenUnit(campaignId, campaignTokenUnit): Promise<CampaignDTO>

ADMIN: Create campaign token unit

Promise<CampaignDTO>

campaign/services/campaign-service.ts:174

▸ deleteCampaignTokenUnit(campaignId, campaignTokenUnitId): Promise<CampaignDTO>

ADMIN: Delete campaign token unit

Promise<CampaignDTO>

campaign/services/campaign-service.ts:181

▸ addBusinessEngagementToCampaign(campaignId, campaignBusinessEngagement): Promise<CampaignDTO>

ADMIN: Add business engagement to campaign

Promise<CampaignDTO>

campaign/services/campaign-service.ts:188

▸ updateCampaignBusinessEngagement(campaignId, businessEngagementId, campaignBusinessEngagement): Promise<CampaignDTO>

ADMIN: Update campaign business engagement

Promise<CampaignDTO>

campaign/services/campaign-service.ts:195

▸ deleteCampaignBusinessEngagement(campaignId, businessEngagementId): Promise<CampaignDTO>

Promise<CampaignDTO>

campaign/services/campaign-service.ts:199

▸ getCampaignClaims(filters?, include?): Promise<PaginatedResponseDTO<CampaignClaimDTO>>

ADMIN: Get campaign claims with optional filters and pagination

Promise<PaginatedResponseDTO<CampaignClaimDTO>>

campaign/services/campaign-service.ts:208

▸ getCampaignClaimsByUserId(userId, options?, include?): Promise<PaginatedResponseDTO<CampaignClaimDTO>>

ADMIN: Get campaign claims by user ID with pagination

Promise<PaginatedResponseDTO<CampaignClaimDTO>>

campaign/services/campaign-service.ts:231

▸ getCampaignClaimsByBusinessId(businessId, options?, include?): Promise<PaginatedResponseDTO<CampaignClaimDTO>>

ADMIN: Get campaign claims by business ID with pagination

Promise<PaginatedResponseDTO<CampaignClaimDTO>>

campaign/services/campaign-service.ts:245

▸ assignTriggerSourceToCampaign(campaignId, triggerSourceId): Promise<CampaignDTO>

ADMIN: Assign a trigger source to a campaign

Promise<CampaignDTO>

campaign/services/campaign-service.ts:261

▸ removeTriggerSourceFromCampaign(campaignId, triggerSourceId): Promise<CampaignDTO>

ADMIN: Remove a trigger source from a campaign

Promise<CampaignDTO>

campaign/services/campaign-service.ts:268