@roketus/loyalty-js-sdk 4.36.0 → 4.37.1

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 (87) hide show
  1. package/dist/cjs/api/campaign/campaignResultSerializer.d.ts +1 -0
  2. package/dist/cjs/api/campaign/cohorts/getMyCohorts.d.ts +2 -0
  3. package/dist/cjs/api/campaign/cohorts/resultSerializer.d.ts +1 -0
  4. package/dist/cjs/api/campaign/cohorts/setCohortToCampaign.d.ts +2 -0
  5. package/dist/cjs/api/campaign/getMyCampaigns.d.ts +2 -0
  6. package/dist/cjs/api/campaign/{createEmailTemplate.d.ts → templates/createEmailTemplate.d.ts} +1 -1
  7. package/dist/{esm5/api/campaign → cjs/api/campaign/templates}/createPassPushTemplate.d.ts +1 -1
  8. package/dist/{esm5/api/campaign → cjs/api/campaign/templates}/createSMSTemplate.d.ts +1 -1
  9. package/dist/{esm5/api/campaign → cjs/api/campaign/templates}/createWebPushTemplate.d.ts +1 -1
  10. package/dist/cjs/api/campaign/templates/deleteTemplate.d.ts +2 -0
  11. package/dist/cjs/api/campaign/templates/deleteTemplateFromCampaign.d.ts +2 -0
  12. package/dist/cjs/api/campaign/templates/getMyTemplates.d.ts +2 -0
  13. package/dist/cjs/api/campaign/templates/getTemplateById.d.ts +2 -0
  14. package/dist/cjs/api/campaign/templates/resultSerializer.d.ts +1 -0
  15. package/dist/cjs/api/campaign/templates/setTemplateToCampaign.d.ts +2 -0
  16. package/dist/cjs/api/campaign/templates/setTemplatesToCampaign.d.ts +2 -0
  17. package/dist/cjs/api/campaign/templates/updateEmailTemplate.d.ts +2 -0
  18. package/dist/cjs/api/campaign/templates/updatePassPushTemplate.d.ts +2 -0
  19. package/dist/cjs/api/campaign/templates/updateSMSTemplate.d.ts +2 -0
  20. package/dist/cjs/api/campaign/templates/updateWebPushTemplate.d.ts +2 -0
  21. package/dist/cjs/index.d.ts +1 -10
  22. package/dist/cjs/index.js +1 -1
  23. package/dist/cjs/interfaces/ISDK.d.ts +2 -2
  24. package/dist/cjs/interfaces/campaigns/campaignInterfaces.d.ts +22 -164
  25. package/dist/cjs/interfaces/campaigns/cohortsInterfaces.d.ts +13 -0
  26. package/dist/cjs/interfaces/campaigns/common.d.ts +16 -16
  27. package/dist/cjs/interfaces/campaigns/index.d.ts +2 -2
  28. package/dist/cjs/interfaces/campaigns/templatesInterfaces.d.ts +96 -0
  29. package/dist/esm5/api/campaign/campaignResultSerializer.d.ts +1 -0
  30. package/dist/esm5/api/campaign/cohorts/getMyCohorts.d.ts +2 -0
  31. package/dist/esm5/api/campaign/cohorts/resultSerializer.d.ts +1 -0
  32. package/dist/esm5/api/campaign/cohorts/setCohortToCampaign.d.ts +2 -0
  33. package/dist/esm5/api/campaign/getMyCampaigns.d.ts +2 -0
  34. package/dist/esm5/api/campaign/{createEmailTemplate.d.ts → templates/createEmailTemplate.d.ts} +1 -1
  35. package/dist/{cjs/api/campaign → esm5/api/campaign/templates}/createPassPushTemplate.d.ts +1 -1
  36. package/dist/{cjs/api/campaign → esm5/api/campaign/templates}/createSMSTemplate.d.ts +1 -1
  37. package/dist/{cjs/api/campaign → esm5/api/campaign/templates}/createWebPushTemplate.d.ts +1 -1
  38. package/dist/esm5/api/campaign/templates/deleteTemplate.d.ts +2 -0
  39. package/dist/esm5/api/campaign/templates/deleteTemplateFromCampaign.d.ts +2 -0
  40. package/dist/esm5/api/campaign/templates/getMyTemplates.d.ts +2 -0
  41. package/dist/esm5/api/campaign/templates/getTemplateById.d.ts +2 -0
  42. package/dist/esm5/api/campaign/templates/resultSerializer.d.ts +1 -0
  43. package/dist/esm5/api/campaign/templates/setTemplateToCampaign.d.ts +2 -0
  44. package/dist/esm5/api/campaign/templates/setTemplatesToCampaign.d.ts +2 -0
  45. package/dist/esm5/api/campaign/templates/updateEmailTemplate.d.ts +2 -0
  46. package/dist/esm5/api/campaign/templates/updatePassPushTemplate.d.ts +2 -0
  47. package/dist/esm5/api/campaign/templates/updateSMSTemplate.d.ts +2 -0
  48. package/dist/esm5/api/campaign/templates/updateWebPushTemplate.d.ts +2 -0
  49. package/dist/esm5/index.d.ts +1 -10
  50. package/dist/esm5/index.js +1 -1
  51. package/dist/esm5/interfaces/ISDK.d.ts +2 -2
  52. package/dist/esm5/interfaces/campaigns/campaignInterfaces.d.ts +22 -164
  53. package/dist/esm5/interfaces/campaigns/cohortsInterfaces.d.ts +13 -0
  54. package/dist/esm5/interfaces/campaigns/common.d.ts +16 -16
  55. package/dist/esm5/interfaces/campaigns/index.d.ts +2 -2
  56. package/dist/esm5/interfaces/campaigns/templatesInterfaces.d.ts +96 -0
  57. package/package.json +1 -1
  58. package/dist/cjs/api/campaign/deleteTemplate.d.ts +0 -2
  59. package/dist/cjs/api/campaign/deleteTemplateFromCampaign.d.ts +0 -2
  60. package/dist/cjs/api/campaign/getMyCampaign.d.ts +0 -2
  61. package/dist/cjs/api/campaign/getMyCohorts.d.ts +0 -2
  62. package/dist/cjs/api/campaign/getMyTemplates.d.ts +0 -2
  63. package/dist/cjs/api/campaign/getTemplateById.d.ts +0 -2
  64. package/dist/cjs/api/campaign/setCohortToCampaign.d.ts +0 -2
  65. package/dist/cjs/api/campaign/setTemplateToCampaign.d.ts +0 -2
  66. package/dist/cjs/api/campaign/setTemplatesToCampaign.d.ts +0 -2
  67. package/dist/cjs/api/campaign/updateEmailTemplate.d.ts +0 -2
  68. package/dist/cjs/api/campaign/updatePassPushTemplate.d.ts +0 -2
  69. package/dist/cjs/api/campaign/updateSMSTemplate.d.ts +0 -2
  70. package/dist/cjs/api/campaign/updateWebPushTemplate.d.ts +0 -2
  71. package/dist/cjs/interfaces/campaigns/getByID.d.ts +0 -9
  72. package/dist/cjs/interfaces/campaigns/getMyCampaigns.d.ts +0 -8
  73. package/dist/esm5/api/campaign/deleteTemplate.d.ts +0 -2
  74. package/dist/esm5/api/campaign/deleteTemplateFromCampaign.d.ts +0 -2
  75. package/dist/esm5/api/campaign/getMyCampaign.d.ts +0 -2
  76. package/dist/esm5/api/campaign/getMyCohorts.d.ts +0 -2
  77. package/dist/esm5/api/campaign/getMyTemplates.d.ts +0 -2
  78. package/dist/esm5/api/campaign/getTemplateById.d.ts +0 -2
  79. package/dist/esm5/api/campaign/setCohortToCampaign.d.ts +0 -2
  80. package/dist/esm5/api/campaign/setTemplateToCampaign.d.ts +0 -2
  81. package/dist/esm5/api/campaign/setTemplatesToCampaign.d.ts +0 -2
  82. package/dist/esm5/api/campaign/updateEmailTemplate.d.ts +0 -2
  83. package/dist/esm5/api/campaign/updatePassPushTemplate.d.ts +0 -2
  84. package/dist/esm5/api/campaign/updateSMSTemplate.d.ts +0 -2
  85. package/dist/esm5/api/campaign/updateWebPushTemplate.d.ts +0 -2
  86. package/dist/esm5/interfaces/campaigns/getByID.d.ts +0 -9
  87. package/dist/esm5/interfaces/campaigns/getMyCampaigns.d.ts +0 -8
@@ -1,5 +1,11 @@
1
1
  export declare type ISO8601Date = string;
2
- export declare type ICampaignChannel = 'email' | 'sms' | 'webPush' | 'passPush';
2
+ export declare enum ECampaignChannel {
3
+ Email = "email",
4
+ Sms = "sms",
5
+ Telegram = "telegram",
6
+ WebPush = "webPush",
7
+ PassPush = "passPush"
8
+ }
3
9
  export interface ICampaignChannelData {
4
10
  email?: string;
5
11
  sms?: string;
@@ -48,27 +54,21 @@ export declare type ICampaignWebPushAttributes = {
48
54
  export declare type ICampaignAnyAttributes = ICampaignSMSAttributes | ICampaignEmailAttributes | ICampaignPassPushAttributes | ICampaignWebPushAttributes;
49
55
  export interface ICampaignTemplate<R = ICampaignAnyAttributes> {
50
56
  id: string;
51
- channel: ICampaignChannel;
57
+ channel: ECampaignChannel;
52
58
  defaultVars: Record<string, string>;
53
59
  event: 'campaign';
54
60
  name: string;
55
61
  requiredVar: string[];
56
62
  template: R;
57
63
  }
58
- export interface ICampaignJSONAPIDTO {
59
- id: string;
60
- type: 'campaign';
61
- attributes: {
62
- created_at: number;
63
- name: string;
64
- };
65
- relationships: Record<string, unknown>;
66
- }
67
- export interface CampaignByID {
64
+ export interface ICampaign {
68
65
  id: string;
69
- created_at: ISO8601Date;
70
66
  name: string;
71
- campaign_run: ICampaignRun[];
72
- cohort: ICampaignCohort[];
73
- template: ICampaignTemplate[];
67
+ startAt?: number;
68
+ stopAt?: number;
69
+ postPlanned?: number;
70
+ campaign_run?: ICampaignRun[];
71
+ cohort?: ICampaignCohort[];
72
+ template?: ICampaignTemplate[];
73
+ created_at?: ISO8601Date;
74
74
  }
@@ -1,4 +1,4 @@
1
1
  export * from './common';
2
- export * from './getByID';
3
2
  export * from './campaignInterfaces';
4
- export * from './getMyCampaigns';
3
+ export * from './cohortsInterfaces';
4
+ export * from './templatesInterfaces';
@@ -0,0 +1,96 @@
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
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@roketus/loyalty-js-sdk",
3
- "version": "4.36.0",
3
+ "version": "4.37.1",
4
4
  "main": "./dist/cjs/index.js",
5
5
  "module": "./dist/esm5/index.js",
6
6
  "author": "Skoch <st.ixidor@gmail.com>",
@@ -1,2 +0,0 @@
1
- import type { IDeleteTemplate } from '../../interfaces/campaigns';
2
- export declare const deleteTemplate: IDeleteTemplate;
@@ -1,2 +0,0 @@
1
- import type { IDeleteTemplateFromCampaign } from '../../interfaces/campaigns';
2
- export declare const deleteTemplateFromCampaign: IDeleteTemplateFromCampaign;
@@ -1,2 +0,0 @@
1
- import { IGetMyCampaign } from '../../interfaces/campaigns';
2
- export declare const getMyCampaign: IGetMyCampaign;
@@ -1,2 +0,0 @@
1
- import type { IGetMyCohorts } from '../../interfaces/campaigns';
2
- export declare const getMyCohorts: IGetMyCohorts;
@@ -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,2 +0,0 @@
1
- import type { ISetCohortToCampaign } from '../../interfaces/campaigns';
2
- export declare const setCohortToCampaign: ISetCohortToCampaign;
@@ -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,9 +0,0 @@
1
- import { IRequestWithCancelAndData } from '../IRequestWithCancelAndData';
2
- import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
3
- import { CampaignByID } from './common';
4
- export interface IGetCampaignById {
5
- ({ campaignId }: {
6
- campaignId: string;
7
- }): IRequestWithCancelAndData<GetCampaignByIdResponseDTO, I_JSON_API_Response_Many>;
8
- }
9
- export declare type GetCampaignByIdResponseDTO = CampaignByID[];
@@ -1,8 +0,0 @@
1
- import { ICampaignCohortDTO, ICampaignTemplateDTO } from './campaignInterfaces';
2
- import { CampaignByID, ICampaignJSONAPIDTO } from './common';
3
- import { IRequestWithCancelAndData } from '../IRequestWithCancelAndData';
4
- import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
5
- export interface IGetMyCampaign {
6
- (): IRequestWithCancelAndData<GetMyCampaignsResponseDTO, I_JSON_API_Response_Many<ICampaignJSONAPIDTO, ICampaignCohortDTO | ICampaignTemplateDTO>>;
7
- }
8
- export declare type GetMyCampaignsResponseDTO = CampaignByID[];
@@ -1,2 +0,0 @@
1
- import type { IDeleteTemplate } from '../../interfaces/campaigns';
2
- export declare const deleteTemplate: IDeleteTemplate;
@@ -1,2 +0,0 @@
1
- import type { IDeleteTemplateFromCampaign } from '../../interfaces/campaigns';
2
- export declare const deleteTemplateFromCampaign: IDeleteTemplateFromCampaign;
@@ -1,2 +0,0 @@
1
- import { IGetMyCampaign } from '../../interfaces/campaigns';
2
- export declare const getMyCampaign: IGetMyCampaign;
@@ -1,2 +0,0 @@
1
- import type { IGetMyCohorts } from '../../interfaces/campaigns';
2
- export declare const getMyCohorts: IGetMyCohorts;
@@ -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,2 +0,0 @@
1
- import type { ISetCohortToCampaign } from '../../interfaces/campaigns';
2
- export declare const setCohortToCampaign: ISetCohortToCampaign;
@@ -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,9 +0,0 @@
1
- import { IRequestWithCancelAndData } from '../IRequestWithCancelAndData';
2
- import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
3
- import { CampaignByID } from './common';
4
- export interface IGetCampaignById {
5
- ({ campaignId }: {
6
- campaignId: string;
7
- }): IRequestWithCancelAndData<GetCampaignByIdResponseDTO, I_JSON_API_Response_Many>;
8
- }
9
- export declare type GetCampaignByIdResponseDTO = CampaignByID[];
@@ -1,8 +0,0 @@
1
- import { ICampaignCohortDTO, ICampaignTemplateDTO } from './campaignInterfaces';
2
- import { CampaignByID, ICampaignJSONAPIDTO } from './common';
3
- import { IRequestWithCancelAndData } from '../IRequestWithCancelAndData';
4
- import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
5
- export interface IGetMyCampaign {
6
- (): IRequestWithCancelAndData<GetMyCampaignsResponseDTO, I_JSON_API_Response_Many<ICampaignJSONAPIDTO, ICampaignCohortDTO | ICampaignTemplateDTO>>;
7
- }
8
- export declare type GetMyCampaignsResponseDTO = CampaignByID[];