@roketus/loyalty-js-sdk 4.35.0

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

@@ -0,0 +1,45 @@
+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 { ICreateRefProgramPayload } from './ICreateRefProgramPayload';
+import { IUpdateRefProgramPayload } from './IUpdateRefProgramPayload';
+export interface CreateRefProgramRequestDTO {
+    data: {
+        attributes: ICreateRefProgramPayload;
+    };
+}
+export declare type ReferralProgramResponseDTO = I_JSON_API_Response_Many<IReferralProgram>;
+export interface ICreateReferralProgram {
+    (payload: ICreateRefProgramPayload): Promise<IReferralProgram>;
+}
+export interface UpdateRefProgramRequestDTO {
+    data: {
+        attributes: IUpdateRefProgramPayload;
+    };
+}
+export interface UpdateReferralProgramResponseDTO {
+    data: 'ok';
+}
+export interface IUpdateReferralProgram {
+    (id: string, payload: IUpdateRefProgramPayload): Promise<void>;
+}
+export interface IArchiveReferralProgram {
+    (id: string): Promise<void>;
+}
+export interface IUnarchiveReferralProgram {
+    (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 interface IGetReferralProgram {
+    (id: string): Promise<IReferralProgram>;
+}
+export declare type RefProgramStatsResponseDTO = I_JSON_API_Response_Many<IRefProgramStats>;
+export interface IGetRefProgramStats {
+    (id: string): Promise<IRefProgramStats>;
+}

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

@@ -0,0 +1,29 @@
+export interface IPaginationExternalMeta {
+    current_page?: number;
+    limit: number;
+    offset: number;
+    total_items: number;
+    total_pages?: number;
+}
+export interface IPaginationMeta {
+    Limit: number;
+    Offset: number;
+    TotalItems: number;
+}
+export interface IPaginationData {
+    page: number;
+    pageSize: number;
+    totalData: number;
+    totalPages: number;
+}
+export declare enum EListSort {
+    ASC = "asc",
+    DESC = "desc"
+}
+export interface IListFiltersPayload {
+    page?: number;
+    pageSize?: number;
+    filter?: Record<string, string | string[]>;
+    sort?: Record<string, EListSort>;
+    search?: string;
+}

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

@@ -0,0 +1,146 @@
+import { IHTTPClientResponse } from '@roketus/web-toolkit';
+import { NotificationChannel } from './common/NotificationChannelEnum';
+import { CurrencyCode } from './common/CurrencyCodeEnum';
+export declare type TLinkActionType = 'add_gift_bonuses' | 'card' | 'send_notification' | 'coupon' | 'add_promo_to_user' | 'change_template';
+interface IBonusPayload {
+    currency_code: CurrencyCode;
+    amount: number;
+}
+interface ICardPayload {
+    templateID: string;
+}
+interface ICouponWithPromoPayload {
+    template_id: string;
+    promo_code_id: string;
+    count_of_use: number;
+}
+interface IAddUserPromoPayload {
+    promo_code_id: string;
+    count_of_use: number;
+}
+interface IChangeTemplatePayload {
+    template_id: string;
+}
+declare type NotificationEmailRequest = {
+    template: {
+        subject: string;
+        html?: string;
+        text: string;
+    };
+    channel: NotificationChannel.Email;
+};
+declare type NotificationSmsRequest = {
+    template: {
+        msg: string;
+    };
+    channel: NotificationChannel.Sms;
+};
+declare type NotificationWepPassPushRequest = {
+    template: {
+        msg: string;
+        title: string;
+    };
+    channel: NotificationChannel.WebPush | NotificationChannel.PassPush;
+};
+declare type INotificationPayload = NotificationEmailRequest | NotificationSmsRequest | NotificationWepPassPushRequest;
+interface ILinkActionPayload<T> {
+    type: TLinkActionType;
+    payload: T;
+}
+interface ILinkActionPayloadBonusResponse {
+    Amount: string;
+    CurrencyCode: CurrencyCode;
+    Description: string;
+    Metadata: null;
+}
+interface ILinkActionPayloadCardResponse {
+    TemplateID: string;
+}
+interface ILinkActionPayloadCouponWithPromoResponse {
+    TemplateID: string;
+    PromoID: string;
+    CountOfUse: number;
+}
+interface ILinkActionPayloadAddUserPromoResponse {
+    PromoID: string;
+    CountOfUse: number;
+}
+interface ILinkActionPayloadChangeTemplateResponse {
+    TemplateID: string;
+}
+declare type NotificationEmailResponse = {
+    Template: {
+        subject: string;
+        html?: string;
+        text: string;
+    };
+    Channel: NotificationChannel.Email;
+};
+declare type NotificationSmsResponse = {
+    Template: {
+        msg: string;
+    };
+    Channel: NotificationChannel.Sms;
+};
+declare type NotificationWepPassPushResponse = {
+    Template: {
+        msg: string;
+        title: string;
+    };
+    Channel: NotificationChannel.WebPush | NotificationChannel.PassPush;
+};
+declare type TLinkActionPayloadNotificationResponse = NotificationEmailResponse | NotificationSmsResponse | NotificationWepPassPushResponse;
+export declare type TLinkActionPayloadResponse = ILinkActionPayloadBonusResponse | ILinkActionPayloadCardResponse | TLinkActionPayloadNotificationResponse[] | ILinkActionPayloadCouponWithPromoResponse | ILinkActionPayloadAddUserPromoResponse | ILinkActionPayloadChangeTemplateResponse;
+interface ILinkActionResponse {
+    data: {
+        id: string;
+        type: string;
+        attributes: {
+            baseUrl: string;
+            linkKey: string;
+            linkType: string;
+            meta: Record<string, string>;
+            name: string;
+            ownerId: string;
+            params: Record<string, string>;
+            url: string;
+        };
+        relationships: {
+            action: {
+                data: {
+                    id: string;
+                    type: string;
+                }[];
+            };
+        };
+    }[];
+    included: [
+        {
+            id: string;
+            type: string;
+            attributes: {
+                actionType: string;
+                createdAt: number;
+                payload: TLinkActionPayloadResponse;
+            };
+            relationships: object;
+        }
+    ];
+}
+export declare type LinkActionResponseDTO = IHTTPClientResponse<ILinkActionResponse>;
+export declare type TLinkActionPayload = ILinkActionPayload<IBonusPayload | ICardPayload | ICouponWithPromoPayload | IAddUserPromoPayload | IChangeTemplatePayload | INotificationPayload[]>;
+export interface LinkActionRequestDTO {
+    data: {
+        attributes: TLinkActionPayload;
+    };
+}
+export interface ICreateLinkAction {
+    (linkId: string, payload: TLinkActionPayload): Promise<LinkActionResponseDTO>;
+}
+export interface IEditLinkAction {
+    (linkId: string, linkActionId: string, payload: TLinkActionPayload): Promise<ILinkActionResponse>;
+}
+export interface IDeleteLinkAction {
+    (linkId: string, linkActionId: string): Promise<void>;
+}
+export {};

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

@@ -0,0 +1,92 @@
+import { TLinkActionType, TLinkActionPayloadResponse } from './shortLinkActionInterface';
+import { IListFiltersPayload, IPaginationData } from './requestFilterInterfaces';
+import { I_JSON_API_Response_Many } from './I_JSON_API_ResponseDTO';
+export interface IShortLinkResponseDTO {
+    id: string;
+    type: string;
+    attributes: {
+        linkKey: string;
+        linkType: string;
+        name: string;
+        ownerId: string;
+        baseUrl: string;
+        url: string;
+        createdAt: number;
+        params: Record<string, string>;
+        meta: Record<string, string>;
+    };
+}
+export interface IShortLinkActionResponseDTO {
+    id: string;
+    type: 'action';
+    attributes: {
+        actionType: TLinkActionType;
+        createdAt: number;
+        payload: TLinkActionPayloadResponse;
+    };
+    relationships: object;
+}
+export interface IShortLinkAction {
+    id: string;
+    actionType: string;
+    createdAt: number;
+    payload: TLinkActionPayloadResponse;
+}
+export interface IShortLink {
+    id: string;
+    linkKey: string;
+    linkType: string;
+    name: string;
+    ownerId: string;
+    baseUrl: string;
+    url: string;
+    createdAt: number;
+    params: Record<string, string>;
+    meta: Record<string, string>;
+    action?: IShortLinkAction[];
+}
+export declare type LinkResponseDTO = I_JSON_API_Response_Many<IShortLinkResponseDTO, IShortLinkActionResponseDTO>;
+export interface ICreateLink {
+    (payload: ICreateLinkPayload): Promise<IShortLink>;
+}
+export interface ICreateLinkPayload {
+    name: string;
+    linkType: string;
+    url: string;
+    meta: Record<string, string>;
+    params: Record<string, string>;
+}
+export interface CreateLinkRequestDTO {
+    data: {
+        attributes: {
+            name: string;
+            link_type: string;
+            url: string;
+            meta: Record<string, string>;
+            params: Record<string, string>;
+        };
+    };
+}
+export interface IEditLink {
+    (id: string, data: IEditLinkPayload): Promise<void>;
+}
+export interface IEditLinkPayload extends ICreateLinkPayload {
+}
+export interface EditLinkRequestDTO extends CreateLinkRequestDTO {
+}
+export interface EditLinkResponseDTO {
+    data: 'ok';
+}
+export interface IViewLink {
+    (linkId: string): Promise<IShortLink>;
+}
+export interface IDeleteLink {
+    (linkId: string): Promise<void>;
+}
+export interface IListLinks {
+    (params: IListFiltersPayload): Promise<IListLinksResponse>;
+}
+export interface IListLinksResponse {
+    data: IShortLink[];
+    meta: IPaginationData;
+}

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

@@ -0,0 +1,56 @@
+import { IHTTPClientResponse } from '@roketus/web-toolkit';
+export interface IAcceptTerms {
+    (activationMode: string, referralId?: string): Promise<IHTTPClientResponse<ActivationResponseDTO>>;
+}
+export interface IActivateEmail {
+    (activationMode: string): Promise<IHTTPClientResponse<ActivationResponseDTO>>;
+}
+export interface IActivatePhone {
+    (code: number, activationMode: string): Promise<IHTTPClientResponse<ActivationResponseDTO>>;
+}
+export interface IResendActivationCode {
+    (): Promise<IHTTPClientResponse<ActivationResponseDTO>>;
+}
+export interface ISetEmail {
+    (email: string, activationMode: string): Promise<IHTTPClientResponse<ActivationResponseDTO>>;
+}
+export interface ISetPhone {
+    (phoneNumber: string, activationMode: string): Promise<IHTTPClientResponse<ActivationResponseDTO>>;
+}
+export interface ISetBirthdate {
+    (date: string, activationMode: string): Promise<IHTTPClientResponse<ActivationResponseDTO>>;
+}
+export interface ISetProfile {
+    (data: SetProfileProps, activationMode: string): Promise<IHTTPClientResponse<ActivationResponseDTO>>;
+}
+export interface ISkipEmail {
+    (activationMode: string): Promise<IHTTPClientResponse<ActivationResponseDTO>>;
+}
+export interface ISkipEmailActivation {
+    (activationMode: string): Promise<IHTTPClientResponse<ActivationResponseDTO>>;
+}
+export interface ISkipProfile {
+    (activationMode: string): Promise<IHTTPClientResponse<ActivationResponseDTO>>;
+}
+export interface ActivationResponseDTO {
+    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>];
+}
+export interface SetProfileProps {
+    firstName: string;
+    lastName: string;
+    userId?: string;
+}

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

@@ -0,0 +1,8 @@
+export interface ISendTelemetry {
+    (appName: string, appVersion: string): Promise<{
+        uuid: string;
+        appName: string;
+        appVersion: string;
+        dateTime: string;
+    }>;
+}

package/dist/esm5/interfaces/tiers/IGetAllTiers.d.ts

@@ -0,0 +1,41 @@
+import { IRequestWithCancelAndData } from '../IRequestWithCancelAndData';
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+export interface IGetAllTiers {
+    (): IRequestWithCancelAndData<IGetAllTiersResponseDTO, I_JSON_API_Response_Many<ITiersJSONAPIDTO, ITierLevelJSONAPIDTO>>;
+}
+export interface IGetAllTiersResponseDTO {
+    id: string;
+    name: string;
+    tier_level: ITierLevelAttributes[];
+}
+export interface ITiersJSONAPIDTO {
+    id: string;
+    type: 'tier';
+    attributes: {
+        name: string;
+    };
+    relationships: Record<string, unknown>;
+}
+export interface ITierLevelAttributes {
+    id: string;
+    benefits: {
+        bonus_activation_period: number;
+        bonus_expiration_period: number;
+        bonus_percent_amount: number;
+        max_bonus_redeem_percent: number;
+        template_id: string;
+    };
+    condition: {
+        ConditionType: 'total_purchase_amount';
+        Payload: {
+            MinAmount: number;
+        };
+    };
+    name: string;
+}
+export interface ITierLevelJSONAPIDTO {
+    id: string;
+    type: 'tier_level';
+    attributes: ITierLevelAttributes;
+    relationships: Record<string, unknown>;
+}

package/dist/esm5/interfaces/tiers/IGetTiersByCard.d.ts

@@ -0,0 +1,22 @@
+import { IRequestWithCancelAndData } from '../IRequestWithCancelAndData';
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+export interface IGetTiersByCard {
+    (cardNumber: string): IRequestWithCancelAndData<IGetTiersByCardResponseDTO, I_JSON_API_Response_Many<IUserTiersJSONAPIDTO, void>>;
+}
+export declare type IGetTiersByCardResponseDTO = IUserTiersAttributes;
+export interface IUserTiersJSONAPIDTO {
+    id: string;
+    type: 'userTier';
+    attributes: IUserTiersAttributes;
+    relationships: Record<string, unknown>;
+}
+export interface IUserTiersAttributes {
+    id: string;
+    'current-levels': string;
+    'level-history': {
+        level_id: string;
+        date: string;
+        name: string;
+    }[];
+    'manual-level-hold': boolean;
+}

package/dist/esm5/interfaces/tiers/ISetTierByCard.d.ts

@@ -0,0 +1,16 @@
+import { IRequestWithCancelAndData } from '../IRequestWithCancelAndData';
+export interface ISetTierByCard {
+    (payload: {
+        tierID: string;
+        cardNumber: string;
+        disableAutoUpdate?: boolean;
+    }): IRequestWithCancelAndData<void, void>;
+}
+export interface ISetTierByCardRequestDTO {
+    data: {
+        attributes: {
+            level_id: string;
+            is_on_hold: boolean;
+        };
+    };
+}

package/dist/esm5/interfaces/transactions/IGetTransactionsByCard.d.ts

@@ -0,0 +1,19 @@
+import { IRequestWithCancelAndData } from '../IRequestWithCancelAndData';
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+export interface IGetTransactionsByCard {
+    (cardNumber: string): IRequestWithCancelAndData<IGetTransactionsByCardResponseDTO, I_JSON_API_Response_Many>;
+}
+interface Transaction {
+    activationDate: string;
+    createdAt: string;
+    bonusAmount: string;
+    clientTransactionID: string;
+    description: string;
+    expirationDate: string;
+    fullAmount: string;
+    metadata: Record<string, unknown>;
+    state: 'expired' | 'activated';
+    transactionID: string;
+}
+export declare type IGetTransactionsByCardResponseDTO = Transaction[];
+export {};

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

@@ -0,0 +1,19 @@
+import { IHTTPClientResponse } from '@roketus/web-toolkit';
+export interface IGetShortUrl {
+    (url: string): Promise<IHTTPClientResponse<GetShortUrlResponseDTO>>;
+}
+interface GetShortUrlResponseDTO {
+    data: [
+        {
+            id: string;
+            type: LinkType;
+            attributes: {
+                short_link: string;
+            };
+            relationships: Record<string, unknown>;
+        }
+    ];
+    included: [];
+}
+declare type LinkType = 'link';
+export {};

package/dist/esm5/interfaces/user/IUser.d.ts

@@ -0,0 +1,20 @@
+export interface IUser {
+    id: string;
+    first_name: string;
+    last_name: string;
+    middle_name?: string;
+    phone: string;
+    email: string;
+    job_title?: string;
+    shops?: string[];
+    ref_id: string;
+    ref_code: string;
+    created_at: string;
+    avatar: {
+        ID: string;
+        URISmall: string;
+        URIMedium: string;
+        URILarge: string;
+        URIExtraLarge: string;
+    };
+}

package/dist/esm5/interfaces/user/IUserCreate.d.ts

@@ -0,0 +1,22 @@
+export interface IUserAddress {
+    region?: string;
+    district?: string;
+    city?: string;
+    street?: string;
+    building?: string;
+    apartment?: string;
+}
+export declare type TUserGender = 'male' | 'female' | 'secret' | 'other';
+export interface IUserCreate {
+    firstName: string;
+    lastName: string;
+    middleName?: string;
+    birth?: string;
+    gender?: TUserGender;
+    phone: string;
+    email?: string;
+    jobTitle?: string;
+    shop?: string;
+    workplace?: string;
+    address?: IUserAddress;
+}

package/dist/esm5/interfaces/user/IUserUpdate.d.ts

@@ -0,0 +1,7 @@
+export interface IUserUpdate {
+    firstName?: string;
+    lastName?: string;
+    middleName?: string;
+    jobTitle?: string;
+    shops?: string[];
+}

package/dist/esm5/interfaces/user/userInterfaces.d.ts

@@ -0,0 +1,86 @@
+import { IHTTPClientResponse } from '@roketus/web-toolkit';
+import { ActivationResponseDTO } from '../signupInterface';
+import { IUserCreate } from "./IUserCreate";
+import { IUserUpdate } from './IUserUpdate';
+export interface CreateUserRequestDTO {
+    data: {
+        attributes: IUserCreate;
+    };
+}
+export interface ICreateUser {
+    (payload: IUserCreate): Promise<IHTTPClientResponse<void>>;
+}
+export interface IChangeEmail {
+    (email: string): Promise<IHTTPClientResponse<void>>;
+}
+export interface IChangePhone {
+    (phoneNumber: string): Promise<IHTTPClientResponse<void>>;
+}
+export interface ProfileChangeRequestDTO {
+    data: {
+        attributes: IUserUpdate;
+    };
+}
+export interface IChangeProfileData {
+    (firstName: string, lastName: string): Promise<IHTTPClientResponse<ProfileChangeResponseDTO>>;
+}
+export interface IUpdateProfileByIssuer {
+    (userId: string, profileData: IUserUpdate): Promise<void>;
+}
+export interface IGetProfile {
+    (): Promise<IHTTPClientResponse<ProfileGetResponseDTO>>;
+}
+export interface IValidateNewPhoneOtp {
+    (code: number): Promise<IHTTPClientResponse<ActivationResponseDTO>>;
+}
+export interface ISetUserToken {
+    (token: string): void;
+}
+export interface ISetIssuer {
+    (issuer: string): void;
+}
+interface ProfileChangeResponseDTO {
+    data: [
+        {
+            id: string;
+            type: 'user';
+            attributes: {
+                createdAt: string;
+                email: string;
+                emailVerified: boolean;
+                phone: string;
+                phoneVerified: boolean;
+            };
+        }
+    ];
+    included: [
+        {
+            id: string;
+            type: 'activation';
+            attributes: {
+                completed: boolean;
+                completed_required: boolean;
+                nextStep: string;
+                nextStepSkippable: boolean;
+                type: string;
+            };
+            relationships: Record<string, unknown>;
+        },
+        {
+            id: string;
+            type: 'profile';
+            attributes: {
+                firstName: string;
+                lastName: string;
+            };
+        }
+    ];
+}
+interface ProfileGetResponseDTO {
+    data: {
+        Username: string;
+        ApiKey: string;
+    };
+    type: 'data';
+}
+export {};

package/dist/esm5/interfaces/user/userNotificationsInterfaces.d.ts

@@ -0,0 +1,34 @@
+import type { IHTTPClientResponse } from '@roketus/web-toolkit';
+import { I_JSON_API_Response_Many } from '../I_JSON_API_ResponseDTO';
+export interface ISubscribeToWebPushNotifications {
+    (subscription: PushSubscriptionJSON): Promise<unknown>;
+}
+export interface ISendEmailByEvent {
+    (event: string, user_id: string): Promise<IHTTPClientResponse<unknown>>;
+}
+export interface ISendCompanyEmailByEvent {
+    (event: string, company_id: string): Promise<IHTTPClientResponse<unknown>>;
+}
+export interface ISendCompanySmsByEvent {
+    (event: string, company_id: string): Promise<IHTTPClientResponse<unknown>>;
+}
+export interface IListEmailTemplates {
+    (): Promise<IListEmailTemplatesResponse>;
+}
+export interface IEmailTemplate {
+    id: string;
+    channel: string;
+    event: string;
+    name: string;
+    defaultVars: Record<string, any>;
+    requiredVar: string[];
+    template: {
+        html: string;
+        subject: string;
+        text: string;
+    };
+}
+export interface IListEmailTemplatesResponse {
+    data: IEmailTemplate[];
+}
+export declare type TListEmailTemplatesResponseDTO = I_JSON_API_Response_Many<IEmailTemplate>;

package/dist/esm5/sdk.d.ts

@@ -0,0 +1,2 @@
+import { ISDK } from './interfaces/ISDK';
+export declare const sdk: ISDK;

package/dist/esm5/testUtils.d.ts

@@ -0,0 +1,2 @@
+import { SetupServer } from 'msw/node';
+export declare const setupServerInDescribe: (server: SetupServer) => void;