@roketus/loyalty-js-sdk 5.1.1 → 5.2.1

package/dist/cjs/interfaces/referralProgram/IReferralProgram.d.ts

@@ -1,51 +1,51 @@
+import { IInfluencer } from './IInfluencer';
 export declare enum ERefProgramStatus {
-    CREATED = "created",
-    ACTIVE = "active",
-    ARCHIVED = "archived"
-}
-export declare enum ERefProgramType {
-    REGULAR = "regular",
-    INFLUENCER = "influencer"
+    NotStarted = "notStarted",
+    Active = "active",
+    Expired = "expired",
+    Paused = "paused",
+    Completed = "completed",
+    Archive = "archived"
 }
 export declare enum ERefProgramActionType {
     REGISTRATION = "registration",
     PURCHASE = "purchase"
 }
 export declare enum ERefProgramRewardType {
-    BONUS = "bonus",
+    BONUS = "points",
     COUPON = "coupon"
 }
 export interface IRefProgramBonusReward {
-    bonusAmount: number;
+    type: ERefProgramRewardType.BONUS;
+    bonusAmount?: number;
+    value: number;
 }
 export interface IRefProgramCouponReward {
-    name: string;
-    promo_code_id: string;
-    allowed_uses: number;
-}
-export interface IRefProgramReward {
-    rewardType: ERefProgramRewardType;
-    reward: Array<IRefProgramBonusReward | IRefProgramCouponReward>;
-}
+    type: ERefProgramRewardType.COUPON;
+    promo_code: {
+        id: string;
+        name: string;
+        description: string;
+        status: string;
+    } | null;
+    value: number;
+}
+export declare type IRefProgramReward = IRefProgramBonusReward | IRefProgramCouponReward;
 export interface IReferralProgram {
     id: string;
     name: string;
     description: string;
-    startAt: string;
-    stopAt?: string;
-    status: ERefProgramStatus;
-    programType: ERefProgramType;
-    triggerAction: ERefProgramActionType;
-    influencer?: IRefProgramReward;
-    customer?: IRefProgramReward;
-    createdAt: string;
-    updatedAt?: string;
-}
-export interface IReferralProgramListItem {
-    id: string;
-    name: string;
-    startAt: string;
-    stopAt?: string;
+    start_date: string;
+    end_date: string;
+    issuer_id: string;
+    max_referrals: number;
+    target_action: ERefProgramActionType;
+    referrer_reward: IRefProgramReward;
+    referred_reward: IRefProgramReward;
     status: ERefProgramStatus;
-    programType?: ERefProgramType;
+    archived: boolean;
+    enabled: boolean;
+    created_at: string;
+    updated_at: string;
+    influencers?: IInfluencer[];
 }

package/dist/cjs/interfaces/referralProgram/IReferralProgramAnalytics.d.ts

@@ -0,0 +1,35 @@
+export interface IReferralProgramAnalytics {
+    program_id: string;
+    start_date: string;
+    end_date: string;
+    summary: {
+        average_order_value: number;
+        conversion_rate: number;
+        total_clicks: number;
+        total_conversions: number;
+        total_links: number;
+        total_referred_rewards: number;
+        total_referrer_rewards: number;
+        total_registrations: number;
+    };
+    time_series_data: {
+        [key: string]: unknown;
+    };
+}
+export interface IReferralProgramMetrics {
+    ProgramID: string;
+    TotalLinks: number;
+    ActiveLinks: number;
+    TotalActions: number;
+    CompletedActions: number;
+    ConversionRate: number;
+    TotalRewardsIssued: number;
+    PointsIssued: number;
+    CouponsIssued: number;
+    UniqueReferrers: number;
+    UniqueReferred: number;
+    AverageTimeToConvert: number;
+    TopReferrers: {
+        [key: string]: unknown;
+    } | null;
+}

package/dist/cjs/interfaces/referralProgram/IUpdateRefProgramPayload.d.ts

@@ -1,9 +1,11 @@
-import { IRefProgramReward } from "./IReferralProgram";
+import { IRefProgramRewardPayload } from "./ICreateRefProgramPayload";
+import { ERefProgramActionType } from "./IReferralProgram";
 export interface IUpdateRefProgramPayload {
     name?: string;
     description?: string;
-    startAt?: string;
-    stopAt?: string;
-    influencer?: IRefProgramReward;
-    customer?: IRefProgramReward;
+    start_date?: string;
+    end_date?: string;
+    target_action?: ERefProgramActionType;
+    referrer_reward?: IRefProgramRewardPayload;
+    referred_reward?: IRefProgramRewardPayload;
 }

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

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

package/dist/cjs/interfaces/referralProgram/influencerInterfaces.d.ts

@@ -1,23 +1,20 @@
 import { IListFiltersPayload } from '../requestFilterInterfaces';
 import { I_JSON_API_Response_Many, I_JSON_API_Response_Single } from '../I_JSON_API_ResponseDTO';
 import { I_Deserialized_List_Response_DTO } from '../I_Deserialized_Response_DTO';
-import { IInfluencer } from './IRefProgramInfluencer';
-import { IInfluencerPayload } from './IInfluencerPayload';
-import { IRefProgramStats } from './IRefProgramStats';
-export interface InfluencerRequestDTO {
-    data: {
-        attributes: IInfluencerPayload;
-    };
-}
+import { IInfluencer, IInfluencerPerfomance } from './IInfluencer';
+import { ICreateInfluencerPayload, IUpdateInfluencerPayload, IUpdateInfluencerRewardPayload } from './IInfluencerPayload';
 export declare type InfluencerResponseDTO = I_JSON_API_Response_Single<IInfluencer>;
 export interface IAddInfluencer {
-    (programId: string, payload: IInfluencerPayload): Promise<IInfluencer>;
+    (programId: string, payload: ICreateInfluencerPayload): Promise<IInfluencer>;
 }
 export interface UpdateInfluencerResponseDTO {
     data: 'ok';
 }
 export interface IUpdateInfluencer {
-    (programId: string, influencerId: string, payload: IInfluencerPayload): Promise<void>;
+    (programId: string, influencerId: string, payload: IUpdateInfluencerPayload): Promise<void>;
+}
+export interface IUpdateInfluencerReward {
+    (programId: string, influencerId: string, payload: IUpdateInfluencerRewardPayload): Promise<void>;
 }
 export interface IDeleteInfluencer {
     (programId: string, influencerId: string): Promise<void>;
@@ -30,6 +27,7 @@ export interface IListInfluencers {
 export interface IGetInfluencer {
     (programId: string, influencerId: string): Promise<IInfluencer>;
 }
-export interface IGetStatsByInfluencer {
-    (programId: string, influencerId: string): Promise<IRefProgramStats>;
+export declare type IGetInfluencerPerfomanceResponseDTO = I_JSON_API_Response_Many<IInfluencerPerfomance>;
+export interface IGetInfluencerPerfomance {
+    (programId: string, influencerId: string): Promise<IInfluencerPerfomance>;
 }

package/dist/cjs/interfaces/referralProgram/referralProgramInterfaces.d.ts

@@ -1,8 +1,8 @@
 import { IListFiltersPayload } from '../requestFilterInterfaces';
 import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
 import { I_Deserialized_List_Response_DTO } from '../I_Deserialized_Response_DTO';
-import { IReferralProgram, IReferralProgramListItem } from './IReferralProgram';
-import { IRefProgramStats } from './IRefProgramStats';
+import { IReferralProgram } from './IReferralProgram';
+import { IReferralProgramAnalytics, IReferralProgramMetrics } from './IReferralProgramAnalytics';
 import { ICreateRefProgramPayload } from './ICreateRefProgramPayload';
 import { IUpdateRefProgramPayload } from './IUpdateRefProgramPayload';
 export interface CreateRefProgramRequestDTO {
@@ -25,21 +25,30 @@ export interface UpdateReferralProgramResponseDTO {
 export interface IUpdateReferralProgram {
     (id: string, payload: IUpdateRefProgramPayload): Promise<void>;
 }
-export interface IArchiveReferralProgram {
+export interface IEnableReferralProgram {
     (id: string): Promise<void>;
 }
-export interface IUnarchiveReferralProgram {
+export interface IDisableReferralProgram {
+    (id: string): Promise<void>;
+}
+export interface IArchiveReferralProgram {
     (id: string): Promise<void>;
 }
 export interface IListReferralPrograms {
     (params: IListFiltersPayload): Promise<IListReferralProgramsResponse>;
 }
 export declare type ListReferralProgramsResponseDTO = I_JSON_API_Response_Many<ReferralProgramResponseDTO>;
-export declare type IListReferralProgramsResponse = I_Deserialized_List_Response_DTO<IReferralProgramListItem>;
+export declare type IListReferralProgramsResponse = I_Deserialized_List_Response_DTO<IReferralProgram>;
 export interface IGetReferralProgram {
     (id: string): Promise<IReferralProgram>;
 }
-export declare type RefProgramStatsResponseDTO = I_JSON_API_Response_Many<IRefProgramStats>;
-export interface IGetRefProgramStats {
-    (id: string): Promise<IRefProgramStats>;
+export declare type RefProgramAnalyticsResponseDTO = I_JSON_API_Response_Many<IReferralProgramAnalytics>;
+export interface IGetRefProgramAnalytics {
+    (id: string): Promise<IReferralProgramAnalytics>;
+}
+export interface IGetRefProgramMetrics {
+    (id: string, params: {
+        start_date?: string;
+        end_date?: string;
+    }): Promise<IReferralProgramMetrics>;
 }

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

@@ -26,4 +26,5 @@ export interface IListFiltersPayload {
     filter?: Record<string, string | string[]>;
     sort?: Record<string, EListSort>;
     search?: string;
+    status?: string;
 }

package/dist/esm5/api/referralProgram/disableRefProgram.d.ts

@@ -0,0 +1,2 @@
+import type { IDisableReferralProgram } from '../../interfaces/referralProgram/referralProgramInterfaces';
+export declare const disableRefProgram: IDisableReferralProgram;

package/dist/esm5/api/referralProgram/enableRefProgram.d.ts

@@ -0,0 +1,2 @@
+import type { IEnableReferralProgram } from '../../interfaces/referralProgram/referralProgramInterfaces';
+export declare const enableRefProgram: IEnableReferralProgram;

package/dist/esm5/api/referralProgram/getRefProgramAnalytics.d.ts

@@ -0,0 +1,2 @@
+import type { IGetRefProgramAnalytics } from '../../interfaces/referralProgram/referralProgramInterfaces';
+export declare const getRefProgramAnalytics: IGetRefProgramAnalytics;

package/dist/esm5/api/referralProgram/getRefProgramMetrics.d.ts

@@ -0,0 +1,2 @@
+import { IGetRefProgramMetrics } from '../../interfaces/referralProgram/referralProgramInterfaces';
+export declare const getRefProgramMetrics: IGetRefProgramMetrics;

package/dist/esm5/api/referralProgram/influencers/getInfluencerPerfomance.d.ts

@@ -0,0 +1,2 @@
+import type { IGetInfluencerPerfomance } from '../../../interfaces/referralProgram/influencerInterfaces';
+export declare const getInfluencerPerfomance: IGetInfluencerPerfomance;

package/dist/esm5/api/referralProgram/influencers/updateInfluencerReward.d.ts

@@ -0,0 +1,2 @@
+import type { IUpdateInfluencerReward } from '../../../interfaces/referralProgram/influencerInterfaces';
+export declare const updateInfluencerReward: IUpdateInfluencerReward;