@roketus/loyalty-js-sdk 5.0.1 → 5.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (187) hide show
  1. package/dist/cjs/api/campaign/actions/addAction.d.ts +2 -0
  2. package/dist/cjs/api/campaign/actions/removeAction.d.ts +2 -0
  3. package/dist/cjs/api/campaign/actions/updateAction.d.ts +2 -0
  4. package/dist/cjs/api/campaign/createCampaign.d.ts +1 -1
  5. package/dist/cjs/api/campaign/deleteCampaign.d.ts +2 -0
  6. package/dist/cjs/api/campaign/getCampaignById.d.ts +1 -1
  7. package/dist/cjs/api/campaign/getCampaignStatistics.d.ts +2 -0
  8. package/dist/cjs/api/campaign/lifecycle/activateCampaign.d.ts +2 -0
  9. package/dist/cjs/api/campaign/lifecycle/cancelCampaign.d.ts +2 -0
  10. package/dist/cjs/api/campaign/lifecycle/completeCampaign.d.ts +2 -0
  11. package/dist/cjs/api/campaign/lifecycle/executeCampaign.d.ts +2 -0
  12. package/dist/cjs/api/campaign/lifecycle/pauseCampaign.d.ts +2 -0
  13. package/dist/cjs/api/campaign/lifecycle/resumeCampaign.d.ts +2 -0
  14. package/dist/cjs/api/campaign/listCampaigns.d.ts +2 -0
  15. package/dist/cjs/api/campaign/updateCampaignDates.d.ts +2 -0
  16. package/dist/cjs/api/campaign/updateCampaignInfo.d.ts +2 -0
  17. package/dist/cjs/api/campaign/updateCampaignLocations.d.ts +2 -0
  18. package/dist/cjs/api/cohorts/createCohort.d.ts +2 -0
  19. package/dist/cjs/api/cohorts/deleteCohort.d.ts +2 -0
  20. package/dist/cjs/api/cohorts/getCohortById.d.ts +2 -0
  21. package/dist/cjs/api/cohorts/listCohorts.d.ts +2 -0
  22. package/dist/cjs/api/cohorts/updateCohort.d.ts +2 -0
  23. package/dist/cjs/index.d.ts +3 -2
  24. package/dist/cjs/index.js +1 -1
  25. package/dist/cjs/interfaces/ISDK.d.ts +8 -31
  26. package/dist/{esm5/interfaces/campaignsV2 → cjs/interfaces/campaigns}/ICampaignCohort.d.ts +1 -1
  27. package/dist/cjs/interfaces/campaigns/campaignInterfaces.d.ts +55 -18
  28. package/dist/cjs/interfaces/campaigns/index.d.ts +10 -5
  29. package/dist/cjs/interfaces/notifications/ICampaignChannelData.d.ts +6 -0
  30. package/dist/cjs/interfaces/notifications/IGetMyNotificationStats.d.ts +1 -1
  31. package/dist/esm5/api/campaign/actions/addAction.d.ts +2 -0
  32. package/dist/esm5/api/campaign/actions/removeAction.d.ts +2 -0
  33. package/dist/esm5/api/campaign/actions/updateAction.d.ts +2 -0
  34. package/dist/esm5/api/campaign/createCampaign.d.ts +1 -1
  35. package/dist/esm5/api/campaign/deleteCampaign.d.ts +2 -0
  36. package/dist/esm5/api/campaign/getCampaignById.d.ts +1 -1
  37. package/dist/esm5/api/campaign/getCampaignStatistics.d.ts +2 -0
  38. package/dist/esm5/api/campaign/lifecycle/activateCampaign.d.ts +2 -0
  39. package/dist/esm5/api/campaign/lifecycle/cancelCampaign.d.ts +2 -0
  40. package/dist/esm5/api/campaign/lifecycle/completeCampaign.d.ts +2 -0
  41. package/dist/esm5/api/campaign/lifecycle/executeCampaign.d.ts +2 -0
  42. package/dist/esm5/api/campaign/lifecycle/pauseCampaign.d.ts +2 -0
  43. package/dist/esm5/api/campaign/lifecycle/resumeCampaign.d.ts +2 -0
  44. package/dist/esm5/api/campaign/listCampaigns.d.ts +2 -0
  45. package/dist/esm5/api/campaign/updateCampaignDates.d.ts +2 -0
  46. package/dist/esm5/api/campaign/updateCampaignInfo.d.ts +2 -0
  47. package/dist/esm5/api/campaign/updateCampaignLocations.d.ts +2 -0
  48. package/dist/esm5/api/cohorts/createCohort.d.ts +2 -0
  49. package/dist/esm5/api/cohorts/deleteCohort.d.ts +2 -0
  50. package/dist/esm5/api/cohorts/getCohortById.d.ts +2 -0
  51. package/dist/esm5/api/cohorts/listCohorts.d.ts +2 -0
  52. package/dist/esm5/api/cohorts/updateCohort.d.ts +2 -0
  53. package/dist/esm5/index.d.ts +3 -2
  54. package/dist/esm5/index.js +1 -1
  55. package/dist/esm5/interfaces/ISDK.d.ts +8 -31
  56. package/dist/{cjs/interfaces/campaignsV2 → esm5/interfaces/campaigns}/ICampaignCohort.d.ts +1 -1
  57. package/dist/esm5/interfaces/campaigns/campaignInterfaces.d.ts +55 -18
  58. package/dist/esm5/interfaces/campaigns/index.d.ts +10 -5
  59. package/dist/esm5/interfaces/notifications/ICampaignChannelData.d.ts +6 -0
  60. package/dist/esm5/interfaces/notifications/IGetMyNotificationStats.d.ts +1 -1
  61. package/package.json +1 -1
  62. package/dist/cjs/api/campaign/cohorts/getMyCohorts.d.ts +0 -2
  63. package/dist/cjs/api/campaign/cohorts/setCohortToCampaign.d.ts +0 -2
  64. package/dist/cjs/api/campaign/cohorts/v2/createCohort.d.ts +0 -2
  65. package/dist/cjs/api/campaign/cohorts/v2/deleteCohort.d.ts +0 -2
  66. package/dist/cjs/api/campaign/cohorts/v2/getCohortById.d.ts +0 -2
  67. package/dist/cjs/api/campaign/cohorts/v2/listCohorts.d.ts +0 -2
  68. package/dist/cjs/api/campaign/cohorts/v2/updateCohort.d.ts +0 -2
  69. package/dist/cjs/api/campaign/getMyCampaigns.d.ts +0 -2
  70. package/dist/cjs/api/campaign/runCampaign.d.ts +0 -2
  71. package/dist/cjs/api/campaign/templates/createEmailTemplate.d.ts +0 -16
  72. package/dist/cjs/api/campaign/templates/createPassPushTemplate.d.ts +0 -15
  73. package/dist/cjs/api/campaign/templates/createSMSTemplate.d.ts +0 -14
  74. package/dist/cjs/api/campaign/templates/createWebPushTemplate.d.ts +0 -15
  75. package/dist/cjs/api/campaign/templates/deleteTemplate.d.ts +0 -2
  76. package/dist/cjs/api/campaign/templates/deleteTemplateFromCampaign.d.ts +0 -2
  77. package/dist/cjs/api/campaign/templates/getMyTemplates.d.ts +0 -2
  78. package/dist/cjs/api/campaign/templates/getTemplateById.d.ts +0 -2
  79. package/dist/cjs/api/campaign/templates/resultSerializer.d.ts +0 -1
  80. package/dist/cjs/api/campaign/templates/setTemplateToCampaign.d.ts +0 -2
  81. package/dist/cjs/api/campaign/templates/setTemplatesToCampaign.d.ts +0 -2
  82. package/dist/cjs/api/campaign/templates/updateEmailTemplate.d.ts +0 -2
  83. package/dist/cjs/api/campaign/templates/updatePassPushTemplate.d.ts +0 -2
  84. package/dist/cjs/api/campaign/templates/updateSMSTemplate.d.ts +0 -2
  85. package/dist/cjs/api/campaign/templates/updateWebPushTemplate.d.ts +0 -2
  86. package/dist/cjs/api/campaign/v2/actions/addAction.d.ts +0 -2
  87. package/dist/cjs/api/campaign/v2/actions/removeAction.d.ts +0 -2
  88. package/dist/cjs/api/campaign/v2/actions/updateAction.d.ts +0 -2
  89. package/dist/cjs/api/campaign/v2/campaignResultSerializer.d.ts +0 -1
  90. package/dist/cjs/api/campaign/v2/createCampaign.d.ts +0 -2
  91. package/dist/cjs/api/campaign/v2/deleteCampaign.d.ts +0 -2
  92. package/dist/cjs/api/campaign/v2/getCampaignById.d.ts +0 -2
  93. package/dist/cjs/api/campaign/v2/getCampaignStatistics.d.ts +0 -2
  94. package/dist/cjs/api/campaign/v2/lifecycle/activateCampaign.d.ts +0 -2
  95. package/dist/cjs/api/campaign/v2/lifecycle/cancelCampaign.d.ts +0 -2
  96. package/dist/cjs/api/campaign/v2/lifecycle/completeCampaign.d.ts +0 -2
  97. package/dist/cjs/api/campaign/v2/lifecycle/executeCampaign.d.ts +0 -2
  98. package/dist/cjs/api/campaign/v2/lifecycle/pauseCampaign.d.ts +0 -2
  99. package/dist/cjs/api/campaign/v2/lifecycle/resumeCampaign.d.ts +0 -2
  100. package/dist/cjs/api/campaign/v2/listCampaigns.d.ts +0 -2
  101. package/dist/cjs/api/campaign/v2/updateCampaignDates.d.ts +0 -2
  102. package/dist/cjs/api/campaign/v2/updateCampaignInfo.d.ts +0 -2
  103. package/dist/cjs/api/campaign/v2/updateCampaignLocations.d.ts +0 -2
  104. package/dist/cjs/interfaces/campaigns/cohortsInterfaces.d.ts +0 -13
  105. package/dist/cjs/interfaces/campaigns/common.d.ts +0 -74
  106. package/dist/cjs/interfaces/campaigns/templatesInterfaces.d.ts +0 -96
  107. package/dist/cjs/interfaces/campaignsV2/campaignInterfaces.d.ts +0 -69
  108. package/dist/cjs/interfaces/campaignsV2/index.d.ts +0 -10
  109. package/dist/esm5/api/campaign/cohorts/getMyCohorts.d.ts +0 -2
  110. package/dist/esm5/api/campaign/cohorts/resultSerializer.d.ts +0 -1
  111. package/dist/esm5/api/campaign/cohorts/setCohortToCampaign.d.ts +0 -2
  112. package/dist/esm5/api/campaign/cohorts/v2/createCohort.d.ts +0 -2
  113. package/dist/esm5/api/campaign/cohorts/v2/deleteCohort.d.ts +0 -2
  114. package/dist/esm5/api/campaign/cohorts/v2/getCohortById.d.ts +0 -2
  115. package/dist/esm5/api/campaign/cohorts/v2/listCohorts.d.ts +0 -2
  116. package/dist/esm5/api/campaign/cohorts/v2/resultSerializer.d.ts +0 -1
  117. package/dist/esm5/api/campaign/cohorts/v2/updateCohort.d.ts +0 -2
  118. package/dist/esm5/api/campaign/getMyCampaigns.d.ts +0 -2
  119. package/dist/esm5/api/campaign/runCampaign.d.ts +0 -2
  120. package/dist/esm5/api/campaign/templates/createEmailTemplate.d.ts +0 -16
  121. package/dist/esm5/api/campaign/templates/createPassPushTemplate.d.ts +0 -15
  122. package/dist/esm5/api/campaign/templates/createSMSTemplate.d.ts +0 -14
  123. package/dist/esm5/api/campaign/templates/createWebPushTemplate.d.ts +0 -15
  124. package/dist/esm5/api/campaign/templates/deleteTemplate.d.ts +0 -2
  125. package/dist/esm5/api/campaign/templates/deleteTemplateFromCampaign.d.ts +0 -2
  126. package/dist/esm5/api/campaign/templates/getMyTemplates.d.ts +0 -2
  127. package/dist/esm5/api/campaign/templates/getTemplateById.d.ts +0 -2
  128. package/dist/esm5/api/campaign/templates/resultSerializer.d.ts +0 -1
  129. package/dist/esm5/api/campaign/templates/setTemplateToCampaign.d.ts +0 -2
  130. package/dist/esm5/api/campaign/templates/setTemplatesToCampaign.d.ts +0 -2
  131. package/dist/esm5/api/campaign/templates/updateEmailTemplate.d.ts +0 -2
  132. package/dist/esm5/api/campaign/templates/updatePassPushTemplate.d.ts +0 -2
  133. package/dist/esm5/api/campaign/templates/updateSMSTemplate.d.ts +0 -2
  134. package/dist/esm5/api/campaign/templates/updateWebPushTemplate.d.ts +0 -2
  135. package/dist/esm5/api/campaign/v2/actions/addAction.d.ts +0 -2
  136. package/dist/esm5/api/campaign/v2/actions/removeAction.d.ts +0 -2
  137. package/dist/esm5/api/campaign/v2/actions/updateAction.d.ts +0 -2
  138. package/dist/esm5/api/campaign/v2/campaignResultSerializer.d.ts +0 -1
  139. package/dist/esm5/api/campaign/v2/createCampaign.d.ts +0 -2
  140. package/dist/esm5/api/campaign/v2/deleteCampaign.d.ts +0 -2
  141. package/dist/esm5/api/campaign/v2/getCampaignById.d.ts +0 -2
  142. package/dist/esm5/api/campaign/v2/getCampaignStatistics.d.ts +0 -2
  143. package/dist/esm5/api/campaign/v2/lifecycle/activateCampaign.d.ts +0 -2
  144. package/dist/esm5/api/campaign/v2/lifecycle/cancelCampaign.d.ts +0 -2
  145. package/dist/esm5/api/campaign/v2/lifecycle/completeCampaign.d.ts +0 -2
  146. package/dist/esm5/api/campaign/v2/lifecycle/executeCampaign.d.ts +0 -2
  147. package/dist/esm5/api/campaign/v2/lifecycle/pauseCampaign.d.ts +0 -2
  148. package/dist/esm5/api/campaign/v2/lifecycle/resumeCampaign.d.ts +0 -2
  149. package/dist/esm5/api/campaign/v2/listCampaigns.d.ts +0 -2
  150. package/dist/esm5/api/campaign/v2/updateCampaignDates.d.ts +0 -2
  151. package/dist/esm5/api/campaign/v2/updateCampaignInfo.d.ts +0 -2
  152. package/dist/esm5/api/campaign/v2/updateCampaignLocations.d.ts +0 -2
  153. package/dist/esm5/interfaces/campaigns/cohortsInterfaces.d.ts +0 -13
  154. package/dist/esm5/interfaces/campaigns/common.d.ts +0 -74
  155. package/dist/esm5/interfaces/campaigns/templatesInterfaces.d.ts +0 -96
  156. package/dist/esm5/interfaces/campaignsV2/campaignInterfaces.d.ts +0 -69
  157. package/dist/esm5/interfaces/campaignsV2/index.d.ts +0 -10
  158. /package/dist/cjs/api/{campaign/cohorts → cohorts}/resultSerializer.d.ts +0 -0
  159. /package/dist/cjs/interfaces/{campaignsV2 → campaigns}/ENotificationChannel.d.ts +0 -0
  160. /package/dist/cjs/interfaces/{campaignsV2 → campaigns}/ICampaign.d.ts +0 -0
  161. /package/dist/cjs/interfaces/{campaignsV2 → campaigns}/ICampaignAction.d.ts +0 -0
  162. /package/dist/cjs/interfaces/{campaignsV2 → campaigns}/ICampaignLocation.d.ts +0 -0
  163. /package/dist/cjs/interfaces/{campaignsV2 → campaigns}/ICampaignRun.d.ts +0 -0
  164. /package/dist/cjs/interfaces/{campaignsV2 → campaigns}/ICampaignStatistics.d.ts +0 -0
  165. /package/dist/cjs/interfaces/{campaignsV2 → campaigns}/IExecuteCampaignResult.d.ts +0 -0
  166. /package/dist/cjs/interfaces/{campaignsV2 → campaigns}/INotificationMedia.d.ts +0 -0
  167. /package/dist/cjs/interfaces/{campaignsV2 → campaigns}/campaignPayloads.d.ts +0 -0
  168. /package/dist/cjs/interfaces/{cohortsV2 → cohorts}/ICohort.d.ts +0 -0
  169. /package/dist/cjs/interfaces/{cohortsV2 → cohorts}/ICreateCohortPayload.d.ts +0 -0
  170. /package/dist/cjs/interfaces/{cohortsV2 → cohorts}/IUpdateCohortPayload.d.ts +0 -0
  171. /package/dist/cjs/interfaces/{cohortsV2 → cohorts}/cohortsInterfaces.d.ts +0 -0
  172. /package/dist/cjs/interfaces/{cohortsV2 → cohorts}/index.d.ts +0 -0
  173. /package/dist/{cjs/api/campaign/cohorts/v2 → esm5/api/cohorts}/resultSerializer.d.ts +0 -0
  174. /package/dist/esm5/interfaces/{campaignsV2 → campaigns}/ENotificationChannel.d.ts +0 -0
  175. /package/dist/esm5/interfaces/{campaignsV2 → campaigns}/ICampaign.d.ts +0 -0
  176. /package/dist/esm5/interfaces/{campaignsV2 → campaigns}/ICampaignAction.d.ts +0 -0
  177. /package/dist/esm5/interfaces/{campaignsV2 → campaigns}/ICampaignLocation.d.ts +0 -0
  178. /package/dist/esm5/interfaces/{campaignsV2 → campaigns}/ICampaignRun.d.ts +0 -0
  179. /package/dist/esm5/interfaces/{campaignsV2 → campaigns}/ICampaignStatistics.d.ts +0 -0
  180. /package/dist/esm5/interfaces/{campaignsV2 → campaigns}/IExecuteCampaignResult.d.ts +0 -0
  181. /package/dist/esm5/interfaces/{campaignsV2 → campaigns}/INotificationMedia.d.ts +0 -0
  182. /package/dist/esm5/interfaces/{campaignsV2 → campaigns}/campaignPayloads.d.ts +0 -0
  183. /package/dist/esm5/interfaces/{cohortsV2 → cohorts}/ICohort.d.ts +0 -0
  184. /package/dist/esm5/interfaces/{cohortsV2 → cohorts}/ICreateCohortPayload.d.ts +0 -0
  185. /package/dist/esm5/interfaces/{cohortsV2 → cohorts}/IUpdateCohortPayload.d.ts +0 -0
  186. /package/dist/esm5/interfaces/{cohortsV2 → cohorts}/cohortsInterfaces.d.ts +0 -0
  187. /package/dist/esm5/interfaces/{cohortsV2 → cohorts}/index.d.ts +0 -0
@@ -1,2 +0,0 @@
1
- import type { IDeleteTemplateFromCampaign } from '../../../interfaces/campaigns';
2
- export declare const deleteTemplateFromCampaign: IDeleteTemplateFromCampaign;
@@ -1,2 +0,0 @@
1
- import type { IGetMyTemplates } from '../../../interfaces/campaigns';
2
- export declare const getMyTemplates: IGetMyTemplates;
@@ -1,2 +0,0 @@
1
- import type { IGetTemplateById } from '../../../interfaces/campaigns';
2
- export declare const getTemplateById: IGetTemplateById;
@@ -1 +0,0 @@
1
- export declare const getTemplateResultSerializer: () => any;
@@ -1,2 +0,0 @@
1
- import type { ISetTemplateToCampaign } from '../../../interfaces/campaigns';
2
- export declare const setTemplateToCampaign: ISetTemplateToCampaign;
@@ -1,2 +0,0 @@
1
- import type { ISetTemplatesToCampaign } from '../../../interfaces/campaigns';
2
- export declare const setTemplatesToCampaign: ISetTemplatesToCampaign;
@@ -1,2 +0,0 @@
1
- import { IUpdateEmailTemplate } from '../../../interfaces/campaigns';
2
- export declare const updateEmailTemplate: IUpdateEmailTemplate;
@@ -1,2 +0,0 @@
1
- import { IUpdatePassPushTemplate } from '../../../interfaces/campaigns';
2
- export declare const updatePassPushTemplate: IUpdatePassPushTemplate;
@@ -1,2 +0,0 @@
1
- import { IUpdateSMSTemplate } from '../../../interfaces/campaigns';
2
- export declare const updateSMSTemplate: IUpdateSMSTemplate;
@@ -1,2 +0,0 @@
1
- import { IUpdateWebPushTemplate } from '../../../interfaces/campaigns';
2
- export declare const updateWebPushTemplate: IUpdateWebPushTemplate;
@@ -1,2 +0,0 @@
1
- import type { IAddActionToCampaign } from '../../../../interfaces/campaignsV2/campaignInterfaces';
2
- export declare const addActionToCampaign: IAddActionToCampaign;
@@ -1,2 +0,0 @@
1
- import type { IDeleteActionFromCampaign } from '../../../../interfaces/campaignsV2/campaignInterfaces';
2
- export declare const deleteActionFromCampaign: IDeleteActionFromCampaign;
@@ -1,2 +0,0 @@
1
- import type { IUpdateCampaignAction } from '../../../../interfaces/campaignsV2/campaignInterfaces';
2
- export declare const updateCampaignAction: IUpdateCampaignAction;
@@ -1 +0,0 @@
1
- export declare const getCampaignResultSerializer: () => any;
@@ -1,2 +0,0 @@
1
- import type { ICreateCampaign } from '../../../interfaces/campaignsV2/campaignInterfaces';
2
- export declare const createCampaign: ICreateCampaign;
@@ -1,2 +0,0 @@
1
- import type { IDeleteCampaign } from '../../../interfaces/campaignsV2/campaignInterfaces';
2
- export declare const deleteCampaign: IDeleteCampaign;
@@ -1,2 +0,0 @@
1
- import type { IGetCampaignById } from '../../../interfaces/campaignsV2/campaignInterfaces';
2
- export declare const getCampaignById: IGetCampaignById;
@@ -1,2 +0,0 @@
1
- import type { IGetCampaignStatistics } from '../../../interfaces/campaignsV2/campaignInterfaces';
2
- export declare const getCampaignStatistics: IGetCampaignStatistics;
@@ -1,2 +0,0 @@
1
- import type { IActivateCampaign } from '../../../../interfaces/campaignsV2/campaignInterfaces';
2
- export declare const activateCampaign: IActivateCampaign;
@@ -1,2 +0,0 @@
1
- import type { ICancelCampaign } from '../../../../interfaces/campaignsV2/campaignInterfaces';
2
- export declare const cancelCampaign: ICancelCampaign;
@@ -1,2 +0,0 @@
1
- import type { ICompleteCampaign } from '../../../../interfaces/campaignsV2/campaignInterfaces';
2
- export declare const completeCampaign: ICompleteCampaign;
@@ -1,2 +0,0 @@
1
- import type { IExecuteCampaign } from '../../../../interfaces/campaignsV2/campaignInterfaces';
2
- export declare const executeCampaign: IExecuteCampaign;
@@ -1,2 +0,0 @@
1
- import type { IPauseCampaign } from '../../../../interfaces/campaignsV2/campaignInterfaces';
2
- export declare const pauseCampaign: IPauseCampaign;
@@ -1,2 +0,0 @@
1
- import type { IResumeCampaign } from '../../../../interfaces/campaignsV2/campaignInterfaces';
2
- export declare const resumeCampaign: IResumeCampaign;
@@ -1,2 +0,0 @@
1
- import type { IListCampaigns } from '../../../interfaces/campaignsV2/campaignInterfaces';
2
- export declare const listCampaigns: IListCampaigns;
@@ -1,2 +0,0 @@
1
- import type { IUpdateCampaignDates } from '../../../interfaces/campaignsV2/campaignInterfaces';
2
- export declare const updateCampaignDates: IUpdateCampaignDates;
@@ -1,2 +0,0 @@
1
- import type { IUpdateCampaign } from '../../../interfaces/campaignsV2/campaignInterfaces';
2
- export declare const updateCampaignInfo: IUpdateCampaign;
@@ -1,2 +0,0 @@
1
- import type { IUpdateCampaignLocations } from '../../../interfaces/campaignsV2/campaignInterfaces';
2
- export declare const updateCampaignLocations: IUpdateCampaignLocations;
@@ -1,13 +0,0 @@
1
- import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
2
- import { ICampaign, ICampaignCohort } from './common';
3
- export interface ISetCohortToCampaignPayload {
4
- campaignId: string;
5
- cohortId: string;
6
- }
7
- export interface ISetCohortToCampaign {
8
- (payload: ISetCohortToCampaignPayload): Promise<ICampaign>;
9
- }
10
- export declare type CohortsResponseDTO = I_JSON_API_Response_Many<ICampaignCohort>;
11
- export interface IGetMyCohorts {
12
- (): Promise<ICampaignCohort[]>;
13
- }
@@ -1,74 +0,0 @@
1
- export declare type ISO8601Date = string;
2
- export declare enum ECampaignChannel {
3
- Email = "email",
4
- Sms = "sms",
5
- Telegram = "telegram",
6
- WebPush = "webPush",
7
- PassPush = "passPush"
8
- }
9
- export interface ICampaignChannelData {
10
- email?: string;
11
- sms?: string;
12
- webPush?: string;
13
- passPush?: string;
14
- }
15
- export interface IUsersOperatingSystemsData {
16
- android?: string;
17
- ios?: string;
18
- undefined?: string;
19
- }
20
- export interface ICampaignRun {
21
- id: string;
22
- count_of_users_to_send: number;
23
- created_at: ISO8601Date;
24
- failed: ICampaignChannelData | null;
25
- planned: ICampaignChannelData | null;
26
- run_at: ISO8601Date;
27
- state: 'planned' | 'failed' | 'waitingStats' | 'completed';
28
- success: ICampaignChannelData | null;
29
- os: IUsersOperatingSystemsData | null;
30
- }
31
- export interface ICampaignCohort {
32
- id: string;
33
- count_of_users: number;
34
- external_id: string;
35
- last_updated: ISO8601Date;
36
- name: string;
37
- }
38
- export declare type ICampaignSMSAttributes = {
39
- msg: string;
40
- };
41
- export declare type ICampaignEmailAttributes = {
42
- html: string;
43
- subject: string;
44
- text: string;
45
- };
46
- export declare type ICampaignPassPushAttributes = {
47
- msg: string;
48
- title: string;
49
- };
50
- export declare type ICampaignWebPushAttributes = {
51
- msg: string;
52
- title: string;
53
- };
54
- export declare type ICampaignAnyAttributes = ICampaignSMSAttributes | ICampaignEmailAttributes | ICampaignPassPushAttributes | ICampaignWebPushAttributes;
55
- export interface ICampaignTemplate<R = ICampaignAnyAttributes> {
56
- id: string;
57
- channel: ECampaignChannel;
58
- defaultVars: Record<string, string>;
59
- event: 'campaign';
60
- name: string;
61
- requiredVar: string[];
62
- template: R;
63
- }
64
- export interface ICampaign {
65
- id: string;
66
- name: string;
67
- startAt?: number;
68
- stopAt?: number;
69
- postPlanned?: number;
70
- campaign_run?: ICampaignRun[];
71
- cohort?: ICampaignCohort[];
72
- template?: ICampaignTemplate[];
73
- created_at?: ISO8601Date;
74
- }
@@ -1,96 +0,0 @@
1
- import { IHTTPClientResponse } from '@roketus/web-toolkit';
2
- import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
3
- import { CampaignResponseDTO } from './campaignInterfaces';
4
- import { ICampaignTemplate } from './common';
5
- export declare type TemplateResponseDTO = I_JSON_API_Response_Many<ICampaignTemplate>;
6
- export interface ISetTemplateToCampaign {
7
- (payload: {
8
- campaignId: string;
9
- templateId: string;
10
- }): Promise<IHTTPClientResponse<CampaignResponseDTO>>;
11
- }
12
- export interface ISetTemplatesToCampaign {
13
- (payload: {
14
- campaignId: string;
15
- templateIds: string[];
16
- }): Promise<IHTTPClientResponse<CampaignResponseDTO>>;
17
- }
18
- export interface IDeleteTemplateFromCampaign {
19
- (payload: {
20
- campaignId: string;
21
- templateId: string;
22
- }): Promise<IHTTPClientResponse<CampaignResponseDTO>>;
23
- }
24
- export interface IDeleteTemplate {
25
- (payload: {
26
- templateId: string;
27
- }): Promise<IHTTPClientResponse<void>>;
28
- }
29
- export interface ICreateSMSTemplate {
30
- (payload: {
31
- name: string;
32
- message: string;
33
- }): Promise<IHTTPClientResponse<TemplateResponseDTO>>;
34
- }
35
- export interface ICreateWebPushTemplate {
36
- (payload: {
37
- name: string;
38
- title: string;
39
- message: string;
40
- }): Promise<IHTTPClientResponse<TemplateResponseDTO>>;
41
- }
42
- export interface ICreatePassPushTemplate {
43
- (payload: {
44
- name: string;
45
- title: string;
46
- message: string;
47
- }): Promise<IHTTPClientResponse<TemplateResponseDTO>>;
48
- }
49
- export interface ICreateEmailTemplate {
50
- (payload: {
51
- name: string;
52
- text: string;
53
- subject: string;
54
- body: string;
55
- }): Promise<IHTTPClientResponse<TemplateResponseDTO>>;
56
- }
57
- export interface IGetMyTemplates {
58
- (): Promise<ICampaignTemplate[]>;
59
- }
60
- export interface IGetTemplateById {
61
- (payload: {
62
- templateId: string;
63
- }): Promise<ICampaignTemplate>;
64
- }
65
- export interface IUpdateEmailTemplate {
66
- (payload: {
67
- templateId: string;
68
- name: string;
69
- subject: string;
70
- body: string;
71
- text: string;
72
- }): Promise<IHTTPClientResponse<void>>;
73
- }
74
- export interface IUpdateSMSTemplate {
75
- (payload: {
76
- templateId: string;
77
- name: string;
78
- message: string;
79
- }): Promise<IHTTPClientResponse<void>>;
80
- }
81
- export interface IUpdateWebPushTemplate {
82
- (payload: {
83
- templateId: string;
84
- name: string;
85
- message: string;
86
- title: string;
87
- }): Promise<IHTTPClientResponse<void>>;
88
- }
89
- export interface IUpdatePassPushTemplate {
90
- (payload: {
91
- templateId: string;
92
- name: string;
93
- message: string;
94
- title: string;
95
- }): Promise<IHTTPClientResponse<void>>;
96
- }
@@ -1,69 +0,0 @@
1
- import { IHTTPClientResponse } from '@roketus/web-toolkit';
2
- import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
3
- import { IListFiltersPayload, IPaginationData } from '../requestFilterInterfaces';
4
- import { ICampaign } from './ICampaign';
5
- import { TCampaignAction } from './ICampaignAction';
6
- import { ICampaignCohort } from './ICampaignCohort';
7
- import { ICampaignLocation } from './ICampaignLocation';
8
- import { ICampaignRun } from './ICampaignRun';
9
- import { ICreateCampaignPayload, IUpdateCampaignDatesPayload, IUpdateCampaignLocationsPayload, IUpdateCampaignPayload, IUpdateCampaignActionPayload, TCampaignActionPayload, IExecuteCampaignPayload } from './campaignPayloads';
10
- import { ICampaignActionResult, IExecuteCampaignResponse } from './IExecuteCampaignResult';
11
- import { ICampaignStatistics } from './ICampaignStatistics';
12
- export declare type CampaignResponseDTO = I_JSON_API_Response_Many<ICampaign, ICampaignCohort | TCampaignAction | ICampaignRun | ICampaignLocation>;
13
- export interface IListCampaignsResponse {
14
- data: ICampaign[];
15
- meta: IPaginationData;
16
- }
17
- export interface ICreateCampaign {
18
- (payload: ICreateCampaignPayload): Promise<ICampaign>;
19
- }
20
- export interface IUpdateCampaign {
21
- (id: string, payload: IUpdateCampaignPayload): Promise<ICampaign>;
22
- }
23
- export interface IUpdateCampaignDates {
24
- (id: string, payload: IUpdateCampaignDatesPayload): Promise<ICampaign>;
25
- }
26
- export interface IUpdateCampaignLocations {
27
- (id: string, payload: IUpdateCampaignLocationsPayload): Promise<ICampaign>;
28
- }
29
- export interface IGetCampaignById {
30
- (id: string): Promise<ICampaign>;
31
- }
32
- export interface IListCampaigns {
33
- (params: IListFiltersPayload): Promise<IListCampaignsResponse>;
34
- }
35
- export interface IDeleteCampaign {
36
- (id: string): Promise<IHTTPClientResponse<void>>;
37
- }
38
- export interface IAddActionToCampaign {
39
- (id: string, payload: TCampaignActionPayload): Promise<void>;
40
- }
41
- export interface IUpdateCampaignAction {
42
- (id: string, actionId: string, payload: IUpdateCampaignActionPayload): Promise<void>;
43
- }
44
- export interface IDeleteActionFromCampaign {
45
- (id: string, actionId: string): Promise<IHTTPClientResponse<void>>;
46
- }
47
- export interface IActivateCampaign {
48
- (id: string): Promise<IHTTPClientResponse<void>>;
49
- }
50
- export interface IPauseCampaign {
51
- (id: string): Promise<IHTTPClientResponse<void>>;
52
- }
53
- export interface IResumeCampaign {
54
- (id: string): Promise<IHTTPClientResponse<void>>;
55
- }
56
- export interface ICompleteCampaign {
57
- (id: string): Promise<IHTTPClientResponse<void>>;
58
- }
59
- export interface ICancelCampaign {
60
- (id: string): Promise<IHTTPClientResponse<void>>;
61
- }
62
- export declare type IExecuteCampaignResponseDTO = I_JSON_API_Response_Many<IExecuteCampaignResponse, ICampaignActionResult>;
63
- export interface IExecuteCampaign {
64
- (id: string, payload: IExecuteCampaignPayload): Promise<IExecuteCampaignResponse>;
65
- }
66
- export declare type IGetCampaignStatisticsResponseDTO = I_JSON_API_Response_Many<ICampaignStatistics>;
67
- export interface IGetCampaignStatistics {
68
- (id: string): Promise<ICampaignStatistics>;
69
- }
@@ -1,10 +0,0 @@
1
- export { ICampaign as ICampaignV2, ECampaignType, ECampaignExecutionMode, ECampaignStatus } from './ICampaign';
2
- export * from './ICampaignAction';
3
- export { ICampaignCohort as ICampaignCohortV2 } from './ICampaignCohort';
4
- export * from './ICampaignLocation';
5
- export { ICampaignRun as ICampaignRunV2 } from './ICampaignRun';
6
- export * from './ENotificationChannel';
7
- export { ICreateCampaignPayload as ICreateCampaignPayloadV2, IUpdateCampaignPayload, IUpdateCampaignDatesPayload, IUpdateCampaignLocationsPayload, TCampaignActionPayload, IUpdateCampaignActionPayload, IBonusAccrualActionPayload, INotificationActionPayload, IPromoCodeActionPayload, IExecuteCampaignPayload, } from './campaignPayloads';
8
- export * from './ICampaignStatistics';
9
- export * from './IExecuteCampaignResult';
10
- export * from './INotificationMedia';