@roketus/loyalty-js-sdk 4.35.0

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

@@ -0,0 +1,232 @@
+import type { ICreateEvent, IGetActiveUsersData, IGetCardConversionStats, IGetGeneralCardsData, IGetIssuedCardsStats, IGetPointsAddedStats, IGetPointsData, IGetPointsUsedStats, IGetPurchasesStats, IGetUniquePurchasesStats, IGetUserCompositionStats } from './analyticsInterfaces';
+import type { IGetMyNotificationStats } from './notifications/IGetMyNotificationStats';
+import type { IGetUserTokenByIssuerAPIKey, IGetUserData, ISignInByPhone, IValidatePhoneOtp } from './authInterfaces';
+import type { IAddPoints, IAddReserve, ICreateAnonymousUserCard, IGetAndroidCardDownloadLink, IDownloadIOSCard, IGetBalanceHistory, IGetCardBalanceHistory, IGetReferral, IGetUserCard, IRestoreCard, ISetTypeCard, ISpendPoints, IUpdateCard, IUpdateDiscountPercent } from './cardInterfaces';
+import type { IAuthByPassToken, IAuthByToken, ICreateIssuer, IGetIssuer, IRefreshApiKey, ISendNotificationToCards, ISendPushNotification, ISendToAllIssuerCards, ISetSettings, ISetIssuerToken, IGetCardById } from './issuerInterface';
+import type { ILogFn } from './loggerInterface';
+import type { ICreateLink, IDeleteLink, IEditLink, IListLinks, IViewLink } from './shortLinkInterface';
+import type { IAcceptTerms, IActivateEmail, IActivatePhone, IResendActivationCode, ISetEmail, ISetPhone, ISetProfile, ISkipEmail, ISkipEmailActivation, ISkipProfile } from './signupInterface';
+import type { IGetShortUrl } from './urlInterfaces';
+import type { ISetUserToken, ISetIssuer, IChangeEmail, IChangePhone, IChangeProfileData, IGetProfile, IValidateNewPhoneOtp, IUpdateProfileByIssuer, ICreateUser } from './user/userInterfaces';
+import type { ISubscribeToWebPushNotifications, ISendEmailByEvent, ISendCompanyEmailByEvent, IListEmailTemplates, ISendCompanySmsByEvent } from './user/userNotificationsInterfaces';
+import { ILoggerSetup } from './loggerInterface';
+import { IDownloadAnonymousCard } from './cardInterfaces';
+import { ISendTelemetry } from './telemetryInterfaces';
+import { ICreateCampaign, ISetCohortToCampaign, ISetTemplateToCampaign, ISetTemplatesToCampaign, IDeleteTemplateFromCampaign, IRunCampaign, IGetMyCohorts, IGetMyTemplates, IGetTemplateById, IDeleteTemplate, ICreateEmailTemplate, ICreateSMSTemplate, ICreateWebPushTemplate, ICreatePassPushTemplate, IUpdateEmailTemplate, IUpdateSMSTemplate, IUpdatePassPushTemplate, IUpdateWebPushTemplate, IGetCampaignById, IGetMyCampaign } from './campaigns';
+import { IDispatchCustomEvent, IGetCardByPhone, ISetCardName } from './issuerInterface';
+import { ISetBirthdate } from './signupInterface';
+import { IGetTransactionsByCard } from './transactions/IGetTransactionsByCard';
+import { IGetCardBonuses } from './issuer/IGetCardBonuses';
+import { IGetBonuses } from './card/IGetBonuses';
+import { IGetAllTiers } from './tiers/IGetAllTiers';
+import { ISetTierByCard } from './tiers/ISetTierByCard';
+import { IGetTiersByCard } from './tiers/IGetTiersByCard';
+import { IGetCardSpends } from './issuer/IGetCardSpends';
+import { ICreateLinkAction, IDeleteLinkAction, IEditLinkAction } from './shortLinkActionInterface';
+import { TArchivePromocode, TCreatePromocode, TGetPromocodeById, TListPromocodes, TUnarchivePromocode, TUpdatePromocode, TUsePromocode } from './promoCodes/promocodeInterfaces';
+import { TListExcludes } from './excludes/listExcludesInterfaces';
+import { TCreateExclude, TDeleteExclude, TGetExclude, TUpdateExclude } from './excludes/excludeInterfaces';
+import { TListProducts } from './products/listProductsInterfaces';
+import { TListCategories } from './products/listCategoriesInterfaces';
+import { TGetProductById } from './products/TGetProductById';
+import { TGetCategoryById } from './products/TGetGroupById';
+import { ICreateCard, IIssueCard, IListCards, IDeactivateCard, IUpdateCardCustomParams, IUpdateCardExpirationDate } from './cardManagement/cardManagementInterfaces';
+import { TCloseOrder, TOpenOrder } from './order/orderInterfaces';
+import { ICreateReferralProgram, IUpdateReferralProgram, IArchiveReferralProgram, IUnarchiveReferralProgram, IGetReferralProgram, IGetRefProgramStats, IListReferralPrograms } from './referralProgram/referralProgramInterfaces';
+import { IAddInfluencer, IUpdateInfluencer, IDeleteInfluencer, IGetInfluencer, IGetStatsByInfluencer, IListInfluencers } from './referralProgram/influencerInterfaces';
+export interface ISDK {
+    init(envUrl?: string): void;
+    user: {
+        setUserToken: ISetUserToken;
+        setIssuer: ISetIssuer;
+        createUser: ICreateUser;
+        changeEmail: IChangeEmail;
+        changePhone: IChangePhone;
+        changeProfileData: IChangeProfileData;
+        updateProfileByIssuer: IUpdateProfileByIssuer;
+        getProfile: IGetProfile;
+        validateNewPhoneOtp: IValidateNewPhoneOtp;
+        notification: {
+            subscribeToWebPushNotifications: ISubscribeToWebPushNotifications;
+            sendEmailByEvent: ISendEmailByEvent;
+            sendCompanyEmailByEvent: ISendCompanyEmailByEvent;
+            sendCompanySmsByEvent: ISendCompanySmsByEvent;
+            listEmailTemplates: IListEmailTemplates;
+        };
+        card: {
+            downloadIOSCard: IDownloadIOSCard;
+            getAndroidCardDownloadLink: IGetAndroidCardDownloadLink;
+            createAnonymousUserCard: ICreateAnonymousUserCard;
+            getBalanceHistory: IGetBalanceHistory;
+            getCardBalanceHistory: IGetCardBalanceHistory;
+            getReferral: IGetReferral;
+            getUserCard: IGetUserCard;
+            restoreCard: IRestoreCard;
+            updateCard: IUpdateCard;
+            addPoints: IAddPoints;
+            addReserve: IAddReserve;
+            setTypeCard: ISetTypeCard;
+            spendPoints: ISpendPoints;
+            updateDiscountPercent: IUpdateDiscountPercent;
+            downloadAnonymousCard: IDownloadAnonymousCard;
+            getBonuses: IGetBonuses;
+        };
+    };
+    cardManagement: {
+        listCards: IListCards;
+        createCard: ICreateCard;
+        updateCustomParams: IUpdateCardCustomParams;
+        updateExpirationDate: IUpdateCardExpirationDate;
+        issueCard: IIssueCard;
+        deactivateCard: IDeactivateCard;
+    };
+    auth: {
+        getUserTokenByIssuerAPIKey: IGetUserTokenByIssuerAPIKey;
+        getUserData: IGetUserData;
+        signInByPhone: ISignInByPhone;
+        validatePhoneOtp: IValidatePhoneOtp;
+    };
+    issuer: {
+        setIssuerToken: ISetIssuerToken;
+        /** @deprecated */
+        sendPushNotification: ISendPushNotification;
+        authByPassToken: IAuthByPassToken;
+        authByToken: IAuthByToken;
+        createIssuer: ICreateIssuer;
+        getIssuer: IGetIssuer;
+        refreshApiKey: IRefreshApiKey;
+        setSettings: ISetSettings;
+        sendNotificationToCards: ISendNotificationToCards;
+        sendToAllIssuerCards: ISendToAllIssuerCards;
+        dispatchCustomEvent: IDispatchCustomEvent;
+        getCardById: IGetCardById;
+        getCardByPhone: IGetCardByPhone;
+        getCardBalanceHistory: IGetCardBalanceHistory;
+        setCardName: ISetCardName;
+        getCardBonuses: IGetCardBonuses;
+        getCardSpends: IGetCardSpends;
+    };
+    logger: {
+        logError: ILogFn;
+        logDebug: ILogFn;
+        logInfo: ILogFn;
+        setup: ILoggerSetup;
+    };
+    signup: {
+        acceptTerms: IAcceptTerms;
+        activateEmail: IActivateEmail;
+        activatePhone: IActivatePhone;
+        resendActivationCode: IResendActivationCode;
+        setEmail: ISetEmail;
+        setEmailWithoutActivation: ISetEmail;
+        setPhone: ISetPhone;
+        setBirthdate: ISetBirthdate;
+        setProfile: ISetProfile;
+        skipEmail: ISkipEmail;
+        skipEmailActivation: ISkipEmailActivation;
+        skipProfile: ISkipProfile;
+    };
+    url: {
+        getShortUrl: IGetShortUrl;
+    };
+    analytics: {
+        createEvent: ICreateEvent;
+        getGeneralCardsData: IGetGeneralCardsData;
+        getActiveUsersData: IGetActiveUsersData;
+        getPointsData: IGetPointsData;
+        getPointsAddedStats: IGetPointsAddedStats;
+        getPointsUsedStats: IGetPointsUsedStats;
+        getMyNotificationStats: IGetMyNotificationStats;
+        getIssuedCardsStats: IGetIssuedCardsStats;
+        getPurchasesStats: IGetPurchasesStats;
+        getUniquePurchasesStats: IGetUniquePurchasesStats;
+        getUserCompositionStats: IGetUserCompositionStats;
+        getCardConversionStats: IGetCardConversionStats;
+    };
+    shortLink: {
+        createLink: ICreateLink;
+        viewLink: IViewLink;
+        deleteLink: IDeleteLink;
+        editLink: IEditLink;
+        listLinks: IListLinks;
+    };
+    shortLinkAction: {
+        createLinkAction: ICreateLinkAction;
+        editLinkAction: IEditLinkAction;
+        deleteLinkAction: IDeleteLinkAction;
+    };
+    telemetry: {
+        send: ISendTelemetry;
+    };
+    campaign: {
+        createCampaign: ICreateCampaign;
+        setCohortToCampaign: ISetCohortToCampaign;
+        setTemplateToCampaign: ISetTemplateToCampaign;
+        setTemplatesToCampaign: ISetTemplatesToCampaign;
+        deleteTemplateFromCampaign: IDeleteTemplateFromCampaign;
+        runCampaign: IRunCampaign;
+        getMyCampaign: IGetMyCampaign;
+        getCampaignById: IGetCampaignById;
+        getMyCohorts: IGetMyCohorts;
+        createEmailTemplate: ICreateEmailTemplate;
+        createSMSTemplate: ICreateSMSTemplate;
+        createPassPushTemplate: ICreatePassPushTemplate;
+        createWebPushTemplate: ICreateWebPushTemplate;
+        getMyTemplates: IGetMyTemplates;
+        getTemplateById: IGetTemplateById;
+        updateEmailTemplate: IUpdateEmailTemplate;
+        updateSMSTemplate: IUpdateSMSTemplate;
+        updatePassPushTemplate: IUpdatePassPushTemplate;
+        updateWebPushTemplate: IUpdateWebPushTemplate;
+        deleteTemplate: IDeleteTemplate;
+    };
+    transactions: {
+        getTransactionsByCard: IGetTransactionsByCard;
+    };
+    tiers: {
+        getAllTiers: IGetAllTiers;
+        getTiersByCard: IGetTiersByCard;
+        setTierByCard: ISetTierByCard;
+    };
+    promocodes: {
+        listPromocodes: TListPromocodes;
+        getPromocodeById: TGetPromocodeById;
+        createPromocode: TCreatePromocode;
+        updatePromocode: TUpdatePromocode;
+        archivePromocode: TArchivePromocode;
+        unarchivePromocode: TUnarchivePromocode;
+        usePromocode: TUsePromocode;
+    };
+    excludes: {
+        listExcludes: TListExcludes;
+        getExclude: TGetExclude;
+        createExclude: TCreateExclude;
+        updateExclude: TUpdateExclude;
+        deleteExclude: TDeleteExclude;
+    };
+    products: {
+        searchProducts: TListProducts;
+        searchCategories: TListCategories;
+        getProductById: TGetProductById;
+        getCategoryById: TGetCategoryById;
+    };
+    orders: {
+        openOrder: TOpenOrder;
+        closeOrder: TCloseOrder;
+    };
+    referralProgram: {
+        createRefProgram: ICreateReferralProgram;
+        updateRefProgram: IUpdateReferralProgram;
+        archiveRefProgram: IArchiveReferralProgram;
+        unarchiveRefProgram: IUnarchiveReferralProgram;
+        listRefPrograms: IListReferralPrograms;
+        getRefProgram: IGetReferralProgram;
+        getRefProgramStats: IGetRefProgramStats;
+        addInfluencer: IAddInfluencer;
+        updateInfluencer: IUpdateInfluencer;
+        deleteInfluencer: IDeleteInfluencer;
+        listInfluencers: IListInfluencers;
+        getInfluencer: IGetInfluencer;
+        getStatsByInfluencer: IGetStatsByInfluencer;
+    };
+}

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

@@ -0,0 +1,5 @@
+import { IPaginationData } from './requestFilterInterfaces';
+export interface I_Deserialized_List_Response_DTO<R = unknown> {
+    data: R[];
+    meta: IPaginationData;
+}

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

@@ -0,0 +1,14 @@
+import { IPaginationMeta, IPaginationExternalMeta } from "./requestFilterInterfaces";
+export interface I_JSON_API_Response_Single<R = unknown, I = unknown> {
+    data: {
+        attributes: R;
+    };
+    included: I[];
+}
+export interface I_JSON_API_Response_Many<R = unknown, I = unknown> {
+    data: {
+        attributes: R;
+    }[];
+    included: I[];
+    meta?: IPaginationMeta | IPaginationExternalMeta;
+}

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

@@ -0,0 +1,5 @@
+export interface JsonApiRequestDTO<R> {
+    data: {
+        attributes: R;
+    };
+}

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

@@ -0,0 +1,86 @@
+import { IHTTPClientResponse } from '@roketus/web-toolkit';
+import { I_JSON_API_Response_Many } from './I_JSON_API_ResponseDTO';
+export interface ICreateEvent {
+    (action: string, section: string, userId: string, OSType?: string, OSVersion?: string): void;
+}
+export interface IGetActiveUsersData {
+    (startDate: Date, endDate: Date): Promise<ActiveUsersDataResponseDTO>;
+}
+export interface IGetGeneralCardsData {
+    (startDate: Date, endDate: Date): Promise<GeneralCardsDataResponseDTO>;
+}
+export interface IGetPointsData {
+    (startDate: Date, endDate: Date): Promise<IPointsAttributes>;
+}
+export interface IGetPointsAddedStats {
+    (startDate: Date, endDate: Date): Promise<IAnalyticsAttributes>;
+}
+export interface IGetPointsUsedStats {
+    (startDate: Date, endDate: Date): Promise<IAnalyticsAttributes>;
+}
+export interface IGetIssuedCardsStats {
+    (startDate: Date, endDate: Date): Promise<IAnalyticsAttributes>;
+}
+export interface IGetPurchasesStats {
+    (startDate: Date, endDate: Date): Promise<IAnalyticsAttributes>;
+}
+export interface IGetUniquePurchasesStats {
+    (startDate: Date, endDate: Date): Promise<IAnalyticsAttributes>;
+}
+export interface IGetCardConversionStats {
+    (startDate: Date, endDate: Date): Promise<ICardConversionAttributes>;
+}
+export interface IGetUserCompositionStats {
+    (startDate: Date, endDate: Date): Promise<IUserCompositionAttributes>;
+}
+declare type ActiveUsersDataResponseDTO = IHTTPClientResponse<IGetActiveUsersDataResponse>;
+interface IGetActiveUsersDataResponse {
+    data: [
+        {
+            attributes: {
+                dau: Record<string, number>;
+                mau: Record<string, number>;
+                wau: Record<string, number>;
+            };
+        }
+    ];
+}
+declare type GeneralCardsDataResponseDTO = IHTTPClientResponse<IGetGeneralCardsDataResponse>;
+interface IGetGeneralCardsDataResponse {
+    data: [
+        {
+            attributes: {
+                cardInstalled: number;
+                cardIssued: number;
+                cardRemoved: number;
+                cardScanned: number;
+                pointsReceived: number;
+                pointsUsed: number;
+            };
+        }
+    ];
+}
+export declare type PointsDataResponseDTO = I_JSON_API_Response_Many<IPointsAttributes>;
+export interface IPointsAttributes {
+    received: Record<string, number>;
+    used: Record<string, number>;
+}
+export declare type IAnalyticResponseDTO = I_JSON_API_Response_Many<IAnalyticsAttributes>;
+export interface IAnalyticsAttributes {
+    daily_stats: Record<string, number>;
+}
+export declare type IUserCompositionResponseDTO = I_JSON_API_Response_Many<IUserCompositionAttributes>;
+export interface IUserCompositionAttributes {
+    os_distribution: Record<string, number>;
+}
+export declare type ICardConversionResponseDto = I_JSON_API_Response_Many<ICardConversionAttributes>;
+export interface ICardConversionAttributes {
+    action_stats: {
+        CardCreated?: number;
+        CardDownloaded?: number;
+        CardInstalled?: number;
+        CardRemoved?: number;
+        CardUpdated?: number;
+    };
+}
+export {};

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

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

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