@roketus/loyalty-js-sdk 5.1.0 → 5.2.0

package/dist/esm5/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/esm5/interfaces/referralProgram/IUpdateRefProgramPayload.d.ts

@@ -1,9 +1,10 @@
-import { IRefProgramReward } from "./IReferralProgram";
+import { ERefProgramActionType, IRefProgramReward } 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?: IRefProgramReward;
+    referred_reward?: IRefProgramReward;
 }

package/dist/esm5/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/esm5/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/esm5/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roketus/loyalty-js-sdk",
-  "version": "5.1.0",
+  "version": "5.2.0",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm5/index.js",
   "author": "Skoch <st.ixidor@gmail.com>",

package/dist/cjs/api/referralProgram/getRefProgramStats.d.ts

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

package/dist/cjs/api/referralProgram/influencers/getStatsByInfluencer.d.ts

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

package/dist/cjs/api/referralProgram/unarchiveRefProgram.d.ts

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

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

@@ -1,12 +0,0 @@
-import { IRefProgramReward } from './IReferralProgram';
-export interface IInfluencer {
-    id: string;
-    programID: string;
-    name: string;
-    phoneNumber?: string;
-    email?: string;
-    customReward?: IRefProgramReward;
-    referralUrl: string;
-    createdAt: string;
-    updatedAt?: string;
-}

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

@@ -1,19 +0,0 @@
-interface ISocialNetworkStats {
-    facebook: number;
-    instagram: number;
-    tiktok: number;
-    youtube: number;
-}
-interface IOperatingSystemStats {
-    ios: number;
-    android: number;
-    web: number;
-}
-export interface IRefProgramStats {
-    linksGenerated: number;
-    linksUsed: number;
-    actionsTaken: number;
-    socialNetworkStats: ISocialNetworkStats;
-    operatingSystemStats: IOperatingSystemStats;
-}
-export {};

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

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

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

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

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

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

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

@@ -1,12 +0,0 @@
-import { IRefProgramReward } from './IReferralProgram';
-export interface IInfluencer {
-    id: string;
-    programID: string;
-    name: string;
-    phoneNumber?: string;
-    email?: string;
-    customReward?: IRefProgramReward;
-    referralUrl: string;
-    createdAt: string;
-    updatedAt?: string;
-}

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

@@ -1,19 +0,0 @@
-interface ISocialNetworkStats {
-    facebook: number;
-    instagram: number;
-    tiktok: number;
-    youtube: number;
-}
-interface IOperatingSystemStats {
-    ios: number;
-    android: number;
-    web: number;
-}
-export interface IRefProgramStats {
-    linksGenerated: number;
-    linksUsed: number;
-    actionsTaken: number;
-    socialNetworkStats: ISocialNetworkStats;
-    operatingSystemStats: IOperatingSystemStats;
-}
-export {};