@smartico/public-api 0.0.211 → 0.0.213

package/dist/Base/AchRelatedGame.d.ts

@@ -1,5 +1,7 @@
 interface AchRelatedGame {
+    /** ID of the game on Smartico side */
     ach_game_id: number;
+    /** ID of the game on operator side */
     ext_game_id: string;
     game_public_meta: {
         name: string;

package/dist/MiniGames/SAWPrizeUI.d.ts

@@ -22,4 +22,5 @@ export interface SAWPrizeUI {
     custom_data?: any;
     prize_modifiers?: PrizeModifiers[];
     allow_split_decimal?: boolean;
+    hide_prize_from_history?: boolean;
 }

package/dist/Quiz/MarketsAnswersType.d.ts

@@ -0,0 +1,22 @@
+export declare enum MarketsValueType {
+    HomeTeam = "1",
+    AwayTeam = "2",
+    Draw = "x",
+    HomeTeamHomeTeam = "1/1",
+    HomeTeamDraw = "1/x",
+    HomeTeamAwayTeam = "1/2",
+    DrawHomeTeam = "x/1",
+    DrawDraw = "x/x",
+    DrawAwayTeam = "x/2",
+    AwayTeamHomeTeam = "2/1",
+    AwayTeamDraw = "2/x",
+    AwayTeamAwayTeam = "2/2",
+    Yes = "yes",
+    No = "no",
+    Odd = "odd",
+    Even = "even",
+    HomeOdd = "1/odd",
+    HomeEven = "1/even",
+    AwayOdd = "2/odd",
+    AwayEven = "2/even"
+}

package/dist/SmarticoPublicAPI.d.ts

@@ -0,0 +1,23 @@
+import { ClassId } from "./Base/ClassId";
+import { SAWGetTemplatesResponse } from './MiniGames/SAWGetTemplatesResponse';
+import { SAWTemplate } from './MiniGames/SAWTemplate';
+import { ILogger } from './ILogger';
+interface IOptions {
+    logger?: ILogger;
+    logCIDs?: ClassId[];
+    logHTTPTiming?: boolean;
+}
+declare class SmarticoPublicApi {
+    private label_api_key;
+    private brand_api_key;
+    private publicUrl;
+    private logger;
+    private logCIDs;
+    private logHTTPTiming;
+    constructor(label_api_key: string, brand_api_key: string, options?: IOptions);
+    private send;
+    private buildMessage;
+    miniGamesGetTemplates(user_ext_id: string): Promise<SAWGetTemplatesResponse>;
+    miniGamesFormatTemplatesForWidget(templates: SAWTemplate[], pointsBalance: number): any[];
+}
+export { SmarticoPublicApi };

package/dist/Store/BuyShopItemErrorCode.d.ts

@@ -0,0 +1,10 @@
+export declare enum BuyShopItemErrorCode {
+    FAILED_TO_BUY_SHOP_ITEM = 121,
+    SHOP_NO_BALANCE = 11000,
+    SHOP_WRONG_LABEL = 11001,
+    SHOP_FAILED_TO_BUY_BONUS = 11002,
+    SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION = 11003,
+    SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION_PURSHASE = 11004,
+    SHOP_FAILED_TO_BUY_MATCHING_BONUS = 11005,
+    SHOP_FAILED_MAX_BOUGHT_ITEMS_REACHED = 11006
+}

package/dist/Store/BuyShopItemRequest.d.ts

@@ -0,0 +1,4 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+export interface BuyShopItemRequest extends ProtocolMessage {
+    itemId: number;
+}

package/dist/Store/BuyShopItemResponse.d.ts

@@ -0,0 +1,4 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+export interface BuyShopItemResponse extends ProtocolResponse {
+    success?: boolean;
+}

package/dist/Store/GetCategoriesShopResponse.d.ts

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

package/dist/Store/GetShopItemsResponse.d.ts

@@ -0,0 +1,5 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { ShopItem } from "./ShopItem";
+export interface GetShopItemsResponse extends ProtocolResponse {
+    items: ShopItem[];
+}

package/dist/Store/ShopCategory.d.ts

@@ -0,0 +1,5 @@
+import { ShopCategoryPublicMeta } from "./ShopCategoryPublicMeta";
+export interface ShopCategory {
+    id?: number;
+    publicMeta?: ShopCategoryPublicMeta;
+}

package/dist/Store/ShopCategoryPublicMeta.d.ts

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

package/dist/Store/ShopItem.d.ts

@@ -0,0 +1,9 @@
+import { ShopItemPublicMeta } from "./ShopItemPublicMeta";
+import { ShopItemType } from "./ShopItemType";
+export interface ShopItem {
+    id: number;
+    itemTypeId: ShopItemType;
+    itemPublicMeta: ShopItemPublicMeta;
+    categoryIds?: number[];
+    canBuy?: boolean;
+}

package/dist/Store/ShopItemPublicMeta.d.ts

@@ -0,0 +1,10 @@
+export interface ShopItemPublicMeta {
+    price: string;
+    image_url: string;
+    name: string;
+    description: string;
+    label_tag: string;
+    limit_message: string;
+    priority: number;
+    related_items: number[];
+}

package/dist/Store/ShopItemType.d.ts

@@ -0,0 +1,4 @@
+export declare enum ShopItemType {
+    Bonus = 1,
+    Manual = 2
+}

package/dist/Store/StorItemPruchased.d.ts

@@ -0,0 +1,6 @@
+import { StoreItem } from "./StoreItem";
+interface StorItemPruchased extends StoreItem {
+    purchase_ts: number;
+    purchase_points_amount: number;
+}
+export { StorItemPruchased };

package/dist/Tournaments/Tournament.d.ts

@@ -55,7 +55,9 @@ export interface Tournament {
     tournamentPlayer?: TournamentPlayer;
     /** List of casino games (or other types of entities) related to the tournament */
     related_games?: AchRelatedGame[];
+    /** The minimum amount of score points that the user should get in order to be qualified for the prize */
     minScoreToWin?: number;
+    /** When enabled, users who don’t meet the minimum qualifying score will be hidden from the Leaderboard. */
     hideLeaderboardsMinScores?: boolean;
 }
 export declare const TournamentItemsTransform: (items: Tournament[]) => TTournament[];

package/dist/WSAPI/WSAPITypes.d.ts

@@ -1,5 +1,5 @@
 import { BuyStoreItemErrorCode } from '../Store';
-import { MiniGamePrizeTypeName, SAWAcknowledgeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWSpinErrorCode, SAWTemplate } from '../MiniGames';
+import { MiniGamePrizeTypeName, SAWAcknowledgeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWSpinErrorCode, SAWTemplate, SAWTemplateUI } from '../MiniGames';
 import { TournamentRegistrationError, TournamentRegistrationStatusName, TournamentRegistrationTypeName } from '../Tournaments';
 import { AchievementAvailabilityStatus } from '../Missions';
 import { LeaderBoardPeriodType } from '../Leaderboard';
@@ -25,22 +25,41 @@ export interface TMiniGamePrize {
     font_size_mobile?: number;
     /** The URL of the icon of the prize */
     icon?: string;
+    /** for scratch card defines position of prize in the list */
     position: number;
+    /** List of sectors for the prize */
+    sectors: number[];
+    /** Type of acknowledge message for users */
     acknowledge_type: SAWAcknowledgeTypeName;
+    /** Message that will be shown to user in modal pop-up */
     aknowledge_message: string;
+    /** Deep link that will trigger some action in modal pop-up */
     acknowledge_dp: string;
+    /** The name of the action button in modal pop-up */
     acknowledge_action_title: string;
+    /** Deep link that will trigger some action in modal pop-up (additional) */
     acknowledge_dp_additional?: string;
+    /** The name of the action button in modal pop-up (additional) */
     acknowledge_action_title_additional?: string;
+    /** Message when the prize pool is empty for that specific prize */
     out_of_stock_message?: string;
+    /** Number of items in stock */
     pool?: number;
+    /** Initial number of items in stock */
     pool_initial?: number;
+    /** Number of wins in game */
     wins_count?: number;
+    /** Number of days of week, when the prize can be available */
     weekdays?: number[];
+    /** Holds time from which prize will become available, for the prizes that are targeted to be available from specific time (UNIX timestamp) */
     active_from_ts?: number;
+    /** Holds time till which prize will become available, for the prizes that are targeted to be available from specific time (UNIX timestamp) */
     active_till_ts?: number;
+    /** Time zone to ensure each day aligns with your local midnight. */
     relative_period_timezone?: number;
+    /** Flag indicating that the prize is surcharged (available all the time, despite pool numbers) */
     is_surcharge?: boolean;
+    /** Flag indicating the state of the prize */
     is_deleted?: boolean;
     /** The custom data of the mini-game defined by operator in the BackOffice. Can be a JSON object, string or number */
     custom_data?: any;
@@ -48,6 +67,8 @@ export interface TMiniGamePrize {
     prize_modifiers?: PrizeModifiers[];
     /** When enabled, you can split prize value by decimal values */
     allow_split_decimal?: boolean;
+    /** When enabled, you can hide prize from prize history */
+    hide_prize_from_history?: boolean;
 }
 /**
  * TMiniGamePlayResult describes the response of call to _smartico.api.playMiniGame(template_id) method
@@ -116,12 +137,20 @@ export interface TMiniGameTemplate {
     custom_data: any;
     /** List of prizes for mini-games */
     prizes: TMiniGamePrize[];
+    /** When enabled, the number of items in the pool and number of won items will be exposed in the Retention API and in the UI Widgets */
     expose_game_stat_on_api?: boolean;
+    /** Time zone to ensure each day aligns with your local midnight. */
     relative_period_timezone?: number;
+    /** Holds time from which template will become available, for the template that are targeted to be available from specific time (UNIX timestamp) */
     activeFromDate?: number;
+    /** Holds time till which template will become available, for the templates that are targeted to be available from specific time (UNIX timestamp) */
     activeTillDate?: number;
+    /** The amount of steps to complete the game and gather the prize */
     steps_to_finish_game?: number;
+    /** Hold the id of the custom section */
     custom_section_id?: number;
+    /** The UI definition of the mini-game */
+    saw_template_ui_definition: SAWTemplateUI;
 }
 /**
  * TUser describes the information of the user
@@ -202,10 +231,15 @@ export interface TTournament {
     name: string;
     /** Description of the tournament, translated to the user language */
     description: string;
+    /** 1st image URL representing the tournament */
     image1: string;
+    /** 2nd image URL representing the tournament */
     image2: string;
+    /** 2nd image URL representing the tournament for mobile */
     image2_mobile: string;
+    /** The message indicating the prize pool of the tournament */
     prize_pool_short: string;
+    /** The message indicating the price to register in the tournament */
     custom_price_text: string;
     /** The message that should be shown to the user when the user cannot register in tournament with error code TOURNAMENT_USER_DONT_MATCH_CONDITIONS  */
     segment_dont_match_message: string;
@@ -281,7 +315,9 @@ export interface TTournament {
     is_in_progress: boolean;
     /** Indicator if tournament instance is upcoming (status PUBLISHED or REGISTER) */
     is_upcoming: boolean;
+    /** The minimum amount of score points that the user should get in order to be qualified for the prize */
     min_scores_win?: number;
+    /** When enabled, users who don’t meet the minimum qualifying score will be hidden from the Leaderboard */
     hide_leaderboard_min_scores?: boolean;
 }
 /**
@@ -594,7 +630,8 @@ export interface TInboxMessageBody {
     /** 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. */
+     * 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;

package/dist/index.js

@@ -410,6 +410,7 @@ var SAWTemplatesTransform = function SAWTemplatesTransform(items) {
       next_available_spin_ts: r.next_available_spin_ts,
       steps_to_finish_game: r.saw_template_ui_definition.steps_to_finish_game,
       custom_section_id: r.saw_template_ui_definition.custom_section_id,
+      saw_template_ui_definition: r.saw_template_ui_definition,
       prizes: r.prizes.map(function (p) {
         var y = {
           id: p.saw_prize_id,
@@ -420,6 +421,7 @@ var SAWTemplatesTransform = function SAWTemplatesTransform(items) {
           font_size_mobile: p.saw_prize_ui_definition.font_size_mobile,
           icon: p.saw_prize_ui_definition.icon,
           position: p.saw_prize_ui_definition.position,
+          sectors: p.saw_prize_ui_definition.sectors,
           acknowledge_type: SAWAcknowledgeTypeNamed(p.saw_prize_ui_definition.acknowledge_type),
           aknowledge_message: p.saw_prize_ui_definition.aknowledge_message,
           acknowledge_dp: p.saw_prize_ui_definition.acknowledge_dp,
@@ -438,7 +440,8 @@ var SAWTemplatesTransform = function SAWTemplatesTransform(items) {
           is_deleted: p.is_deleted,
           custom_data: IntUtils.JsonOrText(r.saw_template_ui_definition.custom_data),
           prize_modifiers: p.saw_prize_ui_definition.prize_modifiers,
-          allow_split_decimal: p.saw_prize_ui_definition.allow_split_decimal
+          allow_split_decimal: p.saw_prize_ui_definition.allow_split_decimal,
+          hide_prize_from_history: p.saw_prize_ui_definition.hide_prize_from_history
         };
         return y;
       })