@roketus/loyalty-js-sdk 4.35.0

package/dist/cjs/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/cjs/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/cjs/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/cjs/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/cjs/interfaces/products/productSearchInterfaces.d.ts

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

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

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