@smartico/public-api 0.0.283 → 0.0.284

package/docs/interfaces/RaffleTicket.md

@@ -6,8 +6,12 @@
 
 • **id**: `number`
 
+Int presentation of the ticket
+
 ___
 
 ### s
 
 • **s**: `string`
+
+String presentation of the ticket

package/docs/interfaces/SAWPrizeUI.md

@@ -32,6 +32,12 @@ ___
 
 ___
 
+### aknowledge\_message\_lose
+
+• `Optional` **aknowledge\_message\_lose**: `string`
+
+___
+
 ### sectors
 
 • `Optional` **sectors**: `number`[]

package/docs/interfaces/TMiniGameTemplate.md

@@ -226,3 +226,21 @@ ___
 ### show\_prize\_history
 
 • `Optional` **show\_prize\_history**: `boolean`
+
+When enabled the prize history icon is visible on a certain template
+
+___
+
+### max\_number\_of\_attempts
+
+• `Optional` **max\_number\_of\_attempts**: `number`
+
+The maximum number of attempts that user can do during period of time
+
+___
+
+### max\_spins\_period\_ms
+
+• `Optional` **max\_spins\_period\_ms**: `number`
+
+The period of time in milliseconds during which the user can do the maximum number of attempts

package/docs/interfaces/TRaffleTicket.md

@@ -6,8 +6,12 @@
 
 • **ticekt\_id**: `number`
 
+Int presentation of the ticket
+
 ___
 
 ### ticket\_id\_string
 
 • **ticket\_id\_string**: `string`
+
+String presentation of the ticket

package/package.json

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

package/src/Jackpots/JackpotPublicMeta.ts

@@ -17,7 +17,7 @@ interface JackpotPublicMeta {
 	/**
 	 * Custom data as string or JSON string that can be used in API to build custom UI
 	 * You can request from Smartico to define fields for your specific case that will be managed from Smartico BackOffice
-	 * Read more here - https://help.smartico.ai/welcome/products/general-concepts/custom-fields-attributes
+	 * Read more here - <https://help.smartico.ai/welcome/products/general-concepts/custom-fields-attributes>
 	*/
 	custom_data: string;
 }

package/src/MiniGames/SAWGetTemplatesResponse.ts

@@ -45,6 +45,8 @@ export const SAWTemplatesTransform = (items: SAWTemplate[]): TMiniGameTemplate[]
 			custom_section_id: r.saw_template_ui_definition.custom_section_id,
 			saw_template_ui_definition: r.saw_template_ui_definition,
 			show_prize_history: r.show_prize_history,
+			max_number_of_attempts: r.maxSpinsCount,
+			max_spins_period_ms: r.maxSpinsPediodMs,
 
 			prizes: r.prizes.map((p) => {
 				const y: TMiniGamePrize = {

package/src/MiniGames/SAWPrizeUI.ts

@@ -8,6 +8,7 @@ export interface SAWPrizeUI {
 	name_original?: string; // keeps original name, how it came from the servers. This is needed for the Jackpot value replacemenet
 	hide_prize_popup: boolean; // if true, prize popup on Prize Drop will not be shown
 	aknowledge_message?: string;
+	aknowledge_message_lose?: string; // voyager specific
 	sectors?: number[];
 	acknowledge_type?: SAWAcknowledgeType;
 	acknowledge_dp?: string;

package/src/Raffle/Raffle.ts

@@ -17,7 +17,7 @@ interface RafflePublicMeta {
     /** 
 	 * Custom data as string or JSON string that can be used in API to build custom UI
 	 * You can request from Smartico to define fields for your specific case that will be managed from Smartico BackOffice
-	 * Read more here - https://help.smartico.ai/welcome/products/general-concepts/custom-fields-attributes
+	 * Read more here - <https://help.smartico.ai/welcome/products/general-concepts/custom-fields-attributes>
      */
 	custom_data: string;
 }

package/src/Raffle/RaffleClaimPrizeResponse.ts

@@ -1,7 +1,7 @@
 import { TransformedRaffleClaimPrizeResponse } from "../WSAPI/WSAPITypes";
 import { ProtocolResponse } from "../Base/ProtocolResponse";
 
-export interface RaffleClaimPrizeResponse extends ProtocolResponse { 
+export interface RaffleClaimPrizeResponse extends ProtocolResponse {
     errCode: number
     errMsg?: string
 }
@@ -13,6 +13,3 @@ export const raffleClaimPrizeResponseTransform = (info: RaffleClaimPrizeResponse
         errorMessage: info.errMsg
     }
 }
-
-
-

package/src/Raffle/RaffleDraw.ts

@@ -50,6 +50,7 @@ interface RaffleDraw {
 
     /** 
      * Type of the draw execution, indicating how and when the draw is executed.
+     * 
      * - ExecDate: Draw is executed only once at a specific date and time.
      * - Recurring: Draw is executed on a recurring basis (e.g., daily, weekly).
      * - Grand: Draw is executed once and is marked as grand, often with larger prizes or more importance.
@@ -65,21 +66,22 @@ interface RaffleDraw {
     /** Unique ID of the previusly executed draw (if there is such) */
     previous_run_id?: number;    
 
-    /**
-     *  Date/time starting from which the tickets will participate in the upcoming draw
-     *  This value need to be taken into account with next_execute_ts field value, for example
-     *  Next draw is at 10:00, ticket_start_date is 9:00, so all tickets that are collected after 9:00 will participate in the draw at 10:00
-     *  (internally this value is calculated as next_execute_ts - ticket_start_date)
+    /** 
+     * Date/time starting from which the tickets will participate in the upcoming draw
+     * This value need to be taken into account with next_execute_ts field value, for example
+     * Next draw is at 10:00, ticket_start_date is 9:00, so all tickets that are collected after 9:00 will participate in the draw at 10:00
+     * (internally this value is calculated as next_execute_ts - ticket_start_date)
      */
     ticket_start_ts: number;
 
-    /** Field is indicating if same ticket can win multiple prizes in the same draw 
-     *  For example there are 3 types of prizes in the draw - iPhone, iPad, MacBook
-     *  If this field is true, then one ticket can win all 3 prizes (depending on the chances of course), 
-     *  if false, then one ticket can win only one prize. 
-     *  The distribution of the prizes is start from top (assuming on top are the most valuable prizes) to bottom (less valuable prizes)
-     *  If specific prize has multiple values, e.g. we have 3 iPhones, 
-     *  then the same ticket can win only one prize of a kind, but can win multiple prizes of different kind (if allow_multi_prize_per_ticket is true) 
+    /** 
+     * Field is indicating if same ticket can win multiple prizes in the same draw
+     * For example there are 3 types of prizes in the draw - iPhone, iPad, MacBook
+     * If this field is true, then one ticket can win all 3 prizes (depending on the chances of course),
+     * if false, then one ticket can win only one prize.
+     * The distribution of the prizes is start from top (assuming on top are the most valuable prizes) to bottom (less valuable prizes)
+     * If specific prize has multiple values, e.g. we have 3 iPhones,
+     * then the same ticket can win only one prize of a kind, but can win multiple prizes of different kind (if allow_multi_prize_per_ticket is true)
     */
     allow_multi_prize_per_ticket: boolean;
 
@@ -95,9 +97,9 @@ interface RaffleDraw {
      */
     my_tickets_count: number;
 
-    /*
-    * List of last 5 tickets are collected by current user for this instance of draw.
-    */
+    /**
+     * List of last 5 tickets are collected by current user for this instance of draw.
+     */
     my_last_tickets: RaffleTicket[];
 }
 

package/src/Raffle/RafflePrize.ts

@@ -34,28 +34,29 @@ interface RafflePrize {
     /**
      * The actual number of prizes for the current instance.
      * This value is taking into account follwing values:
-     *  - min_required_total_tickets, 
-     *  - add_one_prize_per_each_x_tickets
-     *  - stock_items_per_draw
-     *  - total_tickets_count (from Draw instance)
-     *  - cap_prizes_per_run
+     * 
+     * - min_required_total_tickets,
+     * - add_one_prize_per_each_x_tickets
+     * - stock_items_per_draw
+     * - total_tickets_count (from Draw instance)
+     * - cap_prizes_per_run
      * For example:
-     *  - prizes_per_run = 1
-     *  - min_required_total_tickets = 1000
-     *  - add_one_prize_per_each_x_tickets = 1000
-     *  - stock_items_per_draw = 5
-     *  - total_tickets_count = 7000
-     *  - cap_prizes_per_run = 6
-     *  prizes_per_run_actual will be 5, because
-     *  7000 tickets are collected, so 7 iPhones are available, but the cap is 6 and the stock is 5.
+     * 
+     * - prizes_per_run = 1
+     * - min_required_total_tickets = 1000
+     * - add_one_prize_per_each_x_tickets = 1000
+     * - stock_items_per_draw = 5
+     * - total_tickets_count = 7000
+     * - cap_prizes_per_run = 6
+     * prizes_per_run_actual will be 5, because
+     * 7000 tickets are collected, so 7 iPhones are available, but the cap is 6 and the stock is 5.
     */
     prizes_per_run_actual: number;
 
 
     /**
-     * 
-     * The chances to win the prize by current player. 
-     * Calculated as the ratio of the number of tickets collected by the current player to the 
+     * The chances to win the prize by current player.
+     * Calculated as the ratio of the number of tickets collected by the current player to the
      * total number of tickets collected by all players and multiplied by number of actual prizes of this kind.
      */
     chances_to_win_perc: number;
@@ -91,7 +92,7 @@ interface RafflePrize {
 
     /**
      * The maximum number of prizes that can be given within one instance/run of draw.
-     * For example the prize is iPhone and add_one_prize_per_each_x_tickets is set to 1000, 
+     * For example the prize is iPhone and add_one_prize_per_each_x_tickets is set to 1000,
      * cap_prizes_per_run is set to 3, and the total number of tickets collected is 7000.
      * In this case, the prizes_per_run_actual will be limited by 3
      */ 

package/src/Raffle/RaffleTicket.ts

@@ -1,8 +1,12 @@
 
 interface RaffleTicket {
-    /* int presentation of the ticket */
+    /**
+     * Int presentation of the ticket
+     */
     id: number;
-    /* String presentation of ticket */
+    /**
+     * String presentation of the ticket
+     */
     s: string;
 }
 

package/src/WSAPI/WSAPITypes.ts

@@ -181,8 +181,12 @@ export interface TMiniGameTemplate {
 
 	/** The UI definition of the mini-game */
 	saw_template_ui_definition: SAWTemplateUI;
-	/* When enabled the prize history icon is visible on a certain template */
+	/** When enabled the prize history icon is visible on a certain template */
 	show_prize_history?:boolean;
+	/** The maximum number of attempts that user can do during period of time */
+	max_number_of_attempts?: number;
+	/** The period of time in milliseconds during which the user can do the maximum number of attempts */
+	max_spins_period_ms?: number;
 }
 
 /**
@@ -963,9 +967,13 @@ export interface TRaffle {
 }
 
 export interface TRaffleTicket {
-	/* int presentation of the ticket */
+	/**
+	 * Int presentation of the ticket
+	 */
 	ticekt_id: number;
-	/* String presentation of ticket */
+	/**
+	 * String presentation of the ticket
+	 */
 	ticket_id_string: string;
 }