@roketus/loyalty-js-sdk 4.36.0 → 4.37.0

package/dist/cjs/interfaces/campaigns/campaignInterfaces.d.ts

@@ -1,174 +1,32 @@
 import { IHTTPClientResponse } from '@roketus/web-toolkit';
-import { ICampaignEmailAttributes, ICampaignJSONAPIDTO, ICampaignPassPushAttributes, ICampaignSMSAttributes, ICampaignWebPushAttributes } from './common';
-export interface ICreateCampaign {
-    ({ name }: {
-        name: string;
-    }): Promise<IHTTPClientResponse<CreateCampaignResponseDTO>>;
-}
-export interface ISetCohortToCampaign {
-    ({ campaignId, cohortId }: {
-        campaignId: string;
-        cohortId: string;
-    }): Promise<IHTTPClientResponse<SetCohortToCampaignResponseDTO>>;
-}
-export interface ISetTemplateToCampaign {
-    ({ campaignId, templateId }: {
-        campaignId: string;
-        templateId: string;
-    }): Promise<IHTTPClientResponse<SetTemplateToCampaignResponseDTO>>;
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+import { ICampaign, ICampaignCohort, ICampaignTemplate } from './common';
+import { IListFiltersPayload, IPaginationData } from '../requestFilterInterfaces';
+export declare type CampaignResponseDTO = I_JSON_API_Response_Many<ICampaign, ICampaignCohort | ICampaignTemplate>;
+export interface ICreateCampaignPayload {
+    name: string;
+    startDate?: string;
+    stopDate?: string;
 }
-export interface ISetTemplatesToCampaign {
-    ({ campaignId, templateIds }: {
-        campaignId: string;
-        templateIds: string[];
-    }): Promise<IHTTPClientResponse<SetTemplateToCampaignResponseDTO>>;
+export interface ICreateCampaign {
+    (payload: ICreateCampaignPayload): Promise<ICampaign>;
 }
-export interface IDeleteTemplateFromCampaign {
-    ({ campaignId, templateId }: {
-        campaignId: string;
-        templateId: string;
-    }): Promise<IHTTPClientResponse<DeleteTemplateFromCampaignResponseDTO>>;
+export interface IRunCampaignPayload {
+    campaignId: string;
 }
 export interface IRunCampaign {
-    ({ campaignId }: {
-        campaignId: string;
-    }): Promise<IHTTPClientResponse<void>>;
-}
-export interface IGetMyCohorts {
-    (): Promise<IHTTPClientResponse<GetMyCohortsResponseDTO>>;
-}
-export interface ICreateSMSTemplate {
-    (payload: {
-        name: string;
-        message: string;
-    }): Promise<IHTTPClientResponse<CreateTemplateResponseDTO>>;
-}
-export interface ICreateWebPushTemplate {
-    (payload: {
-        name: string;
-        title: string;
-        message: string;
-    }): Promise<IHTTPClientResponse<CreateTemplateResponseDTO>>;
-}
-export interface ICreatePassPushTemplate {
-    (payload: {
-        name: string;
-        title: string;
-        message: string;
-    }): Promise<IHTTPClientResponse<CreateTemplateResponseDTO>>;
-}
-export interface ICreateEmailTemplate {
-    (payload: {
-        name: string;
-        text: string;
-        subject: string;
-        body: string;
-    }): Promise<IHTTPClientResponse<CreateTemplateResponseDTO>>;
-}
-export interface IGetMyTemplates {
-    (): Promise<IHTTPClientResponse<GetMyTemplatesResponseDTO>>;
-}
-export interface IGetTemplateById {
-    ({ templateId }: {
-        templateId: string;
-    }): Promise<IHTTPClientResponse<GetTemplateByIdResponseDTO>>;
-}
-export interface IUpdateEmailTemplate {
-    (payload: {
-        templateId: string;
-        name: string;
-        subject: string;
-        body: string;
-        text: string;
-    }): Promise<IHTTPClientResponse<void>>;
-}
-export interface IUpdateSMSTemplate {
-    (payload: {
-        templateId: string;
-        name: string;
-        message: string;
-    }): Promise<IHTTPClientResponse<void>>;
-}
-export interface IUpdateWebPushTemplate {
-    (payload: {
-        templateId: string;
-        name: string;
-        message: string;
-        title: string;
-    }): Promise<IHTTPClientResponse<void>>;
-}
-export interface IUpdatePassPushTemplate {
-    (payload: {
-        templateId: string;
-        name: string;
-        message: string;
-        title: string;
-    }): Promise<IHTTPClientResponse<void>>;
-}
-export interface IDeleteTemplate {
-    ({ templateId }: {
-        templateId: string;
-    }): Promise<IHTTPClientResponse<void>>;
-}
-export interface ICampaignCohortDTO {
-    id: string;
-    type: 'cohort';
-    attributes: {
-        count_of_users: number;
-        external_id: string;
-        last_updated: number;
-        name: string;
-    };
-    relationships: Record<string, unknown>;
-}
-interface IBaseCampaignTemplateDTO<R> {
-    id: string;
-    type: 'template';
-    attributes: {
-        channel: string;
-        defaultVars?: Record<string, string>;
-        event: string;
-        name: string;
-        requiredVar?: string[];
-        template: R;
-    };
-    relationships: Record<string, unknown>;
-}
-export declare type ICampaignSMSTemplateDTO = IBaseCampaignTemplateDTO<ICampaignSMSAttributes>;
-export declare type ICampaignEmailTemplateDTO = IBaseCampaignTemplateDTO<ICampaignEmailAttributes>;
-export declare type ICampaignPassPushTemplateDTO = IBaseCampaignTemplateDTO<ICampaignPassPushAttributes>;
-export declare type ICampaignWebPushTemplateDTO = IBaseCampaignTemplateDTO<ICampaignWebPushAttributes>;
-export declare type ICampaignTemplateDTO = ICampaignSMSTemplateDTO | ICampaignEmailTemplateDTO | ICampaignPassPushTemplateDTO | ICampaignWebPushTemplateDTO;
-interface CreateCampaignResponseDTO {
-    data: ICampaignJSONAPIDTO[];
-    included: [];
-}
-interface SetCohortToCampaignResponseDTO {
-    data: ICampaignJSONAPIDTO[];
-    included: ICampaignCohortDTO[];
-}
-interface SetTemplateToCampaignResponseDTO {
-    data: ICampaignJSONAPIDTO[];
-    included: (ICampaignCohortDTO | ICampaignTemplateDTO)[];
-}
-interface DeleteTemplateFromCampaignResponseDTO {
-    data: ICampaignJSONAPIDTO[];
-    included: (ICampaignCohortDTO | ICampaignTemplateDTO)[];
+    (payload: IRunCampaignPayload): Promise<IHTTPClientResponse<void>>;
 }
-interface GetMyCohortsResponseDTO {
-    data: ICampaignCohortDTO[];
-    included: [];
+export interface IGetCampaignPayload {
+    campaignId: string;
 }
-interface CreateTemplateResponseDTO {
-    data: ICampaignTemplateDTO[];
-    included: [];
+export interface IGetCampaignById {
+    (payload: IGetCampaignPayload): Promise<ICampaign>;
 }
-interface GetMyTemplatesResponseDTO {
-    data: ICampaignTemplateDTO[];
-    included: [];
+export interface IListCampaignsResponse {
+    data: ICampaign[];
+    meta: IPaginationData;
 }
-interface GetTemplateByIdResponseDTO {
-    data: ICampaignTemplateDTO[];
-    included: [];
+export interface IGetMyCampaigns {
+    (params: IListFiltersPayload): Promise<IListCampaignsResponse>;
 }
-export {};

package/dist/cjs/interfaces/campaigns/cohortsInterfaces.d.ts

@@ -0,0 +1,13 @@
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+import { ICampaign, ICampaignCohort } from './common';
+export interface ISetCohortToCampaignPayload {
+    campaignId: string;
+    cohortId: string;
+}
+export interface ISetCohortToCampaign {
+    (payload: ISetCohortToCampaignPayload): Promise<ICampaign>;
+}
+export declare type CohortsResponseDTO = I_JSON_API_Response_Many<ICampaignCohort>;
+export interface IGetMyCohorts {
+    (): Promise<ICampaignCohort[]>;
+}

package/dist/cjs/interfaces/campaigns/common.d.ts

@@ -1,5 +1,11 @@
 export declare type ISO8601Date = string;
-export declare type ICampaignChannel = 'email' | 'sms' | 'webPush' | 'passPush';
+export declare enum ECampaignChannel {
+    Email = "email",
+    Sms = "sms",
+    Telegram = "telegram",
+    WebPush = "webPush",
+    PassPush = "passPush"
+}
 export interface ICampaignChannelData {
     email?: string;
     sms?: string;
@@ -48,27 +54,21 @@ export declare type ICampaignWebPushAttributes = {
 export declare type ICampaignAnyAttributes = ICampaignSMSAttributes | ICampaignEmailAttributes | ICampaignPassPushAttributes | ICampaignWebPushAttributes;
 export interface ICampaignTemplate<R = ICampaignAnyAttributes> {
     id: string;
-    channel: ICampaignChannel;
+    channel: ECampaignChannel;
     defaultVars: Record<string, string>;
     event: 'campaign';
     name: string;
     requiredVar: string[];
     template: R;
 }
-export interface ICampaignJSONAPIDTO {
-    id: string;
-    type: 'campaign';
-    attributes: {
-        created_at: number;
-        name: string;
-    };
-    relationships: Record<string, unknown>;
-}
-export interface CampaignByID {
+export interface ICampaign {
     id: string;
-    created_at: ISO8601Date;
     name: string;
-    campaign_run: ICampaignRun[];
-    cohort: ICampaignCohort[];
-    template: ICampaignTemplate[];
+    startAt?: number;
+    stopAt?: number;
+    postPlanned?: number;
+    campaign_run?: ICampaignRun[];
+    cohort?: ICampaignCohort[];
+    template?: ICampaignTemplate[];
+    created_at?: ISO8601Date;
 }

package/dist/cjs/interfaces/campaigns/index.d.ts

@@ -1,4 +1,4 @@
 export * from './common';
-export * from './getByID';
 export * from './campaignInterfaces';
-export * from './getMyCampaigns';
+export * from './cohortsInterfaces';
+export * from './templatesInterfaces';

package/dist/cjs/interfaces/campaigns/templatesInterfaces.d.ts

@@ -0,0 +1,96 @@
+import { IHTTPClientResponse } from '@roketus/web-toolkit';
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+import { CampaignResponseDTO } from './campaignInterfaces';
+import { ICampaignTemplate } from './common';
+export declare type TemplateResponseDTO = I_JSON_API_Response_Many<ICampaignTemplate>;
+export interface ISetTemplateToCampaign {
+    (payload: {
+        campaignId: string;
+        templateId: string;
+    }): Promise<IHTTPClientResponse<CampaignResponseDTO>>;
+}
+export interface ISetTemplatesToCampaign {
+    (payload: {
+        campaignId: string;
+        templateIds: string[];
+    }): Promise<IHTTPClientResponse<CampaignResponseDTO>>;
+}
+export interface IDeleteTemplateFromCampaign {
+    (payload: {
+        campaignId: string;
+        templateId: string;
+    }): Promise<IHTTPClientResponse<CampaignResponseDTO>>;
+}
+export interface IDeleteTemplate {
+    (payload: {
+        templateId: string;
+    }): Promise<IHTTPClientResponse<void>>;
+}
+export interface ICreateSMSTemplate {
+    (payload: {
+        name: string;
+        message: string;
+    }): Promise<IHTTPClientResponse<TemplateResponseDTO>>;
+}
+export interface ICreateWebPushTemplate {
+    (payload: {
+        name: string;
+        title: string;
+        message: string;
+    }): Promise<IHTTPClientResponse<TemplateResponseDTO>>;
+}
+export interface ICreatePassPushTemplate {
+    (payload: {
+        name: string;
+        title: string;
+        message: string;
+    }): Promise<IHTTPClientResponse<TemplateResponseDTO>>;
+}
+export interface ICreateEmailTemplate {
+    (payload: {
+        name: string;
+        text: string;
+        subject: string;
+        body: string;
+    }): Promise<IHTTPClientResponse<TemplateResponseDTO>>;
+}
+export interface IGetMyTemplates {
+    (): Promise<ICampaignTemplate[]>;
+}
+export interface IGetTemplateById {
+    (payload: {
+        templateId: string;
+    }): Promise<ICampaignTemplate>;
+}
+export interface IUpdateEmailTemplate {
+    (payload: {
+        templateId: string;
+        name: string;
+        subject: string;
+        body: string;
+        text: string;
+    }): Promise<IHTTPClientResponse<void>>;
+}
+export interface IUpdateSMSTemplate {
+    (payload: {
+        templateId: string;
+        name: string;
+        message: string;
+    }): Promise<IHTTPClientResponse<void>>;
+}
+export interface IUpdateWebPushTemplate {
+    (payload: {
+        templateId: string;
+        name: string;
+        message: string;
+        title: string;
+    }): Promise<IHTTPClientResponse<void>>;
+}
+export interface IUpdatePassPushTemplate {
+    (payload: {
+        templateId: string;
+        name: string;
+        message: string;
+        title: string;
+    }): Promise<IHTTPClientResponse<void>>;
+}

package/dist/esm5/api/campaign/campaignResultSerializer.d.ts

@@ -0,0 +1 @@
+export declare const getCampaignResultSerializer: () => any;

package/dist/esm5/api/campaign/cohorts/getMyCohorts.d.ts

@@ -0,0 +1,2 @@
+import type { IGetMyCohorts } from '../../../interfaces/campaigns';
+export declare const getMyCohorts: IGetMyCohorts;

package/dist/esm5/api/campaign/cohorts/resultSerializer.d.ts

@@ -0,0 +1 @@
+export declare const getCohortResultSerializer: () => any;

package/dist/esm5/api/campaign/cohorts/setCohortToCampaign.d.ts

@@ -0,0 +1,2 @@
+import type { ISetCohortToCampaign } from '../../../interfaces/campaigns';
+export declare const setCohortToCampaign: ISetCohortToCampaign;

package/dist/esm5/api/campaign/getMyCampaigns.d.ts

@@ -0,0 +1,2 @@
+import { IGetMyCampaigns } from '../../interfaces/campaigns';
+export declare const getMyCampaigns: IGetMyCampaigns;

package/dist/esm5/api/campaign/{createEmailTemplate.d.ts → templates/createEmailTemplate.d.ts}

@@ -1,4 +1,4 @@
-import { ICreateEmailTemplate } from '../../interfaces/campaigns';
+import { ICreateEmailTemplate } from '../../../interfaces/campaigns';
 export interface CreateEmailTemplateRequestDTO {
     data: {
         attributes: {

package/dist/{cjs/api/campaign → esm5/api/campaign/templates}/createPassPushTemplate.d.ts

@@ -1,4 +1,4 @@
-import { ICreatePassPushTemplate } from '../../interfaces/campaigns';
+import { ICreatePassPushTemplate } from '../../../interfaces/campaigns';
 export interface CreatePassPushTemplateRequestDTO {
     data: {
         attributes: {

package/dist/{cjs/api/campaign → esm5/api/campaign/templates}/createSMSTemplate.d.ts

@@ -1,4 +1,4 @@
-import { ICreateSMSTemplate } from '../../interfaces/campaigns';
+import { ICreateSMSTemplate } from '../../../interfaces/campaigns';
 export interface CreateSMSTemplateRequestDTO {
     data: {
         attributes: {

package/dist/{cjs/api/campaign → esm5/api/campaign/templates}/createWebPushTemplate.d.ts

@@ -1,4 +1,4 @@
-import { ICreateWebPushTemplate } from '../../interfaces/campaigns';
+import { ICreateWebPushTemplate } from '../../../interfaces/campaigns';
 export interface CreateWebPushTemplateRequestDTO {
     data: {
         attributes: {

package/dist/esm5/api/campaign/templates/deleteTemplate.d.ts

@@ -0,0 +1,2 @@
+import type { IDeleteTemplate } from '../../../interfaces/campaigns';
+export declare const deleteTemplate: IDeleteTemplate;

package/dist/esm5/api/campaign/templates/deleteTemplateFromCampaign.d.ts

@@ -0,0 +1,2 @@
+import type { IDeleteTemplateFromCampaign } from '../../../interfaces/campaigns';
+export declare const deleteTemplateFromCampaign: IDeleteTemplateFromCampaign;

package/dist/esm5/api/campaign/templates/getMyTemplates.d.ts

@@ -0,0 +1,2 @@
+import type { IGetMyTemplates } from '../../../interfaces/campaigns';
+export declare const getMyTemplates: IGetMyTemplates;

package/dist/esm5/api/campaign/templates/getTemplateById.d.ts

@@ -0,0 +1,2 @@
+import type { IGetTemplateById } from '../../../interfaces/campaigns';
+export declare const getTemplateById: IGetTemplateById;

package/dist/esm5/api/campaign/templates/resultSerializer.d.ts

@@ -0,0 +1 @@
+export declare const getTemplateResultSerializer: () => any;

package/dist/esm5/api/campaign/templates/setTemplateToCampaign.d.ts

@@ -0,0 +1,2 @@
+import type { ISetTemplateToCampaign } from '../../../interfaces/campaigns';
+export declare const setTemplateToCampaign: ISetTemplateToCampaign;

package/dist/esm5/api/campaign/templates/setTemplatesToCampaign.d.ts

@@ -0,0 +1,2 @@
+import type { ISetTemplatesToCampaign } from '../../../interfaces/campaigns';
+export declare const setTemplatesToCampaign: ISetTemplatesToCampaign;

package/dist/esm5/api/campaign/templates/updateEmailTemplate.d.ts

@@ -0,0 +1,2 @@
+import { IUpdateEmailTemplate } from '../../../interfaces/campaigns';
+export declare const updateEmailTemplate: IUpdateEmailTemplate;

package/dist/esm5/api/campaign/templates/updatePassPushTemplate.d.ts

@@ -0,0 +1,2 @@
+import { IUpdatePassPushTemplate } from '../../../interfaces/campaigns';
+export declare const updatePassPushTemplate: IUpdatePassPushTemplate;

package/dist/esm5/api/campaign/templates/updateSMSTemplate.d.ts

@@ -0,0 +1,2 @@
+import { IUpdateSMSTemplate } from '../../../interfaces/campaigns';
+export declare const updateSMSTemplate: IUpdateSMSTemplate;

package/dist/esm5/api/campaign/templates/updateWebPushTemplate.d.ts

@@ -0,0 +1,2 @@
+import { IUpdateWebPushTemplate } from '../../../interfaces/campaigns';
+export declare const updateWebPushTemplate: IUpdateWebPushTemplate;

package/dist/esm5/index.d.ts

@@ -17,18 +17,9 @@ export * from './interfaces/user/userNotificationsInterfaces';
 export * from './interfaces/loggerInterface';
 export * from './interfaces/cardInterfaces';
 export * from './interfaces/signupInterface';
-export { GetCampaignByIdResponseDTO } from './interfaces/campaigns/getByID';
-export { IGetCampaignById } from './interfaces/campaigns/getByID';
-export { ICampaignTemplate } from './interfaces/campaigns/common';
-export { ICampaignCohort } from './interfaces/campaigns/common';
-export { ICampaignRun } from './interfaces/campaigns/common';
-export { ICampaignChannelData } from './interfaces/campaigns/common';
-export { IUsersOperatingSystemsData } from './interfaces/campaigns/common';
-export { ICampaignChannel } from './interfaces/campaigns/common';
-export { ISO8601Date } from './interfaces/campaigns/common';
-export { CampaignByID } from './interfaces/campaigns';
 export { NotificationChannel } from './interfaces/common';
 export { CurrencyCode } from './interfaces/common';
+export * from './interfaces/campaigns/common';
 export * from './interfaces/issuer/IGetCardBonuses';
 export * from './interfaces/issuer/IGetCardSpends';
 export * from './interfaces/card/IGetBonuses';