[PERS SDK - v2.3.26](/sdk-reference/readme) / [Exports](/sdk-reference/modules) / CampaignService

# Class: 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.

## Table of contents

### Constructors

- [constructor](/sdk-reference/classes/campaignservice#constructor)


### Methods

- [getCampaignById](/sdk-reference/classes/campaignservice#getcampaignbyid)
- [claimCampaign](/sdk-reference/classes/campaignservice#claimcampaign)
- [getClaimsForLoggedUser](/sdk-reference/classes/campaignservice#getclaimsforloggeduser)
- [getCampaigns](/sdk-reference/classes/campaignservice#getcampaigns)
- [getCampaignTriggers](/sdk-reference/classes/campaignservice#getcampaigntriggers)
- [getCampaignTriggerById](/sdk-reference/classes/campaignservice#getcampaigntriggerbyid)
- [createCampaignTrigger](/sdk-reference/classes/campaignservice#createcampaigntrigger)
- [updateCampaignTrigger](/sdk-reference/classes/campaignservice#updatecampaigntrigger)
- [deleteCampaignTrigger](/sdk-reference/classes/campaignservice#deletecampaigntrigger)
- [toggleCampaignActive](/sdk-reference/classes/campaignservice#togglecampaignactive)
- [toggleCampaignTestnet](/sdk-reference/classes/campaignservice#togglecampaigntestnet)
- [createCampaign](/sdk-reference/classes/campaignservice#createcampaign)
- [setCampaignTrigger](/sdk-reference/classes/campaignservice#setcampaigntrigger)
- [removeCampaignTrigger](/sdk-reference/classes/campaignservice#removecampaigntrigger)
- [updateCampaign](/sdk-reference/classes/campaignservice#updatecampaign)
- [createCampaignTokenUnit](/sdk-reference/classes/campaignservice#createcampaigntokenunit)
- [deleteCampaignTokenUnit](/sdk-reference/classes/campaignservice#deletecampaigntokenunit)
- [addBusinessEngagementToCampaign](/sdk-reference/classes/campaignservice#addbusinessengagementtocampaign)
- [updateCampaignBusinessEngagement](/sdk-reference/classes/campaignservice#updatecampaignbusinessengagement)
- [deleteCampaignBusinessEngagement](/sdk-reference/classes/campaignservice#deletecampaignbusinessengagement)
- [getCampaignClaims](/sdk-reference/classes/campaignservice#getcampaignclaims)
- [getCampaignClaimsByUserId](/sdk-reference/classes/campaignservice#getcampaignclaimsbyuserid)
- [getCampaignClaimsByBusinessId](/sdk-reference/classes/campaignservice#getcampaignclaimsbybusinessid)
- [assignTriggerSourceToCampaign](/sdk-reference/classes/campaignservice#assigntriggersourcetocampaign)
- [removeTriggerSourceFromCampaign](/sdk-reference/classes/campaignservice#removetriggersourcefromcampaign)


## Constructors

### constructor

• **new CampaignService**(`campaignApi`): [`CampaignService`](/sdk-reference/classes/campaignservice)

#### Parameters

| Name | Type |
|  --- | --- |
| `campaignApi` | [`CampaignApi`](/sdk-reference/classes/campaignapi) |


#### Returns

[`CampaignService`](/sdk-reference/classes/campaignservice)

#### Defined in

[campaign/services/campaign-service.ts:43](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L43)

## Methods

### getCampaignById

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

PUBLIC: Get campaign by ID

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `id` | `string` | Campaign UUID |
| `include?` | `CampaignIncludeRelation`[] | Relations to include: 'triggerSources', 'businesses' |


#### Returns

`Promise`<`CampaignDTO`>

#### Defined in

[campaign/services/campaign-service.ts:54](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L54)

### claimCampaign

▸ **claimCampaign**(`request`): `Promise`<`CampaignClaimDTO`>

AUTH: Claim campaign

#### Parameters

| Name | Type |
|  --- | --- |
| `request` | `CampaignClaimRequestDTO` |


#### Returns

`Promise`<`CampaignClaimDTO`>

#### Defined in

[campaign/services/campaign-service.ts:65](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L65)

### getClaimsForLoggedUser

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

AUTH: Get claims for logged user with pagination

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `options?` | `PaginationOptions` | Pagination options |
| `include?` | `CampaignClaimIncludeRelation`[] | Optional relations to include (campaign, user, business) |


#### Returns

`Promise`<`PaginatedResponseDTO`<`CampaignClaimDTO`>>

#### Defined in

[campaign/services/campaign-service.ts:74](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L74)

### getCampaigns

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

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

#### Parameters

| Name | Type |
|  --- | --- |
| `options?` | `CampaignQueryParams` |


#### Returns

`Promise`<`PaginatedResponseDTO`<`CampaignDTO`>>

**`See`**

CampaignFilterOptions for available filter options

#### Defined in

[campaign/services/campaign-service.ts:90](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L90)

### getCampaignTriggers

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

ADMIN: Get campaign triggers with pagination

#### Parameters

| Name | Type |
|  --- | --- |
| `options?` | `PaginationOptions` |


#### Returns

`Promise`<`PaginatedResponseDTO`<`CampaignTriggerDTO`>>

#### Defined in

[campaign/services/campaign-service.ts:97](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L97)

### getCampaignTriggerById

▸ **getCampaignTriggerById**(`triggerId`): `Promise`<`CampaignTriggerDTO`>

ADMIN: Get campaign trigger by ID

#### Parameters

| Name | Type |
|  --- | --- |
| `triggerId` | `string` |


#### Returns

`Promise`<`CampaignTriggerDTO`>

#### Defined in

[campaign/services/campaign-service.ts:104](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L104)

### createCampaignTrigger

▸ **createCampaignTrigger**(`data`): `Promise`<`CampaignTriggerDTO`>

ADMIN: Create campaign trigger

#### Parameters

| Name | Type |
|  --- | --- |
| `data` | `CampaignTriggerCreateRequestDTO` |


#### Returns

`Promise`<`CampaignTriggerDTO`>

#### Defined in

[campaign/services/campaign-service.ts:111](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L111)

### updateCampaignTrigger

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

ADMIN: Update campaign trigger

#### Parameters

| Name | Type |
|  --- | --- |
| `triggerId` | `string` |
| `data` | `Partial`<`CampaignTriggerCreateRequestDTO`> |


#### Returns

`Promise`<`CampaignTriggerDTO`>

#### Defined in

[campaign/services/campaign-service.ts:118](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L118)

### deleteCampaignTrigger

▸ **deleteCampaignTrigger**(`triggerId`): `Promise`<`boolean`>

ADMIN: Delete campaign trigger

#### Parameters

| Name | Type |
|  --- | --- |
| `triggerId` | `string` |


#### Returns

`Promise`<`boolean`>

#### Defined in

[campaign/services/campaign-service.ts:125](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L125)

### toggleCampaignActive

▸ **toggleCampaignActive**(`campaignId`): `Promise`<`CampaignDTO`>

ADMIN: Toggle campaign active status

#### Parameters

| Name | Type |
|  --- | --- |
| `campaignId` | `string` |


#### Returns

`Promise`<`CampaignDTO`>

#### Defined in

[campaign/services/campaign-service.ts:132](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L132)

### toggleCampaignTestnet

▸ **toggleCampaignTestnet**(`campaignId`): `Promise`<`CampaignDTO`>

ADMIN: Toggle campaign testnet environment

#### Parameters

| Name | Type |
|  --- | --- |
| `campaignId` | `string` |


#### Returns

`Promise`<`CampaignDTO`>

#### Defined in

[campaign/services/campaign-service.ts:139](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L139)

### createCampaign

▸ **createCampaign**(`campaign`): `Promise`<`CampaignDTO`>

ADMIN: Create campaign

#### Parameters

| Name | Type |
|  --- | --- |
| `campaign` | `CampaignCreateRequestDTO` |


#### Returns

`Promise`<`CampaignDTO`>

#### Defined in

[campaign/services/campaign-service.ts:146](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L146)

### setCampaignTrigger

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

ADMIN: Set campaign trigger

#### Parameters

| Name | Type |
|  --- | --- |
| `campaignId` | `string` |
| `triggerId` | `string` |


#### Returns

`Promise`<`CampaignDTO`>

#### Defined in

[campaign/services/campaign-service.ts:153](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L153)

### removeCampaignTrigger

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

ADMIN: Remove trigger from campaign (unassign)

#### Parameters

| Name | Type |
|  --- | --- |
| `campaignId` | `string` |
| `triggerId` | `string` |


#### Returns

`Promise`<`CampaignDTO`>

#### Defined in

[campaign/services/campaign-service.ts:160](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L160)

### updateCampaign

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

ADMIN: Update campaign

#### Parameters

| Name | Type |
|  --- | --- |
| `campaignId` | `string` |
| `campaign` | `CampaignCreateRequestDTO` |


#### Returns

`Promise`<`CampaignDTO`>

#### Defined in

[campaign/services/campaign-service.ts:167](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L167)

### createCampaignTokenUnit

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

ADMIN: Create campaign token unit

#### Parameters

| Name | Type |
|  --- | --- |
| `campaignId` | `string` |
| `campaignTokenUnit` | `TokenUnitCreateRequestDTO` |


#### Returns

`Promise`<`CampaignDTO`>

#### Defined in

[campaign/services/campaign-service.ts:174](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L174)

### deleteCampaignTokenUnit

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

ADMIN: Delete campaign token unit

#### Parameters

| Name | Type |
|  --- | --- |
| `campaignId` | `string` |
| `campaignTokenUnitId` | `string` |


#### Returns

`Promise`<`CampaignDTO`>

#### Defined in

[campaign/services/campaign-service.ts:181](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L181)

### addBusinessEngagementToCampaign

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

ADMIN: Add business engagement to campaign

#### Parameters

| Name | Type |
|  --- | --- |
| `campaignId` | `string` |
| `campaignBusinessEngagement` | `CampaignBusinessEngagementCreateRequestDTO` |


#### Returns

`Promise`<`CampaignDTO`>

#### Defined in

[campaign/services/campaign-service.ts:188](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L188)

### updateCampaignBusinessEngagement

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

ADMIN: Update campaign business engagement

#### Parameters

| Name | Type |
|  --- | --- |
| `campaignId` | `string` |
| `businessEngagementId` | `string` |
| `campaignBusinessEngagement` | `CampaignBusinessEngagementCreateRequestDTO` |


#### Returns

`Promise`<`CampaignDTO`>

#### Defined in

[campaign/services/campaign-service.ts:195](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L195)

### deleteCampaignBusinessEngagement

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

#### Parameters

| Name | Type |
|  --- | --- |
| `campaignId` | `string` |
| `businessEngagementId` | `string` |


#### Returns

`Promise`<`CampaignDTO`>

#### Defined in

[campaign/services/campaign-service.ts:199](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L199)

### getCampaignClaims

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

ADMIN: Get campaign claims with optional filters and pagination

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `filters?` | `Object` | Filter and pagination options including date range |
| `filters.campaignId?` | `string` | - |
| `filters.userId?` | `string` | - |
| `filters.businessId?` | `string` | - |
| `filters.dateFrom?` | `string` | `Date` | - |
| `filters.dateTo?` | `string` | `Date` | - |
| `filters.page?` | `number` | - |
| `filters.limit?` | `number` | - |
| `filters.sortBy?` | `string` | - |
| `filters.sortOrder?` | `SortOrder` | - |
| `include?` | `CampaignClaimIncludeRelation`[] | Optional relations to include (campaign, user, business) |


#### Returns

`Promise`<`PaginatedResponseDTO`<`CampaignClaimDTO`>>

#### Defined in

[campaign/services/campaign-service.ts:208](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L208)

### getCampaignClaimsByUserId

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

ADMIN: Get campaign claims by user ID with pagination

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `userId` | `string` | User ID to filter by |
| `options?` | `PaginationOptions` | Pagination options |
| `include?` | `CampaignClaimIncludeRelation`[] | Optional relations to include (campaign, user, business) |


#### Returns

`Promise`<`PaginatedResponseDTO`<`CampaignClaimDTO`>>

#### Defined in

[campaign/services/campaign-service.ts:231](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L231)

### getCampaignClaimsByBusinessId

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

ADMIN: Get campaign claims by business ID with pagination

#### Parameters

| Name | Type | Description |
|  --- | --- | --- |
| `businessId` | `string` | Business ID to filter by |
| `options?` | `PaginationOptions` | Pagination options |
| `include?` | `CampaignClaimIncludeRelation`[] | Optional relations to include (campaign, user, business) |


#### Returns

`Promise`<`PaginatedResponseDTO`<`CampaignClaimDTO`>>

#### Defined in

[campaign/services/campaign-service.ts:245](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L245)

### assignTriggerSourceToCampaign

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

ADMIN: Assign a trigger source to a campaign

#### Parameters

| Name | Type |
|  --- | --- |
| `campaignId` | `string` |
| `triggerSourceId` | `string` |


#### Returns

`Promise`<`CampaignDTO`>

#### Defined in

[campaign/services/campaign-service.ts:261](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L261)

### removeTriggerSourceFromCampaign

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

ADMIN: Remove a trigger source from a campaign

#### Parameters

| Name | Type |
|  --- | --- |
| `campaignId` | `string` |
| `triggerSourceId` | `string` |


#### Returns

`Promise`<`CampaignDTO`>

#### Defined in

[campaign/services/campaign-service.ts:268](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/campaign/services/campaign-service.ts#L268)