@roketus/loyalty-js-sdk 4.35.0

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

@@ -0,0 +1,39 @@
+import { IHTTPClientResponse } from '@roketus/web-toolkit';
+import { ActivationResponseDTO } from './signupInterface';
+export interface IGetUserTokenByIssuerAPIKey {
+    (apiKey: string): Promise<string>;
+}
+export interface IGetUserData {
+    (): Promise<getUserDataResponseDTO>;
+}
+export interface ISignInByPhone {
+    (phoneNumber: string): Promise<CreateAnonymousCardResponseDTO>;
+}
+export interface IValidatePhoneOtp {
+    (phoneNumber: string, code: number): Promise<IHTTPClientResponse<ActivationResponseDTO>>;
+}
+interface getUserDataResponseDTO {
+    createdAt: string;
+    email: string;
+    emailVerified: boolean;
+    phone: string;
+    phoneVerified: boolean;
+}
+interface CreateAnonymousCardResponseDTO {
+    data: [
+        {
+            id: string;
+            type: 'card';
+            attributes: {
+                android_card_file_link: string;
+                card_number: string;
+                created_at: number;
+                ios_card_file_link: string;
+                issuer: string;
+            };
+            relationships: Record<string, unknown>;
+        }
+    ];
+    included: [];
+}
+export {};

package/dist/esm5/interfaces/campaigns/campaignInterfaces.d.ts

@@ -0,0 +1,174 @@
+import { IHTTPClientResponse } from '@roketus/web-toolkit';
+import { ICampaignEmailAttributes, ICampaignJSONAPIDTO, ICampaignPassPushAttributes, ICampaignSMSAttributes, ICampaignWebPushAttributes } from './common';
+export interface ICreateCampaign {
+    ({ name }: {
+        name: string;
+    }): Promise<IHTTPClientResponse<CreateCampaignResponseDTO>>;
+}
+export interface ISetCohortToCampaign {
+    ({ campaignId, cohortId }: {
+        campaignId: string;
+        cohortId: string;
+    }): Promise<IHTTPClientResponse<SetCohortToCampaignResponseDTO>>;
+}
+export interface ISetTemplateToCampaign {
+    ({ campaignId, templateId }: {
+        campaignId: string;
+        templateId: string;
+    }): Promise<IHTTPClientResponse<SetTemplateToCampaignResponseDTO>>;
+}
+export interface ISetTemplatesToCampaign {
+    ({ campaignId, templateIds }: {
+        campaignId: string;
+        templateIds: string[];
+    }): Promise<IHTTPClientResponse<SetTemplateToCampaignResponseDTO>>;
+}
+export interface IDeleteTemplateFromCampaign {
+    ({ campaignId, templateId }: {
+        campaignId: string;
+        templateId: string;
+    }): Promise<IHTTPClientResponse<DeleteTemplateFromCampaignResponseDTO>>;
+}
+export interface IRunCampaign {
+    ({ campaignId }: {
+        campaignId: string;
+    }): Promise<IHTTPClientResponse<void>>;
+}
+export interface IGetMyCohorts {
+    (): Promise<IHTTPClientResponse<GetMyCohortsResponseDTO>>;
+}
+export interface ICreateSMSTemplate {
+    (payload: {
+        name: string;
+        message: string;
+    }): Promise<IHTTPClientResponse<CreateTemplateResponseDTO>>;
+}
+export interface ICreateWebPushTemplate {
+    (payload: {
+        name: string;
+        title: string;
+        message: string;
+    }): Promise<IHTTPClientResponse<CreateTemplateResponseDTO>>;
+}
+export interface ICreatePassPushTemplate {
+    (payload: {
+        name: string;
+        title: string;
+        message: string;
+    }): Promise<IHTTPClientResponse<CreateTemplateResponseDTO>>;
+}
+export interface ICreateEmailTemplate {
+    (payload: {
+        name: string;
+        text: string;
+        subject: string;
+        body: string;
+    }): Promise<IHTTPClientResponse<CreateTemplateResponseDTO>>;
+}
+export interface IGetMyTemplates {
+    (): Promise<IHTTPClientResponse<GetMyTemplatesResponseDTO>>;
+}
+export interface IGetTemplateById {
+    ({ templateId }: {
+        templateId: string;
+    }): Promise<IHTTPClientResponse<GetTemplateByIdResponseDTO>>;
+}
+export interface IUpdateEmailTemplate {
+    (payload: {
+        templateId: string;
+        name: string;
+        subject: string;
+        body: string;
+        text: string;
+    }): Promise<IHTTPClientResponse<void>>;
+}
+export interface IUpdateSMSTemplate {
+    (payload: {
+        templateId: string;
+        name: string;
+        message: string;
+    }): Promise<IHTTPClientResponse<void>>;
+}
+export interface IUpdateWebPushTemplate {
+    (payload: {
+        templateId: string;
+        name: string;
+        message: string;
+        title: string;
+    }): Promise<IHTTPClientResponse<void>>;
+}
+export interface IUpdatePassPushTemplate {
+    (payload: {
+        templateId: string;
+        name: string;
+        message: string;
+        title: string;
+    }): Promise<IHTTPClientResponse<void>>;
+}
+export interface IDeleteTemplate {
+    ({ templateId }: {
+        templateId: string;
+    }): Promise<IHTTPClientResponse<void>>;
+}
+export interface ICampaignCohortDTO {
+    id: string;
+    type: 'cohort';
+    attributes: {
+        count_of_users: number;
+        external_id: string;
+        last_updated: number;
+        name: string;
+    };
+    relationships: Record<string, unknown>;
+}
+interface IBaseCampaignTemplateDTO<R> {
+    id: string;
+    type: 'template';
+    attributes: {
+        channel: string;
+        defaultVars?: Record<string, string>;
+        event: string;
+        name: string;
+        requiredVar?: string[];
+        template: R;
+    };
+    relationships: Record<string, unknown>;
+}
+export declare type ICampaignSMSTemplateDTO = IBaseCampaignTemplateDTO<ICampaignSMSAttributes>;
+export declare type ICampaignEmailTemplateDTO = IBaseCampaignTemplateDTO<ICampaignEmailAttributes>;
+export declare type ICampaignPassPushTemplateDTO = IBaseCampaignTemplateDTO<ICampaignPassPushAttributes>;
+export declare type ICampaignWebPushTemplateDTO = IBaseCampaignTemplateDTO<ICampaignWebPushAttributes>;
+export declare type ICampaignTemplateDTO = ICampaignSMSTemplateDTO | ICampaignEmailTemplateDTO | ICampaignPassPushTemplateDTO | ICampaignWebPushTemplateDTO;
+interface CreateCampaignResponseDTO {
+    data: ICampaignJSONAPIDTO[];
+    included: [];
+}
+interface SetCohortToCampaignResponseDTO {
+    data: ICampaignJSONAPIDTO[];
+    included: ICampaignCohortDTO[];
+}
+interface SetTemplateToCampaignResponseDTO {
+    data: ICampaignJSONAPIDTO[];
+    included: (ICampaignCohortDTO | ICampaignTemplateDTO)[];
+}
+interface DeleteTemplateFromCampaignResponseDTO {
+    data: ICampaignJSONAPIDTO[];
+    included: (ICampaignCohortDTO | ICampaignTemplateDTO)[];
+}
+interface GetMyCohortsResponseDTO {
+    data: ICampaignCohortDTO[];
+    included: [];
+}
+interface CreateTemplateResponseDTO {
+    data: ICampaignTemplateDTO[];
+    included: [];
+}
+interface GetMyTemplatesResponseDTO {
+    data: ICampaignTemplateDTO[];
+    included: [];
+}
+interface GetTemplateByIdResponseDTO {
+    data: ICampaignTemplateDTO[];
+    included: [];
+}
+export {};

package/dist/esm5/interfaces/campaigns/common.d.ts

@@ -0,0 +1,74 @@
+export declare type ISO8601Date = string;
+export declare type ICampaignChannel = 'email' | 'sms' | 'webPush' | 'passPush';
+export interface ICampaignChannelData {
+    email?: string;
+    sms?: string;
+    webPush?: string;
+    passPush?: string;
+}
+export interface IUsersOperatingSystemsData {
+    android?: string;
+    ios?: string;
+    undefined?: string;
+}
+export interface ICampaignRun {
+    id: string;
+    count_of_users_to_send: number;
+    created_at: ISO8601Date;
+    failed: ICampaignChannelData | null;
+    planned: ICampaignChannelData | null;
+    run_at: ISO8601Date;
+    state: 'planned' | 'failed' | 'waitingStats' | 'completed';
+    success: ICampaignChannelData | null;
+    os: IUsersOperatingSystemsData | null;
+}
+export interface ICampaignCohort {
+    id: string;
+    count_of_users: number;
+    external_id: string;
+    last_updated: ISO8601Date;
+    name: string;
+}
+export declare type ICampaignSMSAttributes = {
+    msg: string;
+};
+export declare type ICampaignEmailAttributes = {
+    html: string;
+    subject: string;
+    text: string;
+};
+export declare type ICampaignPassPushAttributes = {
+    msg: string;
+    title: string;
+};
+export declare type ICampaignWebPushAttributes = {
+    msg: string;
+    title: string;
+};
+export declare type ICampaignAnyAttributes = ICampaignSMSAttributes | ICampaignEmailAttributes | ICampaignPassPushAttributes | ICampaignWebPushAttributes;
+export interface ICampaignTemplate<R = ICampaignAnyAttributes> {
+    id: string;
+    channel: ICampaignChannel;
+    defaultVars: Record<string, string>;
+    event: 'campaign';
+    name: string;
+    requiredVar: string[];
+    template: R;
+}
+export interface ICampaignJSONAPIDTO {
+    id: string;
+    type: 'campaign';
+    attributes: {
+        created_at: number;
+        name: string;
+    };
+    relationships: Record<string, unknown>;
+}
+export interface CampaignByID {
+    id: string;
+    created_at: ISO8601Date;
+    name: string;
+    campaign_run: ICampaignRun[];
+    cohort: ICampaignCohort[];
+    template: ICampaignTemplate[];
+}

package/dist/esm5/interfaces/campaigns/getByID.d.ts

@@ -0,0 +1,9 @@
+import { IRequestWithCancelAndData } from '../IRequestWithCancelAndData';
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+import { CampaignByID } from './common';
+export interface IGetCampaignById {
+    ({ campaignId }: {
+        campaignId: string;
+    }): IRequestWithCancelAndData<GetCampaignByIdResponseDTO, I_JSON_API_Response_Many>;
+}
+export declare type GetCampaignByIdResponseDTO = CampaignByID[];

package/dist/esm5/interfaces/campaigns/getMyCampaigns.d.ts

@@ -0,0 +1,8 @@
+import { ICampaignCohortDTO, ICampaignTemplateDTO } from './campaignInterfaces';
+import { CampaignByID, ICampaignJSONAPIDTO } from './common';
+import { IRequestWithCancelAndData } from '../IRequestWithCancelAndData';
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+export interface IGetMyCampaign {
+    (): IRequestWithCancelAndData<GetMyCampaignsResponseDTO, I_JSON_API_Response_Many<ICampaignJSONAPIDTO, ICampaignCohortDTO | ICampaignTemplateDTO>>;
+}
+export declare type GetMyCampaignsResponseDTO = CampaignByID[];

package/dist/esm5/interfaces/campaigns/index.d.ts

@@ -0,0 +1,4 @@
+export * from './common';
+export * from './getByID';
+export * from './campaignInterfaces';
+export * from './getMyCampaigns';

package/dist/esm5/interfaces/card/IGetBonuses.d.ts

@@ -0,0 +1,7 @@
+import { IGetCardBonusesResponseDTO } from '../issuer/IGetCardBonuses';
+import { IRequestWithCancelAndData } from '../IRequestWithCancelAndData';
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+export declare type IGetBonusesResponseDTO = IGetCardBonusesResponseDTO;
+export interface IGetBonuses {
+    (): IRequestWithCancelAndData<IGetBonusesResponseDTO, I_JSON_API_Response_Many>;
+}

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

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

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

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

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

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

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