@roketus/loyalty-js-sdk 5.0.0 → 5.1.0

package/dist/cjs/interfaces/ISDK.d.ts

@@ -12,9 +12,8 @@ import type { ISubscribeToWebPushNotifications, ISendEmailByEvent, ISendCompanyE
 import { ILoggerSetup } from './loggerInterface';
 import { IDownloadAnonymousCard } from './cardInterfaces';
 import { ISendTelemetry } from './telemetryInterfaces';
-import { ICreateCampaign, ISetCohortToCampaign, ISetTemplateToCampaign, ISetTemplatesToCampaign, IDeleteTemplateFromCampaign, IRunCampaign, IGetMyCohorts, IGetMyTemplates, IGetTemplateById, IDeleteTemplate, ICreateEmailTemplate, ICreateSMSTemplate, ICreateWebPushTemplate, ICreatePassPushTemplate, IUpdateEmailTemplate, IUpdateSMSTemplate, IUpdatePassPushTemplate, IUpdateWebPushTemplate, IGetCampaignById, IGetMyCampaigns } from './campaigns';
-import { ICreateCampaign as ICreateCampaignV2, IGetCampaignById as IGetCampaignByIdV2, IListCampaigns, IDeleteCampaign, IUpdateCampaign, IUpdateCampaignDates, IUpdateCampaignLocations, IAddActionToCampaign, IUpdateCampaignAction, IDeleteActionFromCampaign, IExecuteCampaign, IActivateCampaign, IPauseCampaign, IResumeCampaign, ICancelCampaign, ICompleteCampaign, IGetCampaignStatistics } from './campaignsV2/campaignInterfaces';
-import { TCreateCohort as TCreateCohortV2, TGetCohortById as TGetCohortByIdV2, TListCohorts as TListCohortsV2, TUpdateCohort as TUpdateCohortV2, TDeleteCohort as TDeleteCohortV2 } from './cohortsV2/cohortsInterfaces';
+import { ICreateCampaign, IGetCampaignById, IListCampaigns, IDeleteCampaign, IUpdateCampaign, IUpdateCampaignDates, IUpdateCampaignLocations, IAddActionToCampaign, IUpdateCampaignAction, IDeleteActionFromCampaign, IExecuteCampaign, IActivateCampaign, IPauseCampaign, IResumeCampaign, ICancelCampaign, ICompleteCampaign, IGetCampaignStatistics } from './campaigns/campaignInterfaces';
+import { TCreateCohort, TGetCohortById, TListCohorts, TUpdateCohort, TDeleteCohort } from './cohorts/cohortsInterfaces';
 import { IDispatchCustomEvent, IGetCardByPhone, ISetCardName } from './issuerInterface';
 import { ISetBirthdate } from './signupInterface';
 import { IGetTransactionsByCard } from './transactions/IGetTransactionsByCard';
@@ -163,29 +162,7 @@ export interface ISDK {
     };
     campaign: {
         createCampaign: ICreateCampaign;
-        setCohortToCampaign: ISetCohortToCampaign;
-        setTemplateToCampaign: ISetTemplateToCampaign;
-        setTemplatesToCampaign: ISetTemplatesToCampaign;
-        deleteTemplateFromCampaign: IDeleteTemplateFromCampaign;
-        runCampaign: IRunCampaign;
-        getMyCampaigns: IGetMyCampaigns;
         getCampaignById: IGetCampaignById;
-        getMyCohorts: IGetMyCohorts;
-        createEmailTemplate: ICreateEmailTemplate;
-        createSMSTemplate: ICreateSMSTemplate;
-        createPassPushTemplate: ICreatePassPushTemplate;
-        createWebPushTemplate: ICreateWebPushTemplate;
-        getMyTemplates: IGetMyTemplates;
-        getTemplateById: IGetTemplateById;
-        updateEmailTemplate: IUpdateEmailTemplate;
-        updateSMSTemplate: IUpdateSMSTemplate;
-        updatePassPushTemplate: IUpdatePassPushTemplate;
-        updateWebPushTemplate: IUpdateWebPushTemplate;
-        deleteTemplate: IDeleteTemplate;
-    };
-    campaignV2: {
-        createCampaign: ICreateCampaignV2;
-        getCampaignById: IGetCampaignByIdV2;
         listCampaigns: IListCampaigns;
         deleteCampaign: IDeleteCampaign;
         updateCampaignInfo: IUpdateCampaign;
@@ -202,12 +179,12 @@ export interface ISDK {
         cancelCampaign: ICancelCampaign;
         getCampaignStatistics: IGetCampaignStatistics;
     };
-    cohortsV2: {
-        listCohorts: TListCohortsV2;
-        getCohortById: TGetCohortByIdV2;
-        createCohort: TCreateCohortV2;
-        updateCohort: TUpdateCohortV2;
-        deleteCohort: TDeleteCohortV2;
+    cohorts: {
+        listCohorts: TListCohorts;
+        getCohortById: TGetCohortById;
+        createCohort: TCreateCohort;
+        updateCohort: TUpdateCohort;
+        deleteCohort: TDeleteCohort;
     };
     messengerHub: {
         sendTelegramMsg: ISendTelegramMsg;

package/dist/{esm5/interfaces/campaignsV2 → cjs/interfaces/campaigns}/ICampaign.d.ts

@@ -30,8 +30,8 @@ export interface ICampaign {
     version: number;
     created_at: string;
     updated_at: string;
-    cohort: ICampaignCohort[];
-    campaign_action: TCampaignAction[];
-    location: ICampaignLocation[];
-    campaign_run: ICampaignRun[];
+    cohort: ICampaignCohort;
+    actions: TCampaignAction[];
+    locations: ICampaignLocation[];
+    runs: ICampaignRun[];
 }

package/dist/{esm5/interfaces/campaignsV2 → cjs/interfaces/campaigns}/ICampaignAction.d.ts

@@ -55,6 +55,9 @@ export interface IPromoCodeAction {
     version: number;
     scheduled_at?: string;
     created_at: string;
+    config: {
+        promocode_id: string;
+    };
 }
 export interface IBonusAccrualAction {
     id: string;

package/dist/{esm5/interfaces/campaignsV2 → cjs/interfaces/campaigns}/ICampaignCohort.d.ts

@@ -1,4 +1,4 @@
-import { ECohortType } from '../cohortsV2';
+import { ECohortType } from '../cohorts';
 export interface ICampaignCohort {
     id: string;
     name: string;

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

@@ -1,32 +1,69 @@
 import { IHTTPClientResponse } from '@roketus/web-toolkit';
 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;
+import { ICampaign } from './ICampaign';
+import { TCampaignAction } from './ICampaignAction';
+import { ICampaignCohort } from './ICampaignCohort';
+import { ICampaignLocation } from './ICampaignLocation';
+import { ICampaignRun } from './ICampaignRun';
+import { ICreateCampaignPayload, IUpdateCampaignDatesPayload, IUpdateCampaignLocationsPayload, IUpdateCampaignPayload, IUpdateCampaignActionPayload, TCampaignActionPayload, IExecuteCampaignPayload } from './campaignPayloads';
+import { ICampaignActionResult, IExecuteCampaignResponse } from './IExecuteCampaignResult';
+import { ICampaignStatistics } from './ICampaignStatistics';
+export declare type CampaignResponseDTO = I_JSON_API_Response_Many<ICampaign, ICampaignCohort | TCampaignAction | ICampaignRun | ICampaignLocation>;
+export interface IListCampaignsResponse {
+    data: ICampaign[];
+    meta: IPaginationData;
 }
 export interface ICreateCampaign {
     (payload: ICreateCampaignPayload): Promise<ICampaign>;
 }
-export interface IRunCampaignPayload {
-    campaignId: string;
+export interface IUpdateCampaign {
+    (id: string, payload: IUpdateCampaignPayload): Promise<ICampaign>;
 }
-export interface IRunCampaign {
-    (payload: IRunCampaignPayload): Promise<IHTTPClientResponse<void>>;
+export interface IUpdateCampaignDates {
+    (id: string, payload: IUpdateCampaignDatesPayload): Promise<ICampaign>;
 }
-export interface IGetCampaignPayload {
-    campaignId: string;
+export interface IUpdateCampaignLocations {
+    (id: string, payload: IUpdateCampaignLocationsPayload): Promise<ICampaign>;
 }
 export interface IGetCampaignById {
-    (payload: IGetCampaignPayload): Promise<ICampaign>;
+    (id: string): Promise<ICampaign>;
 }
-export interface IListCampaignsResponse {
-    data: ICampaign[];
-    meta: IPaginationData;
-}
-export interface IGetMyCampaigns {
+export interface IListCampaigns {
     (params: IListFiltersPayload): Promise<IListCampaignsResponse>;
 }
+export interface IDeleteCampaign {
+    (id: string): Promise<IHTTPClientResponse<void>>;
+}
+export interface IAddActionToCampaign {
+    (id: string, payload: TCampaignActionPayload): Promise<void>;
+}
+export interface IUpdateCampaignAction {
+    (id: string, actionId: string, payload: IUpdateCampaignActionPayload): Promise<void>;
+}
+export interface IDeleteActionFromCampaign {
+    (id: string, actionId: string): Promise<IHTTPClientResponse<void>>;
+}
+export interface IActivateCampaign {
+    (id: string): Promise<IHTTPClientResponse<void>>;
+}
+export interface IPauseCampaign {
+    (id: string): Promise<IHTTPClientResponse<void>>;
+}
+export interface IResumeCampaign {
+    (id: string): Promise<IHTTPClientResponse<void>>;
+}
+export interface ICompleteCampaign {
+    (id: string): Promise<IHTTPClientResponse<void>>;
+}
+export interface ICancelCampaign {
+    (id: string): Promise<IHTTPClientResponse<void>>;
+}
+export declare type IExecuteCampaignResponseDTO = I_JSON_API_Response_Many<IExecuteCampaignResponse, ICampaignActionResult>;
+export interface IExecuteCampaign {
+    (id: string, payload: IExecuteCampaignPayload): Promise<IExecuteCampaignResponse>;
+}
+export declare type IGetCampaignStatisticsResponseDTO = I_JSON_API_Response_Many<ICampaignStatistics>;
+export interface IGetCampaignStatistics {
+    (id: string): Promise<ICampaignStatistics>;
+}

package/dist/cjs/interfaces/{campaignsV2 → campaigns}/campaignPayloads.d.ts

@@ -1,7 +1,7 @@
 import { ENotificationChannel } from './ENotificationChannel';
 import { ECampaignExecutionMode, ECampaignType } from './ICampaign';
 import type { IBonusAccrualAction, INotificationAction, IPromoCodeAction } from './ICampaignAction';
-export declare type IPromoCodeActionPayload = Omit<IPromoCodeAction, 'name' | 'version' | 'created_at'>;
+export declare type IPromoCodeActionPayload = Omit<IPromoCodeAction, 'id' | 'name' | 'version' | 'created_at'>;
 export declare type INotificationActionPayload = Omit<INotificationAction, 'id' | 'version' | 'created_at'>;
 export declare type IBonusAccrualActionPayload = Omit<IBonusAccrualAction, 'id' | 'version' | 'created_at'>;
 export declare type TCampaignActionPayload = IPromoCodeActionPayload | INotificationActionPayload | IBonusAccrualActionPayload;

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

@@ -1,5 +1,10 @@
-export * from './common';
-export * from './campaignInterfaces';
-export * from './cohortsInterfaces';
-export * from './cohortsInterfaces';
-export * from './templatesInterfaces';
+export * from './ICampaign';
+export * from './ICampaignAction';
+export * from './ICampaignCohort';
+export * from './ICampaignLocation';
+export * from './ICampaignRun';
+export * from './ENotificationChannel';
+export * from './campaignPayloads';
+export * from './ICampaignStatistics';
+export * from './IExecuteCampaignResult';
+export * from './INotificationMedia';

package/dist/cjs/interfaces/notifications/ICampaignChannelData.d.ts

@@ -0,0 +1,6 @@
+export interface ICampaignChannelData {
+    email?: string;
+    sms?: string;
+    webPush?: string;
+    passPush?: string;
+}

package/dist/cjs/interfaces/notifications/IGetMyNotificationStats.d.ts

@@ -1,6 +1,6 @@
 import { IRequestWithCancelAndData } from '../IRequestWithCancelAndData';
 import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
-import { ICampaignChannelData } from '../campaigns/common';
+import { ICampaignChannelData } from './ICampaignChannelData';
 export interface IGetMyNotificationStats {
     (startDate: Date, endDate: Date): IRequestWithCancelAndData<IGetMyNotificationStatsResponseDTO, I_JSON_API_Response_Many>;
 }

package/dist/esm5/api/campaign/actions/addAction.d.ts

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

package/dist/esm5/api/campaign/actions/removeAction.d.ts

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

package/dist/esm5/api/campaign/actions/updateAction.d.ts

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

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

@@ -1,2 +1,2 @@
-import type { ICreateCampaign } from '../../interfaces/campaigns';
+import type { ICreateCampaign } from '../../interfaces/campaigns/campaignInterfaces';
 export declare const createCampaign: ICreateCampaign;

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

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

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

@@ -1,2 +1,2 @@
-import { IGetCampaignById } from '../../interfaces/campaigns';
+import type { IGetCampaignById } from '../../interfaces/campaigns/campaignInterfaces';
 export declare const getCampaignById: IGetCampaignById;

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

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

package/dist/esm5/api/campaign/lifecycle/activateCampaign.d.ts

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

package/dist/esm5/api/campaign/lifecycle/cancelCampaign.d.ts

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

package/dist/esm5/api/campaign/lifecycle/completeCampaign.d.ts

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

package/dist/esm5/api/campaign/lifecycle/executeCampaign.d.ts

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

package/dist/esm5/api/campaign/lifecycle/pauseCampaign.d.ts

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

package/dist/esm5/api/campaign/lifecycle/resumeCampaign.d.ts

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

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

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

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

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

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

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

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

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

package/dist/esm5/api/cohorts/createCohort.d.ts

@@ -0,0 +1,2 @@
+import { TCreateCohort } from '../../interfaces/cohorts/cohortsInterfaces';
+export declare const createCohort: TCreateCohort;

package/dist/esm5/api/cohorts/deleteCohort.d.ts

@@ -0,0 +1,2 @@
+import { TDeleteCohort } from '../../interfaces/cohorts/cohortsInterfaces';
+export declare const deleteCohort: TDeleteCohort;

package/dist/esm5/api/cohorts/getCohortById.d.ts

@@ -0,0 +1,2 @@
+import { TGetCohortById } from '../../interfaces/cohorts/cohortsInterfaces';
+export declare const getCohortById: TGetCohortById;

package/dist/esm5/api/cohorts/listCohorts.d.ts

@@ -0,0 +1,2 @@
+import { TListCohorts } from '../../interfaces/cohorts/cohortsInterfaces';
+export declare const listCohorts: TListCohorts;

package/dist/esm5/api/cohorts/updateCohort.d.ts

@@ -0,0 +1,2 @@
+import { TUpdateCohort } from '../../interfaces/cohorts/cohortsInterfaces';
+export declare const updateCohort: TUpdateCohort;

package/dist/esm5/index.d.ts

@@ -3,7 +3,7 @@ export { toFilterQueryParams } from './utils/toFilterQueryParams';
 export type { ISDK } from './interfaces/ISDK';
 export * from './interfaces/json';
 export * from './interfaces/campaigns';
-export * from './interfaces/campaignsV2';
+export * from './interfaces/campaigns';
 export * from './interfaces/analyticsInterfaces';
 export * from './interfaces/telemetryInterfaces';
 export * from './interfaces/urlInterfaces';
@@ -21,6 +21,7 @@ export * from './interfaces/issuer/IGetCardBonuses';
 export * from './interfaces/issuer/IGetCardSpends';
 export * from './interfaces/card/IGetBonuses';
 export * from './interfaces/notifications/IGetMyNotificationStats';
+export * from './interfaces/notifications/ICampaignChannelData';
 export * from './interfaces/tiers';
 export * from './interfaces/promoCodes';
 export * from './interfaces/excludes';
@@ -29,5 +30,5 @@ export * from './interfaces/requestFilterInterfaces';
 export * from './interfaces/cardManagement';
 export * from './interfaces/order/orderInterfaces';
 export * from './interfaces/referralProgram';
-export * from './interfaces/cohortsV2';
+export * from './interfaces/cohorts';
 export * from './interfaces/messengerHub';