@smartico/public-api 0.0.107 → 0.0.109

package/dist/Base/ClassId.d.ts

@@ -60,6 +60,8 @@ export declare enum ClassId {
     MARK_INBOX_STARRED_RESPONSE = 532,
     MARK_INBOX_DELETED_REQUEST = 535,
     MARK_INBOX_DELETED_RESPONSE = 536,
+    GET_ACH_CATEGORIES_REQUEST = 537,
+    GET_ACH_CATEGORIES_RESPONSE = 538,
     GET_BONUSES_REQUEST = 600,
     GET_BONUSES_RESPONSE = 601,
     CLAIM_BONUS_REQUEST = 602,

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/Missions/AchCategoryPublicMeta.d.ts

@@ -0,0 +1,4 @@
+export interface AchCategoryPublicMeta {
+    name?: string;
+    order?: number;
+}

package/dist/Missions/AchievementCategory.d.ts

@@ -0,0 +1,7 @@
+import { TAchCategory } from "../WSAPI/WSAPITypes";
+import { AchCategoryPublicMeta } from "./AchCategoryPublicMeta";
+export interface AchCategory {
+    id?: number;
+    publicMeta?: AchCategoryPublicMeta;
+}
+export declare const AchCategoryTransform: (items: AchCategory[]) => TAchCategory[];

package/dist/Missions/AchievementPublicMeta.d.ts

@@ -15,4 +15,6 @@ export interface AchievementPublicMeta {
     custom_section_id?: number;
     only_in_custom_section?: boolean;
     hint_text?: string;
+    hide_badge_from_ui?: boolean;
+    show_badge_first_task_completed?: boolean;
 }

package/dist/Missions/GetAchCategoriesRequest.d.ts

@@ -0,0 +1,3 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+export interface GetAchCategoriesRequest extends ProtocolMessage {
+}

package/dist/Missions/GetAchCategoriesResponse.d.ts

@@ -0,0 +1,5 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { AchCategory } from "./AchievementCategory";
+export interface GetAchCategoriesResponse extends ProtocolResponse {
+    categories: AchCategory[];
+}

package/dist/Missions/UserAchievement.d.ts

@@ -26,5 +26,6 @@ export interface UserAchievement {
     scheduledMissionType?: ScheduledMissionType;
     related_games?: AchRelatedGame[];
     active_from_ts?: number;
+    ach_categories?: number[];
 }
 export declare const UserAchievementTransform: (items: UserAchievement[]) => TMissionOrBadge[];

package/dist/Missions/index.d.ts

@@ -11,3 +11,7 @@ export * from "./ReloadAchievementsEvent";
 export * from "./UserAchievement";
 export * from "./UserAchievementTask";
 export * from "./ScheduledMissionType";
+export * from './AchCategoryPublicMeta';
+export * from './AchievementCategory';
+export * from './GetAchCategoriesResponse';
+export * from './GetAchCategoriesRequest';

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 { AchievementOptinResponse, GetAchCategoriesResponse, 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, TAchCategory, 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;
@@ -66,6 +68,8 @@ declare class SmarticoAPI {
     storeGetCategoriesT(user_ext_id: string): Promise<TStoreCategory[]>;
     missionsGetItems(user_ext_id: string): Promise<GetAchievementMapResponse>;
     missionsGetItemsT(user_ext_id: string): Promise<TMissionOrBadge[]>;
+    achGetCategories(user_ext_id: string): Promise<GetAchCategoriesResponse>;
+    achGetCategoriesT(user_ext_id: string): Promise<TAchCategory[]>;
     badgetsGetItems(user_ext_id: string): Promise<GetAchievementMapResponse>;
     badgetsGetItemsT(user_ext_id: string): Promise<TMissionOrBadge[]>;
     tournamentsGetLobby(user_ext_id: string): Promise<GetTournamentsResponse>;
@@ -76,6 +80,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, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionOptInResult, TMissionOrBadge, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUserProfile } from "./WSAPITypes";
 /** @group General API */
 export declare class WSAPI {
     private api;
@@ -26,7 +26,9 @@ export declare class WSAPI {
     /** Buy the specific shop item by item_id. Returns the err_code.*/
     buyStoreItem(item_id: number): Promise<TBuyStoreItemResult>;
     /** Returns store categories */
-    getStoreCategories(): Promise<TStoreItem[]>;
+    getStoreCategories(): Promise<TStoreCategory[]>;
+    /** Returns ach categories */
+    getAchCategories(): Promise<TAchCategory[]>;
     /** Returns the list of mini-games available for user
      * The returned list of mini-games is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getMiniGames with a new onUpdate callback, the old one will be overwritten by the new one.
      * The onUpdate callback will be called on available spin count change, if mini-game has increasing jackpot per spin or wined prize is spin/jackpot and if max count of the available user spin equal one, also if the spins were issued to the user manually in the BO. Updated templates will be passed to onUpdate callback. */
@@ -50,10 +52,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 +91,6 @@ export declare class WSAPI {
     private updateOnPrizeWin;
     private updateMissionsOnOptIn;
     private updateTournamentsOnRegistration;
+    private updateInboxMessages;
     private updateEntity;
 }

package/dist/WSAPI/WSAPITypes.d.ts

@@ -317,11 +317,19 @@ export interface TStoreItem {
      *  This indicator is taking into account the segment conditions for the store item, the price of item towards users balance,
     */
     can_buy: boolean;
-    /** The list of IDs of the categories where the store item is assigned, information about categories can be retrievend with getStoreCategories method */
+    /** The list of IDs of the categories where the store item is assigned, information about categories can be retrieved with getStoreCategories method */
     category_ids: number[];
     /** Number of items in the pool avaliable for the purchase.*/
     pool?: number;
 }
+/**
+ * TAchCategory describes the badge category item. Each badge item can be assigned to 1 or more categories
+ */
+export interface TAchCategory {
+    id: number;
+    name: string;
+    order: number;
+}
 /**
  * TMissionOrBadge describes the information of mission or badge defined in the system
  */
@@ -358,7 +366,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;
@@ -377,6 +385,8 @@ export interface TMissionOrBadge {
     tasks: TMissionOrBadgeTask[];
     /** List of casino games (or other types of entities) related to the mission or badge */
     related_games?: AchRelatedGame[];
+    /** The list of IDs of the categories where the badge item is assigned, information about categories can be retrieved with getAchCategories method */
+    category_ids: number[];
 }
 export interface AchRelatedGame {
     /** The ID of the related game */
@@ -438,4 +448,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 {};