@smartico/public-api 0.0.211 → 0.0.213

package/docs/interfaces/TMiniGamePrize.md

@@ -64,91 +64,127 @@ ___
 
 • **position**: `number`
 
+for scratch card defines position of prize in the list
+
+___
+
+### sectors
+
+• **sectors**: `number`[]
+
+List of sectors for the prize
+
 ___
 
 ### acknowledge\_type
 
 • **acknowledge\_type**: `SAWAcknowledgeTypeName`
 
+Type of acknowledge message for users
+
 ___
 
 ### aknowledge\_message
 
 • **aknowledge\_message**: `string`
 
+Message that will be shown to user in modal pop-up
+
 ___
 
 ### acknowledge\_dp
 
 • **acknowledge\_dp**: `string`
 
+Deep link that will trigger some action in modal pop-up
+
 ___
 
 ### acknowledge\_action\_title
 
 • **acknowledge\_action\_title**: `string`
 
+The name of the action button in modal pop-up
+
 ___
 
 ### acknowledge\_dp\_additional
 
 • `Optional` **acknowledge\_dp\_additional**: `string`
 
+Deep link that will trigger some action in modal pop-up (additional)
+
 ___
 
 ### acknowledge\_action\_title\_additional
 
 • `Optional` **acknowledge\_action\_title\_additional**: `string`
 
+The name of the action button in modal pop-up (additional)
+
+___
+
+### out\_of\_stock\_message
+
+• `Optional` **out\_of\_stock\_message**: `string`
+
+Message when the prize pool is empty for that specific prize
+
 ___
 
 ### pool
 
 • `Optional` **pool**: `number`
 
+Number of items in stock
+
 ___
 
 ### pool\_initial
 
 • `Optional` **pool\_initial**: `number`
 
+Initial number of items in stock
+
 ___
 
 ### wins\_count
 
 • `Optional` **wins\_count**: `number`
 
+Number of wins in game
+
 ___
 
 ### weekdays
 
 • `Optional` **weekdays**: `number`[]
 
+Number of days of week, when the prize can be available
+
 ___
 
 ### active\_from\_ts
 
 • `Optional` **active\_from\_ts**: `number`
 
+Holds time from which prize will become available, for the prizes that are targeted to be available from specific time (UNIX timestamp)
+
 ___
 
 ### active\_till\_ts
 
 • `Optional` **active\_till\_ts**: `number`
 
+Holds time till which prize will become available, for the prizes that are targeted to be available from specific time (UNIX timestamp)
+
 ___
 
 ### relative\_period\_timezone
 
 • `Optional` **relative\_period\_timezone**: `number`
 
-___
-
-### out\_of\_stock\_message
-
-• `Optional` **out\_of\_stock\_message**: `string`
-
-Message when the prize pool is empty for that specific prize
+Time zone to ensure each day aligns with your local midnight.
 
 ___
 
@@ -160,7 +196,6 @@ Flag indicating that the prize is surcharged (available all the time, despite po
 
 ___
 
-
 ### is\_deleted
 
 • `Optional` **is\_deleted**: `boolean`
@@ -171,7 +206,7 @@ ___
 
 ### custom\_data
 
-• **custom\_data**: `any`
+• `Optional` **custom\_data**: `any`
 
 The custom data of the mini-game defined by operator in the BackOffice. Can be a JSON object, string or number
 
@@ -179,7 +214,7 @@ ___
 
 ### prize\_modifiers
 
-• `Optional` **prize\_modifiers**: `PrizeModifiers`
+• `Optional` **prize\_modifiers**: `PrizeModifiers`[]
 
 Prize modifiers that will multiply by 2x, 5x or 10x the current total. This will not affect the final Prize Amount that will be awarded.
 
@@ -191,4 +226,10 @@ ___
 
 When enabled, you can split prize value by decimal values
 
-___
+___
+
+### hide\_prize\_from\_history
+
+• `Optional` **hide\_prize\_from\_history**: `boolean`
+
+When enabled, you can hide prize from prize history

package/docs/interfaces/TMiniGameTemplate.md

@@ -187,3 +187,17 @@ ___
 The amount of steps to complete the game and gather the prize
 
 ___
+
+### custom\_section\_id
+
+• `Optional` **custom\_section\_id**: `number`
+
+Hold the id of the custom section
+
+___
+
+### saw\_template\_ui\_definition
+
+• **saw\_template\_ui\_definition**: `SAWTemplateUI`
+
+The UI definition of the mini-game

package/docs/interfaces/TTournament.md

@@ -46,30 +46,40 @@ ___
 
 • **image1**: `string`
 
+1st image URL representing the tournament
+
 ___
 
 ### image2
 
 • **image2**: `string`
 
+2nd image URL representing the tournament
+
 ___
 
 ### image2\_mobile
 
 • **image2\_mobile**: `string`
 
+2nd image URL representing the tournament for mobile
+
 ___
 
 ### prize\_pool\_short
 
 • **prize\_pool\_short**: `string`
 
+The message indicating the prize pool of the tournament
+
 ___
 
 ### custom\_price\_text
 
 • **custom\_price\_text**: `string`
 
+The message indicating the price to register in the tournament
+
 ___
 
 ### segment\_dont\_match\_message

package/docs/interfaces/TTournamentDetailed.md

@@ -62,6 +62,8 @@ ___
 
 • **image1**: `string`
 
+1st image URL representing the tournament
+
 #### Inherited from
 
 [TTournament](TTournament.md).[image1](TTournament.md#image1)
@@ -72,6 +74,8 @@ ___
 
 • **image2**: `string`
 
+2nd image URL representing the tournament
+
 #### Inherited from
 
 [TTournament](TTournament.md).[image2](TTournament.md#image2)
@@ -82,6 +86,8 @@ ___
 
 • **image2\_mobile**: `string`
 
+2nd image URL representing the tournament for mobile
+
 #### Inherited from
 
 [TTournament](TTournament.md).[image2_mobile](TTournament.md#image2_mobile)
@@ -92,6 +98,8 @@ ___
 
 • **prize\_pool\_short**: `string`
 
+The message indicating the prize pool of the tournament
+
 #### Inherited from
 
 [TTournament](TTournament.md).[prize_pool_short](TTournament.md#prize_pool_short)
@@ -102,6 +110,8 @@ ___
 
 • **custom\_price\_text**: `string`
 
+The message indicating the price to register in the tournament
+
 #### Inherited from
 
 [TTournament](TTournament.md).[custom_price_text](TTournament.md#custom_price_text)
@@ -377,6 +387,8 @@ ___
 
 • `Optional` **min\_scores\_win**: `number`
 
+The minimum amount of score points that the user should get in order to be qualified for the prize
+
 #### Inherited from
 
 [TTournament](TTournament.md).[min_scores_win](TTournament.md#min_scores_win)
@@ -387,6 +399,8 @@ ___
 
 • `Optional` **hide\_leaderboard\_min\_scores**: `boolean`
 
+When enabled, users who don’t meet the minimum qualifying score will be hidden from the Leaderboard
+
 #### Inherited from
 
 [TTournament](TTournament.md).[hide_leaderboard_min_scores](TTournament.md#hide_leaderboard_min_scores)

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@smartico/public-api",
-	"version": "0.0.211",
+	"version": "0.0.213",
 	"description": "Smartico public API",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

package/src/Base/AchRelatedGame.ts

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

package/src/MiniGames/SAWGetTemplatesResponse.ts

@@ -41,6 +41,7 @@ export const SAWTemplatesTransform = (items: SAWTemplate[]): TMiniGameTemplate[]
 			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((p) => {
 				const y: TMiniGamePrize = {
@@ -52,6 +53,7 @@ export const SAWTemplatesTransform = (items: SAWTemplate[]): TMiniGameTemplate[]
 					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,
@@ -71,6 +73,7 @@ export const SAWTemplatesTransform = (items: SAWTemplate[]): TMiniGameTemplate[]
 					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,
+					hide_prize_from_history: p.saw_prize_ui_definition.hide_prize_from_history
 				};
 				return y;
 			}),

package/src/MiniGames/SAWPrizeUI.ts

@@ -23,4 +23,7 @@ export interface SAWPrizeUI {
 	custom_data?: any;
 	prize_modifiers?: PrizeModifiers[]; // treasure hunt specific
 	allow_split_decimal?: boolean; // treasure hunt specific
+	hide_prize_from_history?: boolean;
+
+	
 }

package/src/Tournaments/Tournament.ts

@@ -62,9 +62,9 @@ export interface Tournament {
 
 	/** 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 */
+	/** 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. */
+	/** When enabled, users who don’t meet the minimum qualifying score will be hidden from the Leaderboard. */
 	hideLeaderboardsMinScores?: boolean;
 }
 

package/src/WSAPI/WSAPITypes.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 { AchCategory, AchievementAvailabilityStatus } from '../Missions';
 import { LeaderBoardPeriodType } from '../Leaderboard';
@@ -28,39 +28,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 */
+	/** for scratch card defines position of prize in the list */
 	position: number;
-	/* Type of acknowledge message for users */
+	/** 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 */
+	/** 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 */
+	/** Deep link that will trigger some action in modal pop-up */
 	acknowledge_dp: string;
-	/* The name of the action button in modal pop-up */
+	/** 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) */
+	/** 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) */
+	/** 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 */
+	/** Message when the prize pool is empty for that specific prize */
 	out_of_stock_message?: string;
-	/* Number of items in stock */
+	/** Number of items in stock */
 	pool?: number;
-	/* Initial number of items in stock */
+	/** Initial number of items in stock */
 	pool_initial?: number;
-	/* Number of wins in game */
+	/** Number of wins in game */
 	wins_count?: number;
-	/* Number of days of week, when the prize can be available */
+	/** 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) */
+	/** 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) */
+	/** 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. */
+	/** 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) */
+	/** Flag indicating that the prize is surcharged (available all the time, despite pool numbers) */
 	is_surcharge?: boolean;
-	/* Flag indicating the state of the prize */
+	/** 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;
@@ -68,6 +70,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;
 }
 
 /**
@@ -147,19 +151,22 @@ export interface TMiniGameTemplate {
 	/** 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 */
+	/** 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. */
+	/** 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) */
+	/** 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) */
+	/** 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 */
+	/** The amount of steps to complete the game and gather the prize */
 	steps_to_finish_game?: number;
-	/* Hold the id of the custom section */
+	/** Hold the id of the custom section */
 	custom_section_id?: number;
+
+	/** The UI definition of the mini-game */
+	saw_template_ui_definition: SAWTemplateUI;
 }
 
 /**
@@ -246,15 +253,15 @@ export interface TTournament {
 	name: string;
 	/** Description of the tournament, translated to the user language */
 	description: string;
-	/* 1st image URL representing the tournament */
+	/** 1st image URL representing the tournament */
 	image1: string;
-	/* 2nd image URL representing the tournament */
+	/** 2nd image URL representing the tournament */
 	image2: string;
-	/* 2nd image URL representing the tournament for mobile */
+	/** 2nd image URL representing the tournament for mobile */
 	image2_mobile: string;
-	/* The message indicating the prize pool of the tournament */
+	/** The message indicating the prize pool of the tournament */
 	prize_pool_short: string;
-	/* The message indicating the price to register in the tournament */
+	/** 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  */
@@ -338,9 +345,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 */
+	/** 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 */
+	/** When enabled, users who don’t meet the minimum qualifying score will be hidden from the Leaderboard */
 	hide_leaderboard_min_scores?: boolean;
 }
 
@@ -689,7 +696,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;