@roketus/loyalty-js-sdk 4.35.0

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

@@ -0,0 +1,128 @@
+import { IHTTPClientResponse } from '@roketus/web-toolkit';
+import { JsonApiRequestDTO } from './JsonApiRequestDTO';
+export interface IAddPoints {
+    ({ cardNumber, description, amount }: {
+        cardNumber: string;
+        description: string;
+        amount: number;
+    }): Promise<IHTTPClientResponse<void>>;
+}
+export interface IAddReserve {
+    ({ amount }: {
+        amount: number;
+    }): Promise<IHTTPClientResponse<void>>;
+}
+export interface ICreateAnonymousUserCard {
+    (logoText?: string): Promise<{
+        cardNumber: string;
+        androidCardDownloadLink: string;
+        iosCardDownloadLink: string;
+        cardJwt: string;
+    }>;
+}
+export interface IGetAndroidCardDownloadLink {
+    (): Promise<string>;
+}
+export interface IDownloadIOSCard {
+    (): Promise<void>;
+}
+export interface IGetBalanceHistory {
+    (): Promise<IHTTPClientResponse<GetBalanceHistoryResponseDTO>>;
+}
+export interface IGetCardBalanceHistory {
+    ({ cardNumber }: {
+        cardNumber: string;
+    }): Promise<IHTTPClientResponse<GetBalanceHistoryResponseDTO>>;
+}
+export interface IGetReferral {
+    (): Promise<IHTTPClientResponse<GetReferralResponseDTO>>;
+}
+export interface IGetUserCard {
+    (): Promise<IHTTPClientResponse<GetUserCardResponseDTO>>;
+}
+export interface IRestoreCard {
+    (): Promise<unknown>;
+}
+export interface ISetTypeCard {
+    ({ cardNumber, type }: {
+        cardNumber: string;
+        type: string;
+    }): Promise<unknown>;
+}
+export interface ISpendPoints {
+    ({ cardNumber, description, amount }: {
+        cardNumber: string;
+        description: string;
+        amount: number;
+    }): Promise<IHTTPClientResponse<void>>;
+}
+export interface IUpdateCard {
+    ({ cardNumber, data }: {
+        cardNumber: string;
+        data: {
+            bonus?: string;
+            first_name?: string;
+            last_name?: string;
+        };
+        type?: string;
+    }): Promise<IHTTPClientResponse<void>>;
+}
+export interface IUpdateDiscountPercent {
+    ({ discountPercent, cardNumber }: {
+        cardNumber: string;
+        discountPercent: number;
+    }): Promise<unknown>;
+}
+export interface IDownloadAnonymousCard {
+    (issuer: string, referral_id?: string): Promise<unknown>;
+}
+export declare type DownloadAnonymousCardRequestDTO = JsonApiRequestDTO<{
+    issuer: string;
+    referral_id: string;
+}>;
+export interface GetBalanceHistoryResponseDTO {
+    data: [
+        {
+            id: string;
+            type: 'history';
+            attributes: {
+                Amount: number;
+                Balance: number;
+                CreatedAt: number;
+                Description: string;
+            };
+            relationships: Record<string, unknown>;
+        }
+    ];
+    included: [];
+}
+interface GetReferralResponseDTO {
+    data: [
+        {
+            id: string;
+            type: 'referral';
+            attributes: {
+                refId: string;
+            };
+        }
+    ];
+    included: [];
+}
+interface GetUserCardResponseDTO {
+    data: [
+        {
+            id: string;
+            type: 'card';
+            attributes: {
+                CardNumber: string;
+                CreatedAt: number;
+                BonusPercent: number;
+                Issuer: string;
+                Serial: string;
+                ValidTill: number;
+            };
+        }
+    ];
+    included: [];
+}
+export {};

package/dist/cjs/interfaces/cardManagement/ICard.d.ts

@@ -0,0 +1,27 @@
+import { IUser } from "../user/IUser";
+export interface ICardCustomParam {
+    pass_key: string;
+    value: string;
+    label: string;
+}
+export interface ICard {
+    id: string;
+    issuer: string;
+    pass_id: number;
+    serial: string;
+    card_number: string;
+    card_type: string;
+    user: IUser;
+    custom_params: ICardCustomParam[];
+    user_state: string;
+    currency: string;
+    status: string;
+    level: string;
+    created_at: number;
+    valid_till: number;
+    template_id: number;
+    current_balance: number;
+    bonus_percent: number;
+    cumulative_result: {};
+    purchase_discount_percent: number;
+}

package/dist/cjs/interfaces/cardManagement/cardManagementInterfaces.d.ts

@@ -0,0 +1,67 @@
+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 { ICard, ICardCustomParam } from './ICard';
+export interface ICardPayload {
+    first_name: string;
+    last_name: string;
+    phone: string;
+    email?: string;
+    expiration_date?: number;
+    custom_params?: ICardCustomParam[];
+}
+export interface CardRequestDTO {
+    data: {
+        attributes: ICardPayload;
+    };
+}
+export interface CardExpDateRequestDTO {
+    data: {
+        attributes: {
+            expiration_date: number | null;
+        };
+    };
+}
+export interface CardCustomParamsRequestDTO {
+    data: {
+        attributes: ICardCustomParam[];
+    };
+}
+export interface CardResponseDTO {
+    id: string;
+    type: string;
+    attributes: {
+        android_card_file_link: string;
+        card_number: string;
+        card_jwt: string;
+        created_at: number;
+        ios_card_file_link: string;
+        issuer: string;
+    };
+}
+export declare type CardJsonApiResponseDTO = I_JSON_API_Response_Many<CardResponseDTO>;
+export interface ICreateCard {
+    (payload: ICardPayload): Promise<ICard>;
+}
+export interface UpdateCardResponseDTO {
+    data: 'ok';
+}
+export interface IUpdateCardExpirationDate {
+    (id: string, data: {
+        expiration_date: number | null;
+    }): Promise<void>;
+}
+export interface IUpdateCardCustomParams {
+    (id: string, data: ICardCustomParam[]): Promise<void>;
+}
+export interface IIssueCard {
+    (id: string): Promise<void>;
+}
+export interface IDeactivateCard {
+    (id: string): Promise<void>;
+}
+export interface IListCards {
+    (params: IListFiltersPayload): Promise<IListCardsResponse>;
+}
+export declare type ListCardsResponseDTO = I_JSON_API_Response_Many<CardResponseDTO>;
+export declare type IListCardsResponse = I_Deserialized_List_Response_DTO<ICard>;

package/dist/cjs/interfaces/common/CurrencyCodeEnum.d.ts

@@ -0,0 +1,5 @@
+export declare enum CurrencyCode {
+    UAH = "UAH",
+    USD = "USD",
+    EUR = "EUR"
+}

package/dist/cjs/interfaces/common/NotificationChannelEnum.d.ts

@@ -0,0 +1,6 @@
+export declare enum NotificationChannel {
+    Email = "email",
+    Sms = "sms",
+    WebPush = "webPush",
+    PassPush = "passPush"
+}

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

@@ -0,0 +1,2 @@
+export * from './NotificationChannelEnum';
+export * from './CurrencyCodeEnum';

package/dist/cjs/interfaces/excludes/excludeInterfaces.d.ts

@@ -0,0 +1,43 @@
+import { I_JSON_API_Response_Single } from '../I_JSON_API_ResponseDTO';
+import { EProductSearchType } from '../products/productSearchInterfaces';
+export declare enum EExcludeType {
+    CASHBACK = "cashback",
+    BONUS_PAYMENT = "bonus_payment"
+}
+export interface IExcludePayload {
+    exclude_type: EExcludeType[];
+    exclude_param: EProductSearchType;
+    exclude_ids: string[];
+    description?: string;
+}
+export interface IExcludePayloadDTO {
+    data: {
+        attributes: IExcludePayload;
+    };
+}
+export interface IExcludeResponseAttributes {
+    creation_date: string;
+    description: string;
+    exclude_type: EExcludeType[];
+    param_type: EProductSearchType;
+    status: string;
+}
+export declare type TExcludeResponseDTO = I_JSON_API_Response_Single<IExcludeResponseAttributes>;
+export interface IExcludeProduct {
+    id: string;
+    title: string;
+}
+export interface IExclude {
+    id: string;
+    creation_date: string;
+    description: string;
+    exclude_type: EExcludeType[];
+    param_type: EProductSearchType;
+    status: string;
+    group?: IExcludeProduct[];
+    product?: IExcludeProduct[];
+}
+export declare type TCreateExclude = (payload: IExcludePayload) => Promise<IExclude>;
+export declare type TUpdateExclude = (id: string, payload: IExcludePayload) => Promise<IExclude>;
+export declare type TGetExclude = (id: string) => Promise<IExclude>;
+export declare type TDeleteExclude = (id: string) => Promise<void>;

package/dist/cjs/interfaces/excludes/listExcludesInterfaces.d.ts

@@ -0,0 +1,10 @@
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+import { IPaginationData } from '../requestFilterInterfaces';
+import { IListFiltersPayload } from '../requestFilterInterfaces';
+import { IExclude, IExcludeResponseAttributes } from './excludeInterfaces';
+export declare type TListExcludesResponseDTO = I_JSON_API_Response_Many<IExcludeResponseAttributes>;
+export interface IListExcludesResponse {
+    data: IExclude[];
+    meta: IPaginationData;
+}
+export declare type TListExcludes = (params: IListFiltersPayload) => Promise<IListExcludesResponse>;

package/dist/cjs/interfaces/issuer/IGetCardBonuses.d.ts

@@ -0,0 +1,23 @@
+import { IRequestWithCancelAndData } from '../IRequestWithCancelAndData';
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+export interface IGetCardBonuses {
+    (cardNumber: string): IRequestWithCancelAndData<IGetCardBonusesResponseDTO, I_JSON_API_Response_Many>;
+}
+export interface IGetCardBonus {
+    Date?: string;
+    Amount?: number;
+}
+export interface IGetCardBonusesResponseDTO {
+    activeWithDates: IGetCardBonus[];
+    inactiveWithDates: IGetCardBonus[];
+    totalActive: {
+        USD?: number;
+        UAH?: number;
+        EUR?: number;
+    };
+    totalInactive: {
+        USD?: number;
+        UAH?: number;
+        EUR?: number;
+    };
+}

package/dist/cjs/interfaces/issuer/IGetCardSpends.d.ts

@@ -0,0 +1,15 @@
+import { IRequestWithCancelAndData } from '../IRequestWithCancelAndData';
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+export interface IGetCardSpends {
+    (cardNumber: string): IRequestWithCancelAndData<IGetCardSpendsResponseDTO, IGetCardSpendsJSONAPIResponseDTO>;
+}
+export interface IGetCardSpendsAttributes {
+    id: string;
+    amount: string;
+    created: string;
+    currency: string;
+    description: string;
+    spendID: string;
+}
+export declare type IGetCardSpendsResponseDTO = IGetCardSpendsAttributes[];
+export declare type IGetCardSpendsJSONAPIResponseDTO = I_JSON_API_Response_Many<IGetCardSpendsAttributes>;

package/dist/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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>;