@roketus/loyalty-js-sdk 4.35.0

package/dist/esm5/interfaces/issuerInterface.d.ts

@@ -0,0 +1,195 @@
+import { IHTTPClientResponse } from '@roketus/web-toolkit';
+import { IRequestWithCancelAndData } from './IRequestWithCancelAndData';
+import { I_JSON_API_Response_Many } from './I_JSON_API_ResponseDTO';
+export interface IAuthByPassTokenResponseDTO {
+    data: {
+        attributes: {
+            jwt: string;
+            name: string;
+        };
+    }[];
+}
+export interface IAuthByPassToken {
+    (passServiceIssuerToken: string): Promise<IHTTPClientResponse<IAuthByPassTokenResponseDTO>>;
+}
+export interface IAuthByToken {
+    ({ token }: {
+        token: string;
+    }): Promise<unknown>;
+}
+export interface ICreateIssuer {
+    ({ name, systemName }: {
+        name: string;
+        systemName: string;
+    }): Promise<IHTTPClientResponse<CreateIssuerResponseDTO>>;
+}
+export interface IGetIssuer {
+    (): Promise<GetIssuerResponseDTO>;
+}
+export interface IRefreshApiKey {
+    (): Promise<IHTTPClientResponse<RefreshApiKeyResponseDTO>>;
+}
+export interface ISendNotificationToCards {
+    (params: ISendNotificationToCardsParams): Promise<IHTTPClientResponse<SendNotificationToCardsResponseDTO>>;
+}
+/** @deprecated */
+export interface ISendPushNotification {
+    (userId: string, title: string, message: string): Promise<IHTTPClientResponse<void>>;
+}
+export interface ISendToAllIssuerCards {
+    (params: ISendToAllIssuerCardsParams): Promise<IHTTPClientResponse<unknown>>;
+}
+export interface ISetCardName {
+    ({ cardNumber, data }: {
+        cardNumber: string;
+        data: {
+            first_name?: string;
+            last_name?: string;
+        };
+    }): Promise<IHTTPClientResponse<void>>;
+}
+export interface ISetSettings {
+    ({ templateId }: {
+        templateId: number;
+    }): Promise<IHTTPClientResponse<SetSettingsResponseDTO>>;
+}
+export interface ISetIssuerToken {
+    (token: string): void;
+}
+export declare type IGetCardByPhoneResponseDTO = IGetCardByIdResponseDTO;
+export interface IGetCardByPhone {
+    (phoneNumber: string): IRequestWithCancelAndData<IGetCardByPhoneResponseDTO, I_JSON_API_Response_Many>;
+}
+export declare type GatewayType = 'sms' | 'email' | 'iosPush' | 'androidPush' | 'passPush' | 'webPush';
+interface CreateIssuerResponseDTO {
+    data: [
+        {
+            attributes: {
+                completed: boolean;
+                completed_required: boolean;
+                nextStep: string;
+                nextStepSkippable: boolean;
+                type: string;
+            };
+            id: string;
+            relationships: Record<string, unknown>;
+            type: 'activation';
+        }
+    ];
+    included: [Record<string, unknown>];
+}
+interface GetIssuerResponseDTO {
+    data: [
+        {
+            attributes: {
+                settings: {
+                    templateID: number;
+                };
+                systemName: string;
+            };
+            relationships: Record<string, unknown>;
+        }
+    ];
+    included: [];
+}
+interface RefreshApiKeyResponseDTO {
+    data: [
+        {
+            id: string;
+            type: 'issuer';
+            attributes: {
+                createdAt: number;
+                name: string;
+                passKey: string;
+                settings: {
+                    cardTypes: Record<string, unknown>;
+                    currencyName: string;
+                    templateID: number;
+                };
+                systemName: string;
+            };
+        }
+    ];
+    included: [];
+}
+interface ISendNotificationToCardsParams {
+    cardNumbers: string[];
+    message: string;
+    smart?: boolean;
+    channels?: GatewayType[];
+}
+interface SendNotificationToCardsResponseDTO {
+    data: {
+        attributes: {
+            card_send: string[];
+            card_error: string[];
+        };
+    }[];
+}
+interface ISendToAllIssuerCardsParams {
+    title: string;
+    message: string;
+    channels?: GatewayType[];
+}
+interface SetSettingsResponseDTO {
+    data: [
+        {
+            id: string;
+            attributes: {
+                template_id: number;
+            };
+        }
+    ];
+    included: [];
+}
+export interface ICustomEventAction {
+    action_type: string;
+    payload: Record<string, string | number | Record<string, string | number>>;
+}
+export interface DispatchCustomEventDTO {
+    data: {
+        attributes: {
+            card_number: string;
+            event_name: string;
+            payloads?: ICustomEventAction[];
+        };
+    };
+}
+export interface IDispatchCustomEvent {
+    (data: {
+        card: string;
+        eventName: string;
+        actions?: ICustomEventAction[];
+    }): Promise<void>;
+}
+export interface ICardPromocode {
+    ID: string;
+    Name: string;
+    Description: string;
+    CountOfUse: number;
+}
+export declare enum ECardType {
+    GENERAL = "general",
+    ANONYMOUS = "coupon"
+}
+export interface IGetCardByIdResponseDTO {
+    id: string;
+    CardType: ECardType;
+    CardNumber: string;
+    CreatedAt: number;
+    CumulativeResult: Record<string, never> | string;
+    CurrentBalance?: number;
+    BonusPercent: number;
+    PurchaseDiscountPercent?: number;
+    Issuer: string;
+    NameOnCard: string;
+    Serial: string;
+    TemplateId: number;
+    ValidTill: number;
+    Level: string;
+    Promocodes?: ICardPromocode[];
+}
+export interface IGetCardById {
+    (cardNumber: string): IRequestWithCancelAndData<IGetCardByIdResponseDTO, I_JSON_API_Response_Many>;
+}
+export {};

package/dist/esm5/interfaces/json.d.ts

@@ -0,0 +1,5 @@
+export declare type JSONValue = string | number | boolean | JSONObject | JSONArray;
+export interface JSONObject {
+    [x: string]: JSONValue;
+}
+export declare type JSONArray = Array<JSONValue>;

package/dist/esm5/interfaces/loggerInterface.d.ts

@@ -0,0 +1,19 @@
+import { IHTTPClientResponse } from '@roketus/web-toolkit';
+import { JSONObject } from './json';
+export interface ILoggerConfig {
+    serviceName: string;
+    environment: 'develop' | 'stage' | 'production';
+}
+export interface ILoggerSetup {
+    (config: ILoggerConfig): void;
+}
+export interface ILogFn {
+    (data: JSONObject, correlation_id?: string): Promise<IHTTPClientResponse<void>>;
+}
+export interface LogRequestDTO {
+    timestamp: string;
+    correlation_id: string;
+    service_name: string;
+    env: string;
+    payload: JSONObject;
+}

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

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

package/dist/esm5/interfaces/order/orderInterfaces.d.ts

@@ -0,0 +1,101 @@
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+export declare enum EOrderState {
+    NEW = "new",
+    CLOSED = "closed"
+}
+export declare enum EOrderDiscountType {
+    COUPON = "coupon",
+    BONUS = "bonus",
+    PERCENTAGE = "percentage",
+    USER_PROMO_CODE = "userPromoCode",
+    PROMO_CODE = "promoCode"
+}
+export interface IOrderDiscount {
+    code?: string;
+    amount?: number;
+    type: string;
+}
+interface IOrderReceiptItem {
+    discount: number;
+    discount_price: number;
+    discount_total_price: number;
+    inner_product_id: string;
+    name: string;
+    price: number;
+    product_id: string;
+    quantity: number;
+    total_price: number;
+}
+interface IOrderReceipt {
+    discount_total_price: number;
+    total_price: number;
+    receipt_item?: IOrderReceiptItem;
+}
+interface IOrderConsumer {
+    phone: string;
+}
+export interface IOrderAttributes {
+    id: string;
+    order_id: string;
+    state: EOrderState;
+    total_price: number;
+    discount_total_price: number;
+    date_closing: string;
+    date_opening: string;
+    discounts: IOrderDiscount[];
+}
+export interface IOrder extends IOrderAttributes {
+    receipt?: IOrderReceipt;
+    consumer?: IOrderConsumer;
+}
+declare type ConsumerCredentialType = 'consumer_id' | 'card_number' | 'phone';
+export declare type TCouponDiscountPayload = {
+    type: EOrderDiscountType.COUPON;
+    code: string;
+};
+export declare type TPromoDiscountPayload = {
+    type: EOrderDiscountType.USER_PROMO_CODE | EOrderDiscountType.PROMO_CODE;
+    code: string;
+};
+export declare type TBonusDiscountPayload = {
+    type: EOrderDiscountType.BONUS;
+    amount: number;
+    apply_method: 'proportionalToItems' | 'toTotalPrice';
+};
+export declare type TPercentageDiscountPayload = {
+    type: EOrderDiscountType.PERCENTAGE;
+    percent: number;
+};
+export declare type TOrderDiscountPayload = TCouponDiscountPayload | TPromoDiscountPayload | TBonusDiscountPayload | TPercentageDiscountPayload;
+export interface IOrderProductPayload {
+    product_id: string;
+    receipt_name: string;
+    price: number;
+    quantity: number;
+    unit_of_measure: string;
+    ean_code: string;
+}
+export declare type TOrderConsumerPayload = {
+    credential: ConsumerCredentialType;
+    value: string;
+} | {};
+export interface IOpenOrderPayload {
+    order_id: string;
+    date_opening: string;
+    total_price: number;
+    consumer: TOrderConsumerPayload;
+    discounts?: TOrderDiscountPayload[];
+    receipts: {
+        receipt_id: string;
+        items: IOrderProductPayload[];
+    }[];
+}
+export interface IOpenOrderPayloadDTO {
+    data: {
+        attributes: IOpenOrderPayload;
+    };
+}
+export declare type TOrderResponseDTO = I_JSON_API_Response_Many<IOrderAttributes>;
+export declare type TOpenOrder = (payload: IOpenOrderPayload) => Promise<IOrder>;
+export declare type TCloseOrder = (id: string) => Promise<IOrder>;
+export {};

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

@@ -0,0 +1,4 @@
+import { I_JSON_API_Response_Single } from '../I_JSON_API_ResponseDTO';
+import { ICategory } from './categoryInterfaces';
+export declare type TGetCategoryByIdResponseDTO = I_JSON_API_Response_Single<ICategory>;
+export declare type TGetCategoryById = (id: string) => Promise<ICategory>;

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

@@ -0,0 +1,4 @@
+import { I_JSON_API_Response_Single } from '../I_JSON_API_ResponseDTO';
+import { IProduct } from './productInterfaces';
+export declare type TGetProductByIdResponseDTO = I_JSON_API_Response_Single<IProduct>;
+export declare type TGetProductById = (id: string) => Promise<IProduct>;

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

@@ -0,0 +1,11 @@
+import { I_JSON_API_Response_Single } from '../I_JSON_API_ResponseDTO';
+export interface ICategoryResponseAttributes {
+    description: string;
+    title: string;
+}
+export declare type TCategoryResponseDTO = I_JSON_API_Response_Single<ICategoryResponseAttributes>;
+export interface ICategory {
+    id: string;
+    description: string;
+    title: string;
+}

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

@@ -0,0 +1,13 @@
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+import { IPaginationData } from '../requestFilterInterfaces';
+import { ICategory, ICategoryResponseAttributes } from './categoryInterfaces';
+export declare type TListCategoriesResponseDTO = I_JSON_API_Response_Many<ICategoryResponseAttributes>;
+export interface IListCategoriesResponse {
+    data: ICategory[];
+    meta: IPaginationData;
+}
+export declare type TListCategories = ({ page, pageSize, search, }: {
+    page?: number;
+    pageSize?: number;
+    search?: string;
+}) => Promise<IListCategoriesResponse>;

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

@@ -0,0 +1,13 @@
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+import { IPaginationData } from '../requestFilterInterfaces';
+import { IProduct, IProductResponseAttributes } from './productInterfaces';
+export declare type TListProductsResponseDTO = I_JSON_API_Response_Many<IProductResponseAttributes>;
+export interface IListProductsResponse {
+    data: IProduct[];
+    meta: IPaginationData;
+}
+export declare type TListProducts = ({ page, pageSize, search, }: {
+    page?: number;
+    pageSize?: number;
+    search?: string;
+}) => Promise<IListProductsResponse>;

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

@@ -0,0 +1,39 @@
+import { I_JSON_API_Response_Single } from '../I_JSON_API_ResponseDTO';
+interface IProductExternalinfo {
+    brand_id: string;
+    image: string;
+    is_fractional: boolean;
+    product_group_id: string;
+    product_id: string;
+    receipt_name: string;
+    vat: string;
+    vat_operation: string;
+}
+export interface IProductResponseAttributes {
+    description: string;
+    external_info: IProductExternalinfo;
+    unit_of_measure: string;
+    vendor_code: string;
+}
+export declare type TProductResponseDTO = I_JSON_API_Response_Single<IProductResponseAttributes>;
+export interface IProductBrand {
+    id: string;
+    name: string;
+}
+export interface IProductModel {
+    id: string;
+    description: string;
+    name: string;
+    brand: IProductBrand[];
+    properties: any[];
+}
+export interface IProduct {
+    id: string;
+    description: string;
+    external_info: IProductExternalinfo;
+    unit_of_measure: string;
+    vendor_code: string;
+    model: IProductModel[];
+    properties: any[];
+}
+export {};

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

@@ -0,0 +1,4 @@
+export declare enum EProductSearchType {
+    PRODUCT = "product",
+    GROUP = "group"
+}

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

@@ -0,0 +1,15 @@
+import { EPromocodeDiscountType } from './IPromocode';
+export interface ICreatePromocodePayload {
+    name: string;
+    description: string;
+    startAt: string;
+    stopAt: string;
+    activationLimit: number;
+    discountType: EPromocodeDiscountType;
+    discountValue: number;
+    product_ids: string[];
+    product_group_ids: string[];
+    is_auto_apply?: boolean;
+    apply_to_all_items?: boolean;
+    after_apply_events?: boolean;
+}

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

@@ -0,0 +1,30 @@
+export declare enum EPromocodeStatus {
+    STARTED = "started",
+    NOT_STARTED = "notStarted",
+    COMPLETED = "completed",
+    DISABLED = "disabled",
+    ARCHIVED = "archived"
+}
+export declare enum EPromocodeDiscountType {
+    PERCENT = "percent",
+    PRODUCT_PRICE = "product_price",
+    N_PLUS_1 = "buy_n_get_one_free"
+}
+export interface IPromocode {
+    id: string;
+    name: string;
+    description: string;
+    discountType: EPromocodeDiscountType;
+    discountValue: number;
+    activationAmount: number;
+    activationLimit: number;
+    productGroupIds?: string[];
+    productIds?: string[];
+    startAt: number;
+    stopAt: number;
+    enabled: boolean;
+    archived: boolean;
+    status: EPromocodeStatus;
+    createdAt: number;
+    updatedAt: number;
+}

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

@@ -0,0 +1,14 @@
+import { EPromocodeDiscountType } from './IPromocode';
+export interface IUpdatePromocodePayload {
+    description: string;
+    startAt: string;
+    stopAt: string;
+    activationLimit: number;
+    discountType: EPromocodeDiscountType;
+    discountValue: number;
+    product_ids: string[];
+    product_group_ids: string[];
+    is_auto_apply?: boolean;
+    apply_to_all_items?: boolean;
+    after_apply_events?: boolean;
+}

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

@@ -0,0 +1,27 @@
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+import { IListFiltersPayload, IPaginationData } from '../requestFilterInterfaces';
+import { IPromocode } from './IPromocode';
+import { ICreatePromocodePayload } from './ICreatePromocodePayload';
+import { IUpdatePromocodePayload } from './IUpdatePromocodePayload';
+export declare type TPromocodeResponseDTO = I_JSON_API_Response_Many<IPromocode>;
+export interface IListPromocodesResponse {
+    data: IPromocode[];
+    meta: IPaginationData;
+}
+export declare type TListPromocodes = (params: IListFiltersPayload) => Promise<IListPromocodesResponse>;
+export declare type TGetPromocodeById = (id: string) => Promise<IPromocode>;
+export declare type TUsePromocode = (id: string) => Promise<void>;
+export interface ICreatePromocodeRequestDTO {
+    data: {
+        attributes: ICreatePromocodePayload;
+    };
+}
+export declare type TCreatePromocode = (payload: ICreatePromocodePayload) => Promise<IPromocode>;
+export interface IUpdatePromocodeRequestDTO {
+    data: {
+        attributes: IUpdatePromocodePayload;
+    };
+}
+export declare type TUpdatePromocode = (id: string, payload: IUpdatePromocodePayload) => Promise<void>;
+export declare type TArchivePromocode = (id: string) => Promise<void>;
+export declare type TUnarchivePromocode = (id: string) => Promise<void>;

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

@@ -0,0 +1,12 @@
+import { ERefProgramActionType, ERefProgramStatus, ERefProgramType, IRefProgramReward } from './IReferralProgram';
+export interface ICreateRefProgramPayload {
+    name: string;
+    description: string;
+    startAt: string;
+    stopAt?: string;
+    status?: ERefProgramStatus;
+    programType: ERefProgramType;
+    triggerAction: ERefProgramActionType;
+    influencer?: IRefProgramReward;
+    customer?: IRefProgramReward;
+}

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

@@ -0,0 +1,7 @@
+import { IRefProgramReward } from "./IReferralProgram";
+export interface IInfluencerPayload {
+    name: string;
+    phoneNumber: string;
+    email: string;
+    customReward?: IRefProgramReward;
+}

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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,19 @@
+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/interfaces/referralProgram/IReferralProgram.d.ts

@@ -0,0 +1,51 @@
+export declare enum ERefProgramStatus {
+    CREATED = "created",
+    ACTIVE = "active",
+    ARCHIVED = "archived"
+}
+export declare enum ERefProgramType {
+    REGULAR = "regular",
+    INFLUENCER = "influencer"
+}
+export declare enum ERefProgramActionType {
+    REGISTRATION = "registration",
+    PURCHASE = "purchase"
+}
+export declare enum ERefProgramRewardType {
+    BONUS = "bonus",
+    COUPON = "coupon"
+}
+export interface IRefProgramBonusReward {
+    bonusAmount: number;
+}
+export interface IRefProgramCouponReward {
+    name: string;
+    promo_code_id: string;
+    allowed_uses: number;
+}
+export interface IRefProgramReward {
+    rewardType: ERefProgramRewardType;
+    reward: Array<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;
+    status: ERefProgramStatus;
+    programType?: ERefProgramType;
+}

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

@@ -0,0 +1,9 @@
+import { IRefProgramReward } from "./IReferralProgram";
+export interface IUpdateRefProgramPayload {
+    name?: string;
+    description?: string;
+    startAt?: string;
+    stopAt?: string;
+    influencer?: IRefProgramReward;
+    customer?: IRefProgramReward;
+}

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

@@ -0,0 +1,35 @@
+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;
+    };
+}
+export declare type InfluencerResponseDTO = I_JSON_API_Response_Single<IInfluencer>;
+export interface IAddInfluencer {
+    (programId: string, payload: IInfluencerPayload): Promise<IInfluencer>;
+}
+export interface UpdateInfluencerResponseDTO {
+    data: 'ok';
+}
+export interface IUpdateInfluencer {
+    (programId: string, influencerId: string, payload: IInfluencerPayload): Promise<void>;
+}
+export interface IDeleteInfluencer {
+    (programId: string, influencerId: string): Promise<void>;
+}
+export declare type ListInfluencersResponseDTO = I_JSON_API_Response_Many<IInfluencer>;
+export declare type IListInfluencersResponse = I_Deserialized_List_Response_DTO<IInfluencer>;
+export interface IListInfluencers {
+    (programId: string, params: IListFiltersPayload): Promise<IListInfluencersResponse>;
+}
+export interface IGetInfluencer {
+    (programId: string, influencerId: string): Promise<IInfluencer>;
+}
+export interface IGetStatsByInfluencer {
+    (programId: string, influencerId: string): Promise<IRefProgramStats>;
+}