@smartico/public-api 0.0.283 → 0.0.285

package/dist/Jackpots/JackpotPublicMeta.d.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/dist/MiniGames/SAWGameDifficulty.d.ts

@@ -0,0 +1,12 @@
+export declare enum SAWGameDifficultyType {
+    EASY = 1,
+    MEDIUM = 2,
+    HARD = 3
+}
+export declare enum SAWGameDifficultyTypeName {
+    EASY = "easy",
+    MEDIUM = "medium",
+    HARD = "hard"
+}
+/** @hidden */
+export declare const SawGameDifficultyTypeNamed: (type: SAWGameDifficultyType) => SAWGameDifficultyTypeName;

package/dist/MiniGames/SAWPrizeUI.d.ts

@@ -7,6 +7,7 @@ export interface SAWPrizeUI {
     name_original?: string;
     hide_prize_popup: boolean;
     aknowledge_message?: string;
+    aknowledge_message_lose?: string;
     sectors?: number[];
     acknowledge_type?: SAWAcknowledgeType;
     acknowledge_dp?: string;

package/dist/MiniGames/SAWTemplateUI.d.ts

@@ -1,4 +1,5 @@
 import { SAWAskForUsername } from './SAWAskForUsername';
+import { SAWGameDifficultyType } from './SAWGameDifficulty';
 import { SAWGameLayout } from './SAWGameLayout';
 import { SAWWheelLayout } from './SAWWheelLayout';
 export interface SAWTemplateUI {
@@ -52,4 +53,5 @@ export interface SAWTemplateUI {
     steps_to_finish_game?: number;
     wheel_layout?: SAWWheelLayout;
     background_music_volume?: number;
+    game_difficulty: SAWGameDifficultyType;
 }

package/dist/Raffle/Raffle.d.ts

@@ -15,7 +15,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/dist/Raffle/RaffleDraw.d.ts

@@ -41,6 +41,7 @@ interface RaffleDraw {
     run_id: number;
     /**
      * 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.
@@ -53,19 +54,20 @@ 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;
     /**
@@ -77,6 +79,9 @@ interface RaffleDraw {
      * The number of tickets collected by current user for this instance of draw.
      */
     my_tickets_count: number;
+    /**
+     * List of last 5 tickets are collected by current user for this instance of draw.
+     */
     my_last_tickets: RaffleTicket[];
 }
 export { RaffleDraw };

package/dist/Raffle/RafflePrize.d.ts

@@ -27,24 +27,25 @@ 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
      * total number of tickets collected by all players and multiplied by number of actual prizes of this kind.

package/dist/Raffle/RaffleTicket.d.ts

@@ -1,5 +1,11 @@
 interface RaffleTicket {
+    /**
+     * Int presentation of the ticket
+     */
     id: number;
+    /**
+     * String presentation of the ticket
+     */
     s: string;
 }
 export { RaffleTicket };

package/dist/WSAPI/WSAPI.d.ts

@@ -605,13 +605,20 @@ export declare class WSAPI {
      * The onUpdate callback will be called on claiming prize.  Updated Raffles will be passed to onUpdate callback.
      *
      * **Example**:
+     *
      * ```
      * _smartico.api.getRaffles().then((result) => {
      *      console.log(result);
      * });
      * ```
      *
-     * **Visitor mode: not supported**
+     * **Example in the Visitor mode**:
+     *
+     * ```
+     * _smartico.vapi('EN').getRaffles().then((result) => {
+     *      console.log(result);
+     * });
+     * ```
      *
      */
     getRaffles({ onUpdate }?: {
@@ -622,13 +629,21 @@ export declare class WSAPI {
      *
      *
      * **Example**:
-     * ```
-     * _smartico.api.getRaffleDrawRun({raffle_id:156, run_id: 145}).then((result) => {
+     *
+     * ```javascript
+     * _smartico.api.getRaffleDrawRun({raffle_id: 156, run_id: 145}).then((result) => {
      *      console.log(result);
      * });
      * ```
      *
-     * **Visitor mode: not supported**
+     * **Example in the Visitor mode**:
+     *
+     *
+     * ```javascript
+     * _smartico.vapi('EN').getRaffleDrawRun({ raffle_id: 156, run_id: 145 }).then((result) => {
+     *      console.log(result);
+     * });
+     * ```
      *
      */
     getRaffleDrawRun(props: {
@@ -640,13 +655,20 @@ export declare class WSAPI {
      *
      *
      * **Example**:
-     * ```
+     *
+     * ```javascript
      * _smartico.api.getRaffleDrawRunHistory({raffle_id:156, draw_id: 432}).then((result) => {
      *      console.log(result);
      * });
      * ```
      *
-     * **Visitor mode: not supported**
+     * **Example in the Visitor mode**:
+     *
+     * ```javascript
+     * _smartico.vapi('EN').getRaffleDrawRunHistory({ raffle_id: 156, draw_id: 432 }).then((result) => {
+     *      console.log(result);
+     * });
+     * ```
      *
      */
     getRaffleDrawRunsHistory(props: {
@@ -658,13 +680,20 @@ export declare class WSAPI {
      *
      *
      * **Example**:
-     * ```
+     *
+     * ```javascript
      * _smartico.api.claimRafflePrize({won_id:251}).then((result) => {
      *      console.log(result);
      * });
      * ```
      *
-     * **Visitor mode: not supported**
+     * **Example in the Visitor mode**:
+     *
+     * ```javascript
+     * _smartico.vapi('EN').claimRafflePrize({ won_id: 251 }).then((result) => {
+     *      console.log(result);
+     * });
+     * ```
      *
      */
     claimRafflePrize(props: {

package/dist/WSAPI/WSAPITypes.d.ts

@@ -165,7 +165,12 @@ export interface TMiniGameTemplate {
     custom_section_id?: number;
     /** The UI definition of the mini-game */
     saw_template_ui_definition: SAWTemplateUI;
+    /** 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;
 }
 /**
  * TUser describes the information of the user
@@ -881,7 +886,13 @@ export interface TRaffle {
     draws: TRaffleDraw[];
 }
 export interface TRaffleTicket {
+    /**
+     * Int presentation of the ticket
+     */
     ticekt_id: number;
+    /**
+     * String presentation of the ticket
+     */
     ticket_id_string: string;
 }
 export interface TRafflePrize {

package/dist/index.js

@@ -450,6 +450,8 @@ var SAWTemplatesTransform = function SAWTemplatesTransform(items) {
       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(function (p) {
         var _p$saw_prize_ui_defin;
         var y = {
@@ -3173,13 +3175,20 @@ var WSAPI = /*#__PURE__*/function () {
    * The onUpdate callback will be called on claiming prize.  Updated Raffles will be passed to onUpdate callback.
    *
    * **Example**:
+   *
    * ```
    * _smartico.api.getRaffles().then((result) => {
    *      console.log(result);
    * });
    * ```
    *
-   * **Visitor mode: not supported**
+   * **Example in the Visitor mode**:
+   *
+   * ```
+   * _smartico.vapi('EN').getRaffles().then((result) => {
+   *      console.log(result);
+   * });
+   * ```
    *
    */
   ;
@@ -3203,13 +3212,21 @@ var WSAPI = /*#__PURE__*/function () {
    *
    *
    * **Example**:
-   * ```
-   * _smartico.api.getRaffleDrawRun({raffle_id:156, run_id: 145}).then((result) => {
+   *
+   * ```javascript
+   * _smartico.api.getRaffleDrawRun({raffle_id: 156, run_id: 145}).then((result) => {
    *      console.log(result);
    * });
    * ```
    *
-   * **Visitor mode: not supported**
+   * **Example in the Visitor mode**:
+   *
+   *
+   * ```javascript
+   * _smartico.vapi('EN').getRaffleDrawRun({ raffle_id: 156, run_id: 145 }).then((result) => {
+   *      console.log(result);
+   * });
+   * ```
    *
    */
   ;
@@ -3231,13 +3248,20 @@ var WSAPI = /*#__PURE__*/function () {
    *
    *
    * **Example**:
-   * ```
+   *
+   * ```javascript
    * _smartico.api.getRaffleDrawRunHistory({raffle_id:156, draw_id: 432}).then((result) => {
    *      console.log(result);
    * });
    * ```
    *
-   * **Visitor mode: not supported**
+   * **Example in the Visitor mode**:
+   *
+   * ```javascript
+   * _smartico.vapi('EN').getRaffleDrawRunHistory({ raffle_id: 156, draw_id: 432 }).then((result) => {
+   *      console.log(result);
+   * });
+   * ```
    *
    */
   ;
@@ -3259,13 +3283,20 @@ var WSAPI = /*#__PURE__*/function () {
    *
    *
    * **Example**:
-   * ```
+   *
+   * ```javascript
    * _smartico.api.claimRafflePrize({won_id:251}).then((result) => {
    *      console.log(result);
    * });
    * ```
    *
-   * **Visitor mode: not supported**
+   * **Example in the Visitor mode**:
+   *
+   * ```javascript
+   * _smartico.vapi('EN').claimRafflePrize({ won_id: 251 }).then((result) => {
+   *      console.log(result);
+   * });
+   * ```
    *
    */
   ;