# Interface: TMiniGameTemplate TMiniGameTemplate describes the information of mini-games available for the user ## Properties ### id > **id**: `number` ID of the mini-game template *** ### name > **name**: `string` Name of the mini-game template, translated to the user language *** ### description > **description**: `string` Description of the mini-game template, translated to the user language *** ### thumbnail > **thumbnail**: `string` URL of the icon of the mini-game template, 256x256px *** ### visibile\_when\_can\_spin? > `optional` **visibile\_when\_can\_spin?**: `boolean` Indicates if the mini-game is visible when the user have attempts/points/gems/diamonds to play *** ### saw\_game\_type > **saw\_game\_type**: [`SAWGameTypeName`](../enumerations/SAWGameTypeName.md) The type of the game, e.g. Spin the Wheel, Gift Box, Scratch card, MatchX etc *** ### saw\_buyin\_type > **saw\_buyin\_type**: [`SAWBuyInTypeName`](../enumerations/SAWBuyInTypeName.md) How the user is charged for each game attempt e.g. Free, Points or Spin attempts *** ### buyin\_cost\_points? > `optional` **buyin\_cost\_points?**: `number` in case of charging type 'Points', what is the points amount will be deducted from user balance *** ### buyin\_cost\_gems? > `optional` **buyin\_cost\_gems?**: `number` in case of charging type 'Gems', what is the gems amount will be deducted from user balance *** ### buyin\_cost\_diamonds? > `optional` **buyin\_cost\_diamonds?**: `number` in case of charging type 'Diamonds', what is the diamonds amount will be deducted from user balance *** ### spin\_count? > `optional` **spin\_count?**: `number` in case of charging type 'Spin attempts', shows the current number of spin attempts that user has *** ### next\_available\_spin\_ts > **next\_available\_spin\_ts**: `number` If the game limits the number of attempts per period of time, the epoch-ms time (UTC) when the next attempt becomes available. Populated only when the operator enabled the "show time to the next available spin" template setting, and only when the template's maximum attempts per period is 1. *** ### earliest\_expiration\_dt? > `optional` **earliest\_expiration\_dt?**: `number` Soonest-expiring spin's expiration time for the current user, as an epoch-ms timestamp. `null` when the user has no expirable spins for this template — spins only expire when the template defines a spin-expiration rule (Wheel of Fortune, Loot Boxes, etc.). Pair with `latest_expiration_dt` to render a "spins expire between X and Y" window. *** ### latest\_expiration\_dt? > `optional` **latest\_expiration\_dt?**: `number` Latest-expiring spin's expiration time for the current user, as an epoch-ms timestamp. `null` when the user has no expirable spins; equals `earliest_expiration_dt` when a single expiration applies. *** ### over\_limit\_message > **over\_limit\_message**: `string` The message that should be shown to the user when he cannot play the game, server rejected attempt with error code SAWSpinErrorCode.SAW_FAILED_MAX_SPINS_REACHED *** ### no\_attempts\_message > **no\_attempts\_message**: `string` The message that should be shown to the user when he cannot play the game because he doesn't have spin attempts or points. *** ### jackpot\_current > **jackpot\_current**: `number` Current jackpot amount, if jackpot is enabled. *** ### jackpot\_add\_on\_attempt > **jackpot\_add\_on\_attempt**: `number` The amount that will be added to the jackpot every time when somebody plays the game. Note that the contribution amount is abstract, means that no money or points are deducted from the user balance. *** ### jackpot\_symbol > **jackpot\_symbol**: `string` The symbol of jackpot that is giving the sense to the 'amount' E.g. the symbol could be EUR and connected to the amount it can indicate that amount is monetary, e.g. '100 EUR'. Or the symbol can be 'Free spins' and connected to the amount it can indicate that amount is number of free spins, e.g. '100 Free spins'. *** ### promo\_image > **promo\_image**: `string` The promo image, 500x240px *** ### promo\_text > **promo\_text**: `string` The promo text *** ### custom\_data > **custom\_data**: `any` The custom data of the mini-game defined by operator in the BackOffice. Can be a JSON object, string or number *** ### prizes > **prizes**: [`TMiniGamePrize`](TMiniGamePrize.md)[] Prizes configured for this game — see [TMiniGamePrize](TMiniGamePrize.md) *** ### expose\_game\_stat\_on\_api? > `optional` **expose\_game\_stat\_on\_api?**: `boolean` Operator template setting. When enabled, the per-prize stock statistics (`pool`, `wins_count`, `weekdays`, `active_from_ts` / `active_till_ts`) are populated on `prizes` and kept current after every play; when disabled (default) those fields are omitted. See `getMiniGames` "Per-prize statistics" *** ### relative\_period\_timezone? > `optional` **relative\_period\_timezone?**: `number` Timezone offset in minutes used to evaluate the template's period-based rules (UTC minus local, as in JS `Date.getTimezoneOffset()` — e.g. `-180` for UTC+3) *** ### activeFromDate? > `optional` **activeFromDate?**: `number` Time from which the template becomes available (epoch ms); absent when not restricted *** ### activeTillDate? > `optional` **activeTillDate?**: `number` Time until which the template stays available (epoch ms); absent when not restricted *** ### steps\_to\_finish\_game? > `optional` **steps\_to\_finish\_game?**: `number` Number of steps to complete the game and collect the prize (step games — Voyager / Treasure Hunt) *** ### custom\_section\_id? > `optional` **custom\_section\_id?**: `number` ID of the operator-defined custom section (widget menu grouping) the mini-game is assigned to *** ### saw\_template\_ui\_definition > **saw\_template\_ui\_definition**: [`SAWTemplateUI`](SAWTemplateUI.md) Full raw UI definition of the mini-game (skin, colors, per-game visual settings) — see [SAWTemplateUI](SAWTemplateUI.md). The commonly needed values are already lifted onto this template object *** ### game\_layout? > `optional` **game\_layout?**: [`SAWGameLayoutName`](../enumerations/SAWGameLayoutName.md) Grid layout of the game. Populated only for Lootbox game types (LootboxWeekdays / LootboxCalendarDays) *** ### show\_prize\_history? > `optional` **show\_prize\_history?**: `boolean` Operator setting: show a prize-history entry point (icon / button) on this game's view *** ### 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 *** ### expose\_user\_spin\_id? > `optional` **expose\_user\_spin\_id?**: [`SAWExposeUserSpinIdName`](../enumerations/SAWExposeUserSpinIdName.md) Which identifier to show next to a win result for transparency/audit — 'userId' (the player's external user id) or 'spinId' (the spin's transaction id). Absent when the operator disabled it