@roketus/loyalty-js-sdk 4.40.2 → 5.0.0

package/dist/esm5/interfaces/campaignsV2/ICampaignAction.d.ts

@@ -0,0 +1,73 @@
+import { ENotificationChannel } from './ENotificationChannel';
+import { INotificationMediaAsset } from './INotificationMedia';
+export declare enum ECampaignActionType {
+    PROMOCODE = "PROMOCODE",
+    NOTIFICATION = "NOTIFICATION",
+    BONUS_ACCRUAL = "BONUS_ACCRUAL"
+}
+export declare type TCampaignAction = IPromoCodeAction | INotificationAction | IBonusAccrualAction;
+export interface INotificationChannelSetting {
+    enabled: boolean;
+    priority?: number;
+}
+export interface INotificationTemplate {
+    header: string;
+    text: string;
+    short_text: string;
+    html_content?: string;
+    media_assets: INotificationMediaAsset[];
+    tags?: string[];
+}
+export interface INotificationRetryPolicy {
+    max_attempts: number;
+    backoff_ms: number;
+}
+export declare enum ENotificationDeliveryGuarantee {
+    AtLeastOnce = "AT_LEAST_ONCE",
+    AtMostOnce = "AT_MOST_ONCE",
+    ExactlyOnce = "EXACTLY_ONCE"
+}
+export interface INotificationConfig {
+    channels?: ENotificationChannel[];
+    channel_settings: Record<ENotificationChannel, INotificationChannelSetting>;
+    template: INotificationTemplate;
+}
+export interface INotificationAction {
+    id: string;
+    type: ECampaignActionType.NOTIFICATION;
+    name: string;
+    description?: string;
+    order?: number;
+    scheduled_at: string;
+    config: INotificationConfig;
+    retry_policy?: INotificationRetryPolicy;
+    delivery_guarantee?: ENotificationDeliveryGuarantee;
+    processing_timeout?: number;
+    version: number;
+    created_at: string;
+}
+export interface IPromoCodeAction {
+    id: string;
+    type: ECampaignActionType.PROMOCODE;
+    name: string;
+    description?: string;
+    order?: number;
+    version: number;
+    scheduled_at?: string;
+    created_at: string;
+}
+export interface IBonusAccrualAction {
+    id: string;
+    type: ECampaignActionType.BONUS_ACCRUAL;
+    name: string;
+    description: string;
+    order?: number;
+    version: number;
+    scheduled_at: string;
+    created_at: string;
+    config: {
+        multiplier: number;
+        max_bonus: number;
+        categories: string[];
+    };
+}

package/dist/esm5/interfaces/campaignsV2/ICampaignCohort.d.ts

@@ -0,0 +1,7 @@
+import { ECohortType } from '../cohortsV2';
+export interface ICampaignCohort {
+    id: string;
+    name: string;
+    cohort_type: ECohortType;
+    count_of_users: number;
+}

package/dist/esm5/interfaces/campaignsV2/ICampaignLocation.d.ts

@@ -0,0 +1,4 @@
+export interface ICampaignLocation {
+    id: string;
+    name: string;
+}

package/dist/esm5/interfaces/campaignsV2/ICampaignRun.d.ts

@@ -0,0 +1,12 @@
+export interface ICampaignRun {
+    id: string;
+    count_of_users_to_send: number;
+    os: string[];
+    cohort_id: string;
+    state: string;
+    success: number;
+    failed: number;
+    planned: number;
+    run_at: string;
+    created_at: string;
+}

package/dist/esm5/interfaces/campaignsV2/ICampaignStatistics.d.ts

@@ -0,0 +1,41 @@
+export interface ICampaignActionStats {
+    total_executed: number;
+    success_count: number;
+    failed_count: number;
+    metrics: Record<string, number>;
+}
+export interface ICampaignPromoCodeStats extends ICampaignActionStats {
+    metrics: {
+        promocodes_used: number;
+        conversion_rate: number;
+        total_discount_amount: number;
+    };
+}
+export interface ICampaignNotificationStats extends ICampaignActionStats {
+    metrics: {
+        delivered: number;
+        opened: number;
+        clicked: number;
+        open_rate: number;
+        click_rate: number;
+    };
+}
+export interface ICampaignDailyStats {
+    date: string;
+    users_reached: number;
+    actions_executed: number;
+    success_rate: number;
+}
+export interface ICampaignStatistics {
+    campaign_id: string;
+    total_runs: number;
+    total_users_reached: number;
+    success_rate: number;
+    actions_statistics: {
+        PROMOCODE?: ICampaignPromoCodeStats;
+        NOTIFICATION?: ICampaignNotificationStats;
+        [key: string]: ICampaignActionStats | undefined;
+    };
+    daily_statistics: ICampaignDailyStats[];
+    last_updated: string;
+}

package/dist/esm5/interfaces/campaignsV2/IExecuteCampaignResult.d.ts

@@ -0,0 +1,24 @@
+export interface IExecuteCampaignResult {
+    id: string;
+    total_targets: number;
+    success_count: number;
+    failed_count: number;
+    in_progress_count: number;
+    custom_metrics: {
+        promocodes_assigned?: number;
+        avg_processing_time_ms?: number;
+        total_notifications_sent?: number;
+        push_sent?: number;
+        email_sent?: number;
+        sms_sent?: number;
+    };
+}
+export interface ICampaignActionResult {
+    status: "COMPLETED" | "FAILED" | "IN_PROGRESS" | string;
+    started_at: string;
+    ended_at: string;
+    metrics: IExecuteCampaignResult;
+}
+export interface IExecuteCampaignResponse extends IExecuteCampaignResult {
+    action_result: ICampaignActionResult[];
+}

package/dist/esm5/interfaces/campaignsV2/INotificationMedia.d.ts

@@ -0,0 +1,10 @@
+export declare enum EMediaType {
+    Image = "IMAGE",
+    Video = "VIDEO"
+}
+export interface INotificationMediaAsset {
+    id: string;
+    media_type: EMediaType;
+    purpose: string;
+    url: string;
+}

package/dist/esm5/interfaces/campaignsV2/campaignInterfaces.d.ts

@@ -0,0 +1,69 @@
+import { IHTTPClientResponse } from '@roketus/web-toolkit';
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+import { IListFiltersPayload, IPaginationData } from '../requestFilterInterfaces';
+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 IUpdateCampaign {
+    (id: string, payload: IUpdateCampaignPayload): Promise<ICampaign>;
+}
+export interface IUpdateCampaignDates {
+    (id: string, payload: IUpdateCampaignDatesPayload): Promise<ICampaign>;
+}
+export interface IUpdateCampaignLocations {
+    (id: string, payload: IUpdateCampaignLocationsPayload): Promise<ICampaign>;
+}
+export interface IGetCampaignById {
+    (id: string): Promise<ICampaign>;
+}
+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/esm5/interfaces/campaignsV2/campaignPayloads.d.ts

@@ -0,0 +1,35 @@
+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 INotificationActionPayload = Omit<INotificationAction, 'id' | 'version' | 'created_at'>;
+export declare type IBonusAccrualActionPayload = Omit<IBonusAccrualAction, 'id' | 'version' | 'created_at'>;
+export declare type TCampaignActionPayload = IPromoCodeActionPayload | INotificationActionPayload | IBonusAccrualActionPayload;
+export interface ICreateCampaignPayload {
+    name: string;
+    description?: string;
+    campaign_type: ECampaignType;
+    execution_mode: ECampaignExecutionMode;
+    cohort_id: string;
+    actions: TCampaignActionPayload[];
+    locations?: string[];
+    start_date: string;
+    end_date: string;
+    metadata?: {
+        department: string;
+        budget: number;
+        [key: string]: unknown;
+    };
+}
+export interface IUpdateCampaignPayload extends Pick<ICreateCampaignPayload, 'name' | 'description' | 'metadata'> {
+}
+export interface IUpdateCampaignDatesPayload extends Pick<ICreateCampaignPayload, 'start_date' | 'end_date'> {
+}
+export interface IUpdateCampaignLocationsPayload extends Pick<ICreateCampaignPayload, 'locations'> {
+}
+export interface IUpdateCampaignActionPayload extends Omit<TCampaignActionPayload, 'type'> {
+}
+export interface IExecuteCampaignPayload {
+    execution_mode?: string;
+    notification_channels: ENotificationChannel[];
+}

package/dist/esm5/interfaces/campaignsV2/index.d.ts

@@ -0,0 +1,10 @@
+export { ICampaign as ICampaignV2, ECampaignType, ECampaignExecutionMode, ECampaignStatus } from './ICampaign';
+export * from './ICampaignAction';
+export { ICampaignCohort as ICampaignCohortV2 } from './ICampaignCohort';
+export * from './ICampaignLocation';
+export { ICampaignRun as ICampaignRunV2 } from './ICampaignRun';
+export * from './ENotificationChannel';
+export { ICreateCampaignPayload as ICreateCampaignPayloadV2, IUpdateCampaignPayload, IUpdateCampaignDatesPayload, IUpdateCampaignLocationsPayload, TCampaignActionPayload, IUpdateCampaignActionPayload, IBonusAccrualActionPayload, INotificationActionPayload, IPromoCodeActionPayload, IExecuteCampaignPayload, } from './campaignPayloads';
+export * from './ICampaignStatistics';
+export * from './IExecuteCampaignResult';
+export * from './INotificationMedia';

package/dist/esm5/interfaces/cardManagement/index.d.ts

@@ -0,0 +1,2 @@
+export * from './ICard';
+export * from './cardManagementInterfaces';

package/dist/esm5/interfaces/cohortsV2/ICohort.d.ts

@@ -28,9 +28,9 @@ export declare enum ECohortAction {
 }
 export declare enum ECohortConditionsType {
     LESS = "LESS",
-    MORE = "GREATER",
-    LESS_OR_EQUAL = "LESS_EQUAL",
-    MORE_OR_EQUAL = "GREATER_EQUAL",
+    GREATER = "GREATER",
+    LESS_EQUAL = "LESS_EQUAL",
+    GREATER_EQUAL = "GREATER_EQUAL",
     EQUAL = "EQUAL",
     NOT_EQUAL = "NOT_EQUAL"
 }
@@ -39,21 +39,32 @@ export declare enum ECohortTimePeriod {
     LAST_WEEK = "LAST_WEEK",
     MONTH = "MONTH",
     QUARTER = "QUARTER",
-    IN_EACH = "IN_EACH",
-    DURING = "DURING",
     SINCE = "SINCE",
+    CUSTOM = "CUSTOM",
     WITHIN = "WITHIN",
-    CUSTOM = "CUSTOM"
+    IN_EACH = "IN_EACH",
+    DURING = "DURING"
+}
+export declare enum ECohortDuration {
+    DAYS = "DAYS",
+    WEEKS = "WEEKS",
+    MONTHS = "MONTHS"
+}
+export declare enum ECohortDurationPeriodicity {
+    DAILY = "DAILY",
+    WEEKLY = "WEEKLY",
+    MONTHLY = "MONTHLY"
 }
 export declare type CohortCondition = {
     action: ECohortAction;
     is_positive: boolean;
     time_range: {
-        period: string;
+        period: ECohortTimePeriod;
+        since_date?: string;
         custom: {
             start_date: string;
             end_date: string;
-        };
+        } | null;
     };
     frequency?: {
         operator: ECohortConditionsType;
@@ -69,10 +80,11 @@ export interface ICohort {
     criteria: {
         new_user_time_range: {
             period: string;
+            since_date?: string;
             custom: {
                 start_date: string;
                 end_date: string;
-            };
+            } | null;
         } | null;
         conditions: CohortCondition[];
     };

package/dist/esm5/interfaces/cohortsV2/ICreateCohortPayload.d.ts

@@ -7,10 +7,11 @@ export interface ICreateCohortPayload {
     criteria: {
         new_user_time_range: {
             period: string;
+            since_date?: string;
             custom: {
                 start_date: string;
                 end_date: string;
-            };
+            } | null;
         } | null;
         conditions: CohortCondition[];
     };

package/dist/esm5/interfaces/cohortsV2/IUpdateCohortPayload.d.ts

@@ -7,10 +7,11 @@ export interface IUpdateCohortPayload {
     criteria: {
         new_user_time_range: {
             period: string;
+            since_date?: string;
             custom: {
                 start_date: string;
                 end_date: string;
-            };
+            } | null;
         } | null;
         conditions: CohortCondition[];
     };

package/dist/esm5/interfaces/cohortsV2/index.d.ts

@@ -0,0 +1,4 @@
+export * from './ICohort';
+export * from './ICreateCohortPayload';
+export * from './IUpdateCohortPayload';
+export * from './cohortsInterfaces';

package/dist/esm5/interfaces/excludes/index.d.ts

@@ -0,0 +1,2 @@
+export * from './excludeInterfaces';
+export * from './listExcludesInterfaces';

package/dist/esm5/interfaces/products/index.d.ts

@@ -0,0 +1,5 @@
+export * from './productInterfaces';
+export * from './listProductsInterfaces';
+export * from './categoryInterfaces';
+export * from './listCategoriesInterfaces';
+export * from './productSearchInterfaces';

package/dist/esm5/interfaces/promoCodes/ICreatePromocodePayload.d.ts

@@ -1,7 +1,8 @@
-import { EPromocodeDiscountType } from './IPromocode';
+import { EPromocodeDiscountType, EPromocodeType } from './IPromocode';
 export interface ICreatePromocodePayload {
     name: string;
     description: string;
+    promocodeType: EPromocodeType;
     startAt: string;
     stopAt: string;
     activationLimit: number;

package/dist/esm5/interfaces/promoCodes/IPromocode.d.ts

@@ -8,11 +8,17 @@ export declare enum EPromocodeStatus {
 export declare enum EPromocodeDiscountType {
     PERCENT = "percent",
     PRODUCT_PRICE = "product_price",
-    N_PLUS_1 = "buy_n_get_one_free"
+    N_PLUS_1 = "buy_n_get_one_free",
+    BONUS = "bonus"
+}
+export declare enum EPromocodeType {
+    GENERAL = "general",
+    PERSONAL = "personal"
 }
 export interface IPromocode {
     id: string;
     name: string;
+    promocodeType: EPromocodeType;
     description: string;
     discountType: EPromocodeDiscountType;
     discountValue: number;

package/dist/esm5/interfaces/promoCodes/index.d.ts

@@ -0,0 +1,4 @@
+export * from './IPromocode';
+export * from './ICreatePromocodePayload';
+export * from './IUpdatePromocodePayload';
+export * from './promocodeInterfaces';

package/dist/esm5/interfaces/referralProgram/index.d.ts

@@ -0,0 +1,6 @@
+export * from './IReferralProgram';
+export * from './IRefProgramInfluencer';
+export * from './IRefProgramStats';
+export * from './ICreateRefProgramPayload';
+export * from './IUpdateRefProgramPayload';
+export * from './IInfluencerPayload';

package/dist/esm5/interfaces/tiers/index.d.ts

@@ -0,0 +1,3 @@
+export * from './IGetAllTiers';
+export * from './ISetTierByCard';
+export * from './IGetTiersByCard';

package/dist/esm5/interfaces/user/index.d.ts

@@ -0,0 +1,5 @@
+export * from './IUser';
+export * from './IUserCreate';
+export * from './IUserUpdate';
+export * from './userInterfaces';
+export * from './userNotificationsInterfaces';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roketus/loyalty-js-sdk",
-  "version": "4.40.2",
+  "version": "5.0.0",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm5/index.js",
   "author": "Skoch <st.ixidor@gmail.com>",
@@ -56,5 +56,9 @@
     "ts-jest": "^27.1.4"
   },
   "description": "",
-  "types": "./dist/cjs/index.d.ts"
+  "types": "./dist/cjs/index.d.ts",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
 }