@smartico/public-api 0.0.107 → 0.0.108

package/dist/Inbox/GetInboxMessagesResponse.d.ts

@@ -1,5 +1,7 @@
+import { TInboxMessage } from "src/WSAPI/WSAPITypes";
 import { ProtocolResponse } from "../Base/ProtocolResponse";
 import { InboxMessage } from "./InboxMessage";
 export interface GetInboxMessagesResponse extends ProtocolResponse {
     log: InboxMessage[];
 }
+export declare const InboxMessagesTransform: (items: InboxMessage[]) => TInboxMessage[];

package/dist/Inbox/InboxMessage.d.ts

@@ -1,20 +1,23 @@
+import { TInboxMessageBody } from "src/WSAPI/WSAPITypes";
 import { InboxMessageType } from "./InboxMessageType";
+export interface InboxMessageBody {
+    action: string;
+    body: string;
+    type: InboxMessageType;
+    image: string;
+    title: string;
+    html_body: string;
+    additional_buttons?: {
+        inbox_cta_text: string;
+        action: string;
+    }[];
+}
 export interface InboxMessage {
     createDate: string;
-    body: {
-        action: string;
-        body: string;
-        type: InboxMessageType;
-        image: string;
-        title: string;
-        html_body: string;
-        additional_buttons?: {
-            inbox_cta_text: string;
-            action: string;
-        }[];
-    };
+    body: InboxMessageBody;
     engagement_uid: string;
     is_read: boolean;
     is_starred: boolean;
     is_deleted: boolean;
 }
+export declare const InboxMessageBodyTransform: (item: InboxMessageBody) => TInboxMessageBody;

package/dist/Inbox/MarkInboxMessageDeletedResponse.d.ts

@@ -1,4 +1,5 @@
 import { ProtocolMessage } from "../Base/ProtocolMessage";
 export interface MarkInboxMessageDeletedResponse extends ProtocolMessage {
     errCode: number;
+    errMsg?: string;
 }

package/dist/Inbox/MarkInboxMessageReadResponse.d.ts

@@ -1,4 +1,5 @@
 import { ProtocolMessage } from "../Base/ProtocolMessage";
 export interface MarkInboxMessageReadResponse extends ProtocolMessage {
     errCode: number;
+    errMsg?: string;
 }

package/dist/Inbox/MarkInboxMessageStarredResponse.d.ts

@@ -1,4 +1,5 @@
 import { ProtocolMessage } from "../Base/ProtocolMessage";
 export interface MarkInboxMessageStarredResponse extends ProtocolMessage {
     errCode: number;
+    errMsg?: string;
 }

package/dist/SmarticoAPI.d.ts

@@ -2,20 +2,21 @@ import { ClassId } from "./Base/ClassId";
 import { SAWGetTemplatesResponse } from './MiniGames/SAWGetTemplatesResponse';
 import { ILogger } from './ILogger';
 import { SAWDoAknowledgeResponse, SAWDoSpinResponse } from './MiniGames';
-import { GetTranslationsResponse, ResponseIdentify, TranslationArea } from './Core';
+import { GetTranslationsResponse, PublicLabelSettings, ResponseIdentify, TranslationArea } from './Core';
 import { GetLabelInfoResponse } from './Core/GetLabelInfoResponse';
-import { GetInboxMessagesResponse } from './Inbox';
+import { GetInboxMessagesResponse, InboxMessageBody, MarkInboxMessageDeletedResponse, MarkInboxMessageReadResponse, MarkInboxMessageStarredResponse } from './Inbox';
 import { BuyStoreItemResponse, GetCategoriesStoreResponse, GetStoreItemsResponse } from './Store';
 import { AchievementOptinResponse, GetAchievementMapResponse } from './Missions';
 import { GetTournamentInfoResponse, GetTournamentsResponse, TournamentRegisterResponse } from './Tournaments';
 import { LeaderBoardDetails, LeaderBoardPeriodType } from "./Leaderboard";
 import { GetLevelMapResponse } from "./Level";
 import { WSAPI } from "./WSAPI/WSAPI";
-import { TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed } from "./WSAPI/WSAPITypes";
+import { TInboxMessage, TInboxMessageBody, TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed } from "./WSAPI/WSAPITypes";
 interface Tracker {
     label_api_key: string;
     userPublicProps: any;
     on: (callBackKey: ClassId, func: (data: any) => void) => void;
+    getLabelSetting: (key: PublicLabelSettings) => any;
 }
 interface IOptions {
     logger?: ILogger;
@@ -30,6 +31,7 @@ declare class SmarticoAPI {
     private messageSender;
     private publicUrl;
     private wsUrl;
+    private inboxCdnUrl;
     private partnerUrl;
     avatarDomain: string;
     private logger;
@@ -76,6 +78,15 @@ declare class SmarticoAPI {
     levelsGet(user_ext_id: string): Promise<GetLevelMapResponse>;
     levelsGetT(user_ext_id: string): Promise<TLevel[]>;
     getTranslationsT(user_ext_id: string, lang_code: string, areas: TranslationArea[], cacheSec?: number): Promise<GetTranslationsResponse>;
+    getInboxMessages(user_ext_id: string, limit: number, offset: number, starred_only: boolean): Promise<GetInboxMessagesResponse>;
+    getInboxMessagesT(user_ext_id: string, from?: number, to?: number, favoriteOnly?: boolean): Promise<TInboxMessage[]>;
+    getInboxMessageBody(messageGuid: string): Promise<InboxMessageBody>;
+    getInboxMessageBodyT(messageGuid: string): Promise<TInboxMessageBody>;
+    markInboxMessageRead(user_ext_id: string, messageGuid: string): Promise<MarkInboxMessageReadResponse>;
+    markAllInboxMessageRead(user_ext_id: string): Promise<MarkInboxMessageReadResponse>;
+    markUnmarkInboxMessageAsFavorite(user_ext_id: string, messageGuid: string, mark: boolean): Promise<MarkInboxMessageStarredResponse>;
+    deleteInboxMessage(user_ext_id: string, messageGuid: string): Promise<MarkInboxMessageDeletedResponse>;
+    deleteAllInboxMessages(user_ext_id: string): Promise<MarkInboxMessageDeletedResponse>;
     getWSCalls(): WSAPI;
 }
 export { SmarticoAPI, MessageSender };

package/dist/WSAPI/WSAPI.d.ts

@@ -1,5 +1,5 @@
 import { SmarticoAPI } from "../SmarticoAPI";
-import { TBuyStoreItemResult, TGetTranslations, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionOptInResult, TMissionOrBadge, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUserProfile } from "./WSAPITypes";
+import { InboxMarkMessageAction, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionOptInResult, TMissionOrBadge, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUserProfile } from "./WSAPITypes";
 /** @group General API */
 export declare class WSAPI {
     private api;
@@ -50,10 +50,38 @@ export declare class WSAPI {
     getTournamentsList({ onUpdate }?: {
         onUpdate?: (data: TTournament[]) => void;
     }): Promise<TTournament[]>;
-    /** Returns details information of specific tournament instance, the response will includ tournamnet info and the leaderboard of players */
+    /** Returns details information of specific tournament instance, the response will include tournament info and the leaderboard of players */
     getTournamentInstanceInfo(tournamentInstanceId: number): Promise<TTournamentDetailed>;
     /** Requests registration for the specified tournament instance. Returns the err_code. */
     registerInTournament(tournamentInstanceId: number): Promise<TTournamentRegistrationResult>;
+    /** Returns inbox messages based on the provided parameters. "From" and "to" indicate the range of messages to be fetched.
+    * The maximum number of messages per request is limited to 20. An indicator "onlyFavorite" can be passed to get only messages marked as favorites.
+    * You can leave this params empty and by default it will return list of messages ranging from 0 to 20.
+    * This functions return list of messages without the body of the message.
+    * To get the body of the message you need to call getInboxMessageBody function and pass the message guid contained in each message of this request.
+    * All other action like mark as read, favorite, delete, etc. can be done using this message GUID.
+    * The "onUpdate" callback will be triggered when the user receives a new message. It will provide an updated list of messages, ranging from 0 to 20, to the onUpdate callback function. */
+    /**
+    * @param params
+    */
+    getInboxMessages({ from, to, onlyFavorite, onUpdate }?: {
+        from?: number;
+        to?: number;
+        onlyFavorite?: boolean;
+        onUpdate?: (data: TInboxMessage[]) => void;
+    }): Promise<TInboxMessage[]>;
+    /** Returns the message body of the specified message guid. */
+    getInboxMessageBody(messageGuid: string): Promise<TInboxMessageBody>;
+    /** Requests to mark inbox message with specified guid as read */
+    markInboxMessageAsRead(messageGuid: string): Promise<InboxMarkMessageAction>;
+    /** Requests to mark all inbox messages as read */
+    markAllInboxMessagesAsRead(): Promise<InboxMarkMessageAction>;
+    /** Requests to mark inbox message with specified guid as favorite. Pass mark true to add message to favorite and false to remove. */
+    markUnmarkInboxMessageAsFavorite(messageGuid: string, mark: boolean): Promise<InboxMarkMessageAction>;
+    /** Requests to delete inbox message */
+    deleteInboxMessage(messageGuid: string): Promise<InboxMarkMessageAction>;
+    /** Requests to delete all inbox messages */
+    deleteAllInboxMessages(): Promise<InboxMarkMessageAction>;
     /** Requests translations for the given language. Returns the object including translation key/translation value pairs. All possible translation keys defined in the back office. */
     getTranslations(lang_code: string): Promise<TGetTranslations>;
     private updateOnSpin;
@@ -61,5 +89,6 @@ export declare class WSAPI {
     private updateOnPrizeWin;
     private updateMissionsOnOptIn;
     private updateTournamentsOnRegistration;
+    private updateInboxMessages;
     private updateEntity;
 }

package/dist/WSAPI/WSAPITypes.d.ts

@@ -358,7 +358,7 @@ export interface TMissionOrBadge {
     progress: number;
     /**
      * The action that should be performed when user clicks on the mission or badge
-     * Can be URL or deep link, e.g. 'dp:deposit'. The most safe to execute CTA is to pass it to _smartico.do(cta_action);
+     * Can be URL or deep link, e.g. 'dp:deposit'. The most safe to execute CTA is to pass it to _smartico.dp(cta_action);
      * The 'dp' function will handle the CTA and will execute it in the most safe way
      */
     cta_action: string;
@@ -438,4 +438,42 @@ export interface TGetTranslations {
         [key: string]: string;
     };
 }
+export interface TInboxMessage {
+    /** Uniq identifier of the message. It is needed to request the message body, mark the message as read/deleted/favorite. */
+    message_guid: string;
+    /** Date when the message was sent */
+    sent_date: string;
+    /** Indicator if a message is read */
+    read: boolean;
+    /** Indicator if a message is added to favorites */
+    favorite: boolean;
+}
+export interface TInboxMessageBody {
+    /** Message title */
+    title: string;
+    /** Short preview body of the message */
+    preview_body: string;
+    /** Message icon */
+    icon: string;
+    /** The action that should be performed when user clicks on the message.
+     * Can be URL or deep link, e.g. 'dp:deposit'. The most safe to execute CTA is to pass it to _smartico.dp(cta_action);
+     * The 'dp' function will handle the CTA and will execute it in the most safe way.
+     * If the message has a rich html body - the action will always be 'dp:inbox' which will open the inbox widget when triggered. */
+    action: string;
+    /** Rich HTML body of the message. */
+    html_body?: string;
+    /** Optional additional buttons to show in the message, available only if message has rich HTML body. Max count - 2. */
+    buttons?: {
+        /** The action that should be performed when user clicks on the button. The logic is the same as for message actions */
+        action: string;
+        /** Button text */
+        text: string;
+    }[];
+}
+export interface InboxMarkMessageAction {
+    /** An error code representing the result of marking a message as deleted, favorite or read. Successful marking action if err_code is 0 */
+    err_code: number;
+    /** Optional error message */
+    err_message: string;
+}
 export {};