@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.
- package/dist/cjs/api/campaign/campaignResultSerializer.d.ts +1 -0
- package/dist/cjs/api/campaign/cohorts/getMyCohorts.d.ts +2 -0
- package/dist/cjs/api/campaign/cohorts/resultSerializer.d.ts +1 -0
- package/dist/cjs/api/campaign/cohorts/setCohortToCampaign.d.ts +2 -0
- package/dist/cjs/api/campaign/getMyCampaigns.d.ts +2 -0
- package/dist/cjs/api/campaign/{createEmailTemplate.d.ts → templates/createEmailTemplate.d.ts} +1 -1
- package/dist/{esm5/api/campaign → cjs/api/campaign/templates}/createPassPushTemplate.d.ts +1 -1
- package/dist/{esm5/api/campaign → cjs/api/campaign/templates}/createSMSTemplate.d.ts +1 -1
- package/dist/{esm5/api/campaign → cjs/api/campaign/templates}/createWebPushTemplate.d.ts +1 -1
- package/dist/cjs/api/campaign/templates/deleteTemplate.d.ts +2 -0
- package/dist/cjs/api/campaign/templates/deleteTemplateFromCampaign.d.ts +2 -0
- package/dist/cjs/api/campaign/templates/getMyTemplates.d.ts +2 -0
- package/dist/cjs/api/campaign/templates/getTemplateById.d.ts +2 -0
- package/dist/cjs/api/campaign/templates/resultSerializer.d.ts +1 -0
- package/dist/cjs/api/campaign/templates/setTemplateToCampaign.d.ts +2 -0
- package/dist/cjs/api/campaign/templates/setTemplatesToCampaign.d.ts +2 -0
- package/dist/cjs/api/campaign/templates/updateEmailTemplate.d.ts +2 -0
- package/dist/cjs/api/campaign/templates/updatePassPushTemplate.d.ts +2 -0
- package/dist/cjs/api/campaign/templates/updateSMSTemplate.d.ts +2 -0
- package/dist/cjs/api/campaign/templates/updateWebPushTemplate.d.ts +2 -0
- package/dist/cjs/index.d.ts +1 -10
- package/dist/cjs/index.js +1 -1
- package/dist/cjs/interfaces/ISDK.d.ts +2 -2
- package/dist/cjs/interfaces/campaigns/campaignInterfaces.d.ts +22 -164
- package/dist/cjs/interfaces/campaigns/cohortsInterfaces.d.ts +13 -0
- package/dist/cjs/interfaces/campaigns/common.d.ts +16 -16
- package/dist/cjs/interfaces/campaigns/index.d.ts +2 -2
- package/dist/cjs/interfaces/campaigns/templatesInterfaces.d.ts +96 -0
- package/dist/esm5/api/campaign/campaignResultSerializer.d.ts +1 -0
- package/dist/esm5/api/campaign/cohorts/getMyCohorts.d.ts +2 -0
- package/dist/esm5/api/campaign/cohorts/resultSerializer.d.ts +1 -0
- package/dist/esm5/api/campaign/cohorts/setCohortToCampaign.d.ts +2 -0
- package/dist/esm5/api/campaign/getMyCampaigns.d.ts +2 -0
- package/dist/esm5/api/campaign/{createEmailTemplate.d.ts → templates/createEmailTemplate.d.ts} +1 -1
- package/dist/{cjs/api/campaign → esm5/api/campaign/templates}/createPassPushTemplate.d.ts +1 -1
- package/dist/{cjs/api/campaign → esm5/api/campaign/templates}/createSMSTemplate.d.ts +1 -1
- package/dist/{cjs/api/campaign → esm5/api/campaign/templates}/createWebPushTemplate.d.ts +1 -1
- package/dist/esm5/api/campaign/templates/deleteTemplate.d.ts +2 -0
- package/dist/esm5/api/campaign/templates/deleteTemplateFromCampaign.d.ts +2 -0
- package/dist/esm5/api/campaign/templates/getMyTemplates.d.ts +2 -0
- package/dist/esm5/api/campaign/templates/getTemplateById.d.ts +2 -0
- package/dist/esm5/api/campaign/templates/resultSerializer.d.ts +1 -0
- package/dist/esm5/api/campaign/templates/setTemplateToCampaign.d.ts +2 -0
- package/dist/esm5/api/campaign/templates/setTemplatesToCampaign.d.ts +2 -0
- package/dist/esm5/api/campaign/templates/updateEmailTemplate.d.ts +2 -0
- package/dist/esm5/api/campaign/templates/updatePassPushTemplate.d.ts +2 -0
- package/dist/esm5/api/campaign/templates/updateSMSTemplate.d.ts +2 -0
- package/dist/esm5/api/campaign/templates/updateWebPushTemplate.d.ts +2 -0
- package/dist/esm5/index.d.ts +1 -10
- package/dist/esm5/index.js +1 -1
- package/dist/esm5/interfaces/ISDK.d.ts +2 -2
- package/dist/esm5/interfaces/campaigns/campaignInterfaces.d.ts +22 -164
- package/dist/esm5/interfaces/campaigns/cohortsInterfaces.d.ts +13 -0
- package/dist/esm5/interfaces/campaigns/common.d.ts +16 -16
- package/dist/esm5/interfaces/campaigns/index.d.ts +2 -2
- package/dist/esm5/interfaces/campaigns/templatesInterfaces.d.ts +96 -0
- package/package.json +1 -1
- package/dist/cjs/api/campaign/deleteTemplate.d.ts +0 -2
- package/dist/cjs/api/campaign/deleteTemplateFromCampaign.d.ts +0 -2
- package/dist/cjs/api/campaign/getMyCampaign.d.ts +0 -2
- package/dist/cjs/api/campaign/getMyCohorts.d.ts +0 -2
- package/dist/cjs/api/campaign/getMyTemplates.d.ts +0 -2
- package/dist/cjs/api/campaign/getTemplateById.d.ts +0 -2
- package/dist/cjs/api/campaign/setCohortToCampaign.d.ts +0 -2
- package/dist/cjs/api/campaign/setTemplateToCampaign.d.ts +0 -2
- package/dist/cjs/api/campaign/setTemplatesToCampaign.d.ts +0 -2
- package/dist/cjs/api/campaign/updateEmailTemplate.d.ts +0 -2
- package/dist/cjs/api/campaign/updatePassPushTemplate.d.ts +0 -2
- package/dist/cjs/api/campaign/updateSMSTemplate.d.ts +0 -2
- package/dist/cjs/api/campaign/updateWebPushTemplate.d.ts +0 -2
- package/dist/cjs/interfaces/campaigns/getByID.d.ts +0 -9
- package/dist/cjs/interfaces/campaigns/getMyCampaigns.d.ts +0 -8
- package/dist/esm5/api/campaign/deleteTemplate.d.ts +0 -2
- package/dist/esm5/api/campaign/deleteTemplateFromCampaign.d.ts +0 -2
- package/dist/esm5/api/campaign/getMyCampaign.d.ts +0 -2
- package/dist/esm5/api/campaign/getMyCohorts.d.ts +0 -2
- package/dist/esm5/api/campaign/getMyTemplates.d.ts +0 -2
- package/dist/esm5/api/campaign/getTemplateById.d.ts +0 -2
- package/dist/esm5/api/campaign/setCohortToCampaign.d.ts +0 -2
- package/dist/esm5/api/campaign/setTemplateToCampaign.d.ts +0 -2
- package/dist/esm5/api/campaign/setTemplatesToCampaign.d.ts +0 -2
- package/dist/esm5/api/campaign/updateEmailTemplate.d.ts +0 -2
- package/dist/esm5/api/campaign/updatePassPushTemplate.d.ts +0 -2
- package/dist/esm5/api/campaign/updateSMSTemplate.d.ts +0 -2
- package/dist/esm5/api/campaign/updateWebPushTemplate.d.ts +0 -2
- package/dist/esm5/interfaces/campaigns/getByID.d.ts +0 -9
- package/dist/esm5/interfaces/campaigns/getMyCampaigns.d.ts +0 -8
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
export declare type ISO8601Date = string;
|
|
2
|
-
export declare
|
|
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:
|
|
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
|
|
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
|
-
|
|
72
|
-
|
|
73
|
-
|
|
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
|
}
|
|
@@ -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,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,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[];
|