@roketus/loyalty-js-sdk 5.2.2 → 5.4.0

package/dist/cjs/interfaces/rewardProgram/IProgramRule.d.ts

@@ -0,0 +1,36 @@
+export declare type TProgramRuleTriggerEventType = 'custom_event' | 'inner_event' | string;
+export declare type TProgramRuleTriggerEventName = 'coupon_to_card' | 'order_closed' | 'referral_registered' | 'spent_bonus' | 'remove_bonus' | 'refund_transaction' | 'order_closed_issue_coupon' | string;
+export declare type TProgramRuleOutcomeEventType = 'add_transaction' | 'update_card' | 'add_points' | 'add_gift_bonuses' | 'spent_bonus' | 'remove_points' | 'send_notification' | 'refund_transaction' | 'order_closed_issue_coupon' | string;
+export interface IProgramRulePayloadUserAction {
+    Parameter: string;
+    Value: string;
+}
+export interface IProgramRulePayloadPoints {
+    Amount: number;
+    Description: string;
+}
+export interface IProgramRulePayloadNotification {
+    Notification: string;
+}
+export interface IProgramRulePayloadGiftBonuses {
+    currencyCode: string;
+    amount: string;
+    description: string;
+    Metadata?: unknown | null;
+}
+export declare type IProgramRuleDefaultPayload = IProgramRulePayloadUserAction | IProgramRulePayloadPoints | IProgramRulePayloadGiftBonuses | IProgramRulePayloadNotification | {
+    [key: string]: any;
+};
+export interface IProgramRuleOutcome {
+    eventType: TProgramRuleOutcomeEventType;
+    defaultPayload?: IProgramRuleDefaultPayload;
+}
+export interface IProgramRuleTrigger {
+    eventType: TProgramRuleTriggerEventType;
+    eventName: TProgramRuleTriggerEventName;
+}
+export interface IProgramRule {
+    id: string;
+    outcomes: IProgramRuleOutcome[] | null;
+    trigger: IProgramRuleTrigger;
+}

package/dist/cjs/interfaces/rewardProgram/IRewardProgram.d.ts

@@ -0,0 +1,16 @@
+import { IProgramRule } from './IProgramRule';
+export declare enum ERewardProgramType {
+    stateFullProgram = "stateFullProgram",
+    statelessRulesProgram = "statelessRulesProgram"
+}
+export declare enum ERewardProgramTitle {
+    SenseCardTransformation = "SenseCardTransformation",
+    referralSystemProgram = "referralSystemProgram"
+}
+export interface IRewardProgram {
+    id: string;
+    cumulativeProgram: object;
+    program_type: ERewardProgramType;
+    title: string;
+    rules?: IProgramRule[] | null;
+}

package/dist/cjs/interfaces/rewardProgram/ITier.d.ts

@@ -0,0 +1,6 @@
+import { ITierLevel } from './ITierLevel';
+export interface ITier {
+    id: string;
+    name: string;
+    tier_level: ITierLevel[];
+}

package/dist/cjs/interfaces/rewardProgram/ITierLevel.d.ts

@@ -0,0 +1,17 @@
+export interface ITierLevel {
+    id: string;
+    name: string;
+    benefits: {
+        bonus_activation_period: number;
+        bonus_expiration_period: number;
+        bonus_percent_amount: number;
+        max_bonus_redeem_percent: number;
+        template_id: string;
+    };
+    condition: {
+        ConditionType: string;
+        Payload: {
+            MinAmount: number;
+        };
+    };
+}

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

@@ -0,0 +1,7 @@
+export * from './IProgramRule';
+export * from './IRewardProgram';
+export * from './ITier';
+export * from './ITierLevel';
+export { ICreateRewardProgramPayload, IUpdateRewardProgramPayload, } from './rewardProgramInterfaces';
+export { IAddProgramRulePayload } from './programRulesInterfaces';
+export { ICreateTierPayload, ITierLevelPayload } from './tierInterfaces';

package/dist/cjs/interfaces/rewardProgram/programRulesInterfaces.d.ts

@@ -0,0 +1,30 @@
+import { AxiosResponse } from 'axios';
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+import { IProgramRule, TProgramRuleOutcomeEventType, TProgramRuleTriggerEventName, TProgramRuleTriggerEventType } from './IProgramRule';
+export interface IAddProgramRulePayload {
+    trigger: {
+        event_type: TProgramRuleTriggerEventType;
+        event_name: TProgramRuleTriggerEventName;
+    };
+    outcomes: {
+        action_type: TProgramRuleOutcomeEventType;
+        default_payload?: {
+            [key: string]: any;
+        };
+    }[];
+}
+export interface AddProgramRuleRequestDTO {
+    data: {
+        attributes: IAddProgramRulePayload;
+    };
+}
+export declare type ProgramRuleResponseDTO = I_JSON_API_Response_Many<IProgramRule>;
+export interface IAddProgramRule {
+    (programId: string, payload: IAddProgramRulePayload): Promise<AxiosResponse<void>>;
+}
+export interface IUpdateProgramRule {
+    (programId: string, payload: IAddProgramRulePayload): Promise<AxiosResponse<void>>;
+}
+export interface IRemoveProgramRule {
+    (programId: string, ruleId: string): Promise<AxiosResponse<void>>;
+}

package/dist/cjs/interfaces/rewardProgram/rewardProgramInterfaces.d.ts

@@ -0,0 +1,39 @@
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+import { ERewardProgramType, IRewardProgram } from './IRewardProgram';
+import { AxiosResponse } from 'axios';
+export interface ICreateRewardProgramPayload {
+    program_type: ERewardProgramType;
+    title: string;
+}
+export interface CreateRewardProgramRequestDTO {
+    data: {
+        attributes: ICreateRewardProgramPayload;
+    };
+}
+export declare type RewardProgramResponseDTO = I_JSON_API_Response_Many<IRewardProgram>;
+export interface ICreateRewardProgram {
+    (payload: ICreateRewardProgramPayload): Promise<IRewardProgram>;
+}
+export interface IUpdateRewardProgramPayload {
+    title: string;
+}
+export interface UpdateRewardProgramRequestDTO {
+    data: {
+        attributes: IUpdateRewardProgramPayload;
+    };
+}
+export interface IUpdateRewardProgram {
+    (id: string, payload: IUpdateRewardProgramPayload): Promise<IRewardProgram>;
+}
+export interface IDeleteRewardProgram {
+    (id: string): Promise<AxiosResponse<void>>;
+}
+export interface IListRewardPrograms {
+    (): Promise<IRewardProgram[]>;
+}
+export interface IGetRewardProgram {
+    (id: string): Promise<IRewardProgram>;
+}
+export interface IGetRewardProgramByTitle {
+    (title: string): Promise<IRewardProgram>;
+}

package/dist/cjs/interfaces/rewardProgram/tierInterfaces.d.ts

@@ -0,0 +1,38 @@
+import { AxiosResponse } from 'axios';
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+import { ITier } from './ITier';
+export interface ITierLevelPayload {
+    name: string;
+    benefits: {
+        bonus_activation_period: number;
+        bonus_expiration_period: number;
+        bonus_percent_amount: number;
+        max_bonus_redeem_percent: number;
+        template_id: string;
+    };
+    condition: {
+        condition_type: string;
+        payload: {
+            min_amount: number;
+        };
+    };
+}
+export interface ICreateTierPayload {
+    name: string;
+    levels: ITierLevelPayload[];
+}
+export interface CreateTierRequestDTO {
+    data: {
+        attributes: ICreateTierPayload;
+    };
+}
+export declare type TierResponseDTO = I_JSON_API_Response_Many<ITier>;
+export interface ICreateTier {
+    (payload: ICreateTierPayload): Promise<ITier>;
+}
+export interface IDeleteTier {
+    (id: string): Promise<AxiosResponse<void>>;
+}
+export interface IListTiers {
+    (): Promise<ITier[]>;
+}

package/dist/esm5/api/issuer/authByPassToken.d.ts

@@ -1,2 +1,2 @@
-import type { IAuthByPassToken } from '../../interfaces/issuerInterface';
+import type { IAuthByPassToken } from '../../interfaces/issuer/issuerInterface';
 export declare const authByPassToken: IAuthByPassToken;

package/dist/esm5/api/issuer/authByToken.d.ts

@@ -1,2 +1,2 @@
-import type { IAuthByToken } from '../../interfaces/issuerInterface';
+import type { IAuthByToken } from '../../interfaces/issuer/issuerInterface';
 export declare const authByToken: IAuthByToken;

package/dist/esm5/api/issuer/createIssuer.d.ts

@@ -1,2 +1,2 @@
-import type { ICreateIssuer } from '../../interfaces/issuerInterface';
+import type { ICreateIssuer } from '../../interfaces/issuer/issuerInterface';
 export declare const createIssuer: ICreateIssuer;

package/dist/esm5/api/issuer/dispatchCustomEvent.d.ts

@@ -1,2 +1,2 @@
-import { IDispatchCustomEvent } from '../../interfaces/issuerInterface';
+import { IDispatchCustomEvent } from '../../interfaces/issuer/issuerInterface';
 export declare const dispatchCustomEvent: IDispatchCustomEvent;

package/dist/esm5/api/issuer/getCardById.d.ts

@@ -1,2 +1,2 @@
-import { IGetCardById } from '../../interfaces/issuerInterface';
+import { IGetCardById } from '../../interfaces/issuer/issuerInterface';
 export declare const getCardById: IGetCardById;

package/dist/esm5/api/issuer/getCardByPhone.d.ts

@@ -1,2 +1,2 @@
-import { IGetCardByPhone } from '../../interfaces/issuerInterface';
+import { IGetCardByPhone } from '../../interfaces/issuer/issuerInterface';
 export declare const getCardByPhone: IGetCardByPhone;

package/dist/esm5/api/issuer/getIssuer.d.ts

@@ -1,2 +1,2 @@
-import type { IGetIssuer } from '../../interfaces/issuerInterface';
+import type { IGetIssuer } from '../../interfaces/issuer/issuerInterface';
 export declare const getIssuer: IGetIssuer;

package/dist/esm5/api/issuer/getSettings.d.ts

@@ -0,0 +1,2 @@
+import type { IGetSettings } from '../../interfaces/issuer/issuerInterface';
+export declare const getSettings: IGetSettings;

package/dist/esm5/api/issuer/refreshApiKey.d.ts

@@ -1,2 +1,2 @@
-import type { IRefreshApiKey } from '../../interfaces/issuerInterface';
+import type { IRefreshApiKey } from '../../interfaces/issuer/issuerInterface';
 export declare const refreshApiKey: IRefreshApiKey;

package/dist/esm5/api/issuer/resultSerializer.d.ts

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

package/dist/esm5/api/issuer/sendNotificationToCards.d.ts

@@ -1,2 +1,2 @@
-import type { ISendNotificationToCards } from '../../interfaces/issuerInterface';
+import type { ISendNotificationToCards } from '../../interfaces/issuer/issuerInterface';
 export declare const sendNotificationToCards: ISendNotificationToCards;

package/dist/esm5/api/issuer/sendPushNotification.d.ts

@@ -1,3 +1,3 @@
-import type { ISendPushNotification } from '../../interfaces/issuerInterface';
+import type { ISendPushNotification } from '../../interfaces/issuer/issuerInterface';
 /** @deprecated */
 export declare const sendPushNotification: ISendPushNotification;

package/dist/esm5/api/issuer/sendToAllIssuerCards.d.ts

@@ -1,2 +1,2 @@
-import type { ISendToAllIssuerCards } from '../../interfaces/issuerInterface';
+import type { ISendToAllIssuerCards } from '../../interfaces/issuer/issuerInterface';
 export declare const sendToAllIssuerCards: ISendToAllIssuerCards;

package/dist/esm5/api/issuer/setCardName.d.ts

@@ -1,2 +1,2 @@
-import { ISetCardName } from '../../interfaces/issuerInterface';
+import { ISetCardName } from '../../interfaces/issuer/issuerInterface';
 export declare const setCardName: ISetCardName;

package/dist/esm5/api/issuer/setSettings.d.ts

@@ -1,2 +1,2 @@
-import type { ISetSettings } from '../../interfaces/issuerInterface';
+import type { ISetSettings } from '../../interfaces/issuer/issuerInterface';
 export declare const setSettings: ISetSettings;

package/dist/esm5/api/rewardProgram/createProgram.d.ts

@@ -0,0 +1,2 @@
+import type { ICreateRewardProgram } from '../../interfaces/rewardProgram/rewardProgramInterfaces';
+export declare const createProgram: ICreateRewardProgram;

package/dist/esm5/api/rewardProgram/deleteProgram.d.ts

@@ -0,0 +1,2 @@
+import type { IDeleteRewardProgram } from '../../interfaces/rewardProgram/rewardProgramInterfaces';
+export declare const deleteProgram: IDeleteRewardProgram;

package/dist/esm5/api/rewardProgram/getProgram.d.ts

@@ -0,0 +1,2 @@
+import type { IGetRewardProgram } from '../../interfaces/rewardProgram/rewardProgramInterfaces';
+export declare const getProgram: IGetRewardProgram;

package/dist/esm5/api/rewardProgram/getProgramByTitle.d.ts

@@ -0,0 +1,2 @@
+import type { IGetRewardProgramByTitle } from '../../interfaces/rewardProgram/rewardProgramInterfaces';
+export declare const getProgramByTitle: IGetRewardProgramByTitle;

package/dist/esm5/api/rewardProgram/listPrograms.d.ts

@@ -0,0 +1,2 @@
+import type { IListRewardPrograms } from '../../interfaces/rewardProgram/rewardProgramInterfaces';
+export declare const listPrograms: IListRewardPrograms;

package/dist/esm5/api/rewardProgram/resultSerializer.d.ts

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

package/dist/esm5/api/rewardProgram/rules/addRule.d.ts

@@ -0,0 +1,2 @@
+import type { IAddProgramRule } from '../../../interfaces/rewardProgram/programRulesInterfaces';
+export declare const addRule: IAddProgramRule;

package/dist/esm5/api/rewardProgram/rules/removeRule.d.ts

@@ -0,0 +1,2 @@
+import type { IRemoveProgramRule } from '../../../interfaces/rewardProgram/programRulesInterfaces';
+export declare const removeRule: IRemoveProgramRule;

package/dist/esm5/api/rewardProgram/rules/updateRule.d.ts

@@ -0,0 +1,2 @@
+import type { IUpdateProgramRule } from '../../../interfaces/rewardProgram/programRulesInterfaces';
+export declare const updateRule: IUpdateProgramRule;

package/dist/esm5/api/rewardProgram/tiers/createTier.d.ts

@@ -0,0 +1,2 @@
+import type { ICreateTier } from '../../../interfaces/rewardProgram/tierInterfaces';
+export declare const createTier: ICreateTier;

package/dist/esm5/api/rewardProgram/tiers/deleteTier.d.ts

@@ -0,0 +1,2 @@
+import type { IDeleteTier } from '../../../interfaces/rewardProgram/tierInterfaces';
+export declare const deleteTier: IDeleteTier;

package/dist/esm5/api/rewardProgram/tiers/listTiers.d.ts

@@ -0,0 +1,2 @@
+import type { IListTiers } from '../../../interfaces/rewardProgram/tierInterfaces';
+export declare const listTiers: IListTiers;

package/dist/esm5/api/rewardProgram/tiers/resultSerializer.d.ts

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

package/dist/esm5/api/rewardProgram/updateProgram.d.ts

@@ -0,0 +1,2 @@
+import type { IUpdateRewardProgram } from '../../interfaces/rewardProgram/rewardProgramInterfaces';
+export declare const updateProgram: IUpdateRewardProgram;

package/dist/esm5/clients/setIssuerToken.d.ts

@@ -1,2 +1,2 @@
-import type { ISetIssuerToken } from '../interfaces/issuerInterface';
+import type { ISetIssuerToken } from '../interfaces/issuer/issuerInterface';
 export declare const setIssuerToken: ISetIssuerToken;

package/dist/esm5/index.d.ts

@@ -7,7 +7,7 @@ export * from './interfaces/campaigns';
 export * from './interfaces/analyticsInterfaces';
 export * from './interfaces/telemetryInterfaces';
 export * from './interfaces/urlInterfaces';
-export * from './interfaces/issuerInterface';
+export * from './interfaces/issuer';
 export * from './interfaces/shortLinkInterface';
 export * from './interfaces/authInterfaces';
 export * from './interfaces/user';
@@ -17,8 +17,6 @@ export * from './interfaces/signupInterface';
 export { NotificationChannel } from './interfaces/common';
 export { CurrencyCode } from './interfaces/common';
 export * from './interfaces/messengerHub/ISendTelegramMsg';
-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';
@@ -30,5 +28,6 @@ export * from './interfaces/requestFilterInterfaces';
 export * from './interfaces/cardManagement';
 export * from './interfaces/order/orderInterfaces';
 export * from './interfaces/referralProgram';
+export * from './interfaces/rewardProgram';
 export * from './interfaces/cohorts';
 export * from './interfaces/messengerHub';