@smartico/public-api 0.0.409 → 0.0.410

package/docs/api/classes/WSAPIJackpots.md

@@ -400,7 +400,7 @@ Optional callback; not auto-invoked today.
 #### Remarks
 
 **Preconditions**
-- User must be authenticated. Visitor mode not supported.
+- No authentication required — works in both identified and visitor mode.
 - `jp_template_id` is mandatory.
 
 **`onUpdate` caveat**
@@ -418,7 +418,12 @@ Treat it as a no-op for now.
 Non-zero `errCode` on control-group users or generic server errors.
 Branch on `errCode === 0` and surface `errMsg` on failure.
 
-**Visitor mode**: not supported.
+**Visitor mode**: supported via
+`_smartico.vapi(lang).getJackpotEligibleGames(...)`. The eligible-games
+list is template-level (which games contribute to the pot) and carries no
+per-user fields, so a visitor session receives the same list an identified
+user would. The `lang` passed to `_smartico.vapi(lang)` drives the
+translation of game names.
 
 **UI guidance**: see [UI Guide — `getJackpotEligibleGames`](../_media/UIGuide_getJackpotEligibleGames.md).
 
@@ -434,6 +439,10 @@ if (jp?.ach_related_game_allow_all) {
 
 const r = await window._smartico.api.getJackpotEligibleGames({ jp_template_id: 42 });
 console.log('[smartico] render', r.eligible_games.length, 'eligible game tiles');
+
+// Visitor mode — same shape, language driven by the vapi(lang) argument
+const visitor = await window._smartico.vapi('EN').getJackpotEligibleGames({ jp_template_id: 42 });
+console.log('[smartico] visitor eligible games:', visitor.eligible_games.length);
 ```
 
 ***

package/docs/api/classes/WSAPIMiniGames.md

@@ -78,6 +78,27 @@ played via [playMiniGame](#playminigame); the exceptions are:
   games server (not this SDK); the SAW spin is fired
   server-internally to deduct the buy-in.
 
+**Per-prize statistics (`expose_game_stat_on_api`)**
+Each template's `prizes` array always carries the definition
+fields — name, icon, `prize_type`, `prize_value`, acknowledge
+configuration. The stock-statistics fields are gated by an
+operator template setting, surfaced as
+`expose_game_stat_on_api`:
+- Populated when enabled: `pool` (remaining stock),
+  `wins_count` (total wins across all players), `weekdays`
+  (ISO 1–7 days the prize can be won), `active_from_ts` /
+  `active_till_ts` (prize availability window).
+- Omitted when disabled (the default) — this keeps the live
+  prize economy (stock levels, win rates, schedules) hidden
+  from players.
+- Exception: `pool` is always populated for `MatchX` / `Quiz`
+  templates, whose game flow needs the remaining stock.
+- `pool_initial` is populated regardless of the setting.
+When enabled, the values are also kept current — the server
+refreshes the prize rows on each fetch and drops its template
+caches after every play, so `pool` / `wins_count` are safe to
+drive an "X prizes left" scarcity UI.
+
 **Cache TTL**: the SDK caches the response for 30 seconds. Cache
 is fully cleared on login / logout.
 
@@ -345,14 +366,19 @@ without waiting for the win to be marked delivered. You finalise
 it later by calling [miniGameWinAcknowledgeRequest](#minigamewinacknowledgerequest) with the
 `request_id` returned on this result.
 
-What `acknowledge: false` does and does NOT defer:
-- For STANDARD prizes the value is credited at spin time
-  regardless, so opting out does NOT delay the balance change —
-  it only defers the "delivered" bookkeeping and the `is_claimed`
-  flag flipping in [getMiniGamesHistory](#getminigameshistory).
-- For operator-configured "explicit claim" prizes the credit IS
-  deferred until the spin is acknowledged, so those require an
-  explicit acknowledge to finalise.
+What `acknowledge: false` defers:
+- For STANDARD prizes the value is credited when the spin is
+  finalised — by your later acknowledge or, failing that, by the
+  server-side fallback below — so opting out delays the balance
+  change by at most that fallback window. The `is_claimed` flag in
+  [getMiniGamesHistory](#getminigameshistory) flips on the same finalisation.
+- For operator-configured "explicit claim" prizes the credit is
+  deferred until your explicit acknowledge — the fallback does not
+  cover them.
+
+While the spin is un-finalised it can also be finalised as LOST —
+prize discarded back to the pool — via
+[miniGameWinAcknowledgeRequest](#minigamewinacknowledgerequest) with `{ lose: true }`.
 
 A server-side fallback auto-acknowledges ordinary un-acknowledged
 spins after a short delay (about 1–3 minutes), so an ordinary
@@ -383,8 +409,10 @@ refreshed array.
   time the call resolves. Balance updates flow via the
   user-properties channel (observe via [getUserProfile](WSAPIUser.md#getuserprofile)).
 - Prize value credited per the prize's type (see "Prize handling"
-  above). Standard prizes are credited at spin time; "explicit
-  claim" prizes are credited when the spin is acknowledged.
+  above) when the spin is finalised — with the default
+  auto-acknowledge that happens before the call resolves;
+  "explicit claim" prizes are credited only by an explicit
+  acknowledge.
 - The play is recorded server-side for analytics / reporting.
 
 **UI guidance**: see [UI Guide — `playMiniGame`](../_media/UIGuide_playMiniGame.md).
@@ -432,18 +460,24 @@ if (r.err_code === 0) {
 ```
 
 Manual finalisation (`acknowledge: false`) — e.g. an explicit
-"Claim" CTA, or finalising on your own schedule:
+"Claim" CTA, a decline/forfeit flow, or finalising on your own
+schedule:
 ```ts
 const r = await window._smartico.api.playMiniGame(game.id, { acknowledge: false });
 if (r.err_code === 0) {
-  // Spin resolved but not yet acknowledged. For standard prizes the
-  // balance already changed server-side; "explicit claim" prizes
-  // are credited only by the acknowledge below.
+  // Spin resolved but not yet finalised — the prize is not credited
+  // yet. Your acknowledge below credits it (for standard prizes the
+  // server-side fallback would eventually do the same).
   console.log('[smartico] prize won — show the result / Claim CTA, then finalise');
 
   // On the user's Claim click, finalise with the request_id from the result.
   await window._smartico.api.miniGameWinAcknowledgeRequest(r.request_id);
   console.log('[smartico] win finalised — refresh getUserProfile / getMiniGames to reflect it');
+
+  // Or, if the game flow ends in the player declining / losing the
+  // drawn prize, finalise the spin as lost instead — the prize is
+  // not credited and returns to the prize pool:
+  // await window._smartico.api.miniGameWinAcknowledgeRequest(r.request_id, { lose: true });
 }
 ```
 
@@ -451,12 +485,13 @@ if (r.err_code === 0) {
 
 ### miniGameWinAcknowledgeRequest()
 
-> **miniGameWinAcknowledgeRequest**(`request_id`): `Promise`\<[`SAWDoAknowledgeResponse`](../interfaces/SAWDoAknowledgeResponse.md)\>
+> **miniGameWinAcknowledgeRequest**(`request_id`, `__namedParameters?`): `Promise`\<[`SAWDoAknowledgeResponse`](../interfaces/SAWDoAknowledgeResponse.md)\>
 
 Manually acknowledges a mini-game spin — marks the win delivered
-server-side. Most consumers do NOT need this: [playMiniGame](#playminigame)
-acknowledges by default (`acknowledge: true`) and
-[playMiniGameBatch](#playminigamebatch) acknowledges automatically. Call this
+server-side, or (with `lose: true`) finalises it as lost and
+returns the prize to the pool. Most consumers do NOT need this:
+[playMiniGame](#playminigame) acknowledges by default (`acknowledge: true`)
+and [playMiniGameBatch](#playminigamebatch) acknowledges automatically. Call this
 directly only when you took ownership of the acknowledge step or
 need to recover a lost one.
 
@@ -472,6 +507,12 @@ Correlation id of the spin to finalise: the
                    `client_request_id` of a
                    [getMiniGamesHistory](#getminigameshistory) row.
 
+##### \_\_namedParameters?
+
+###### lose?
+
+`boolean`
+
 #### Returns
 
 `Promise`\<[`SAWDoAknowledgeResponse`](../interfaces/SAWDoAknowledgeResponse.md)\>
@@ -496,6 +537,23 @@ The `request_id` on a [playMiniGame](#playminigame) result and the
 `client_request_id` on a [getMiniGamesHistory](#getminigameshistory) row are the
 same correlation id — this method accepts either.
 
+**Finalising as lost (`lose: true`)**
+Pass `{ lose: true }` to finalise the spin as LOST instead of won:
+the prize is NOT credited and is returned to the game's prize pool
+(available again for other players), and the spin fires the
+mini-game "lose" engagement event instead of the win one. On the
+next [getMiniGamesHistory](#getminigameshistory) fetch the row shows `is_claimed:
+true` with no prize attached. Use this for game mechanics where the
+player can decline or forfeit the drawn prize — e.g. a
+gamble/discard step, or a client-driven game where the user's final
+action decides whether the pre-drawn prize is actually won. It only
+works on a spin that is not yet finalised, so it requires playing
+with `acknowledge: false` and calling promptly — once the automatic
+acknowledge or the server-side fallback (below) has finalised the
+spin, `lose: true` is a no-op and the prize stays credited.
+("Explicit claim" prizes are exempt from the fallback, so for them
+there is no time pressure.)
+
 **Idempotency**: safe. Acknowledging a spin that is already
 finalised — by you, by the automatic acknowledge, or by the
 fallback — is a no-op with no double credit. Acknowledging a
@@ -510,11 +568,12 @@ exception — excluded from the fallback, they require an explicit
 call here.
 
 **Side effects** (first successful call for an un-acknowledged spin)
-- For "explicit claim" prizes, the prize value is credited on this
-  call. For standard prizes the value was already credited at spin
-  time (see [playMiniGame](#playminigame) "Prize handling"); this call only
-  marks the win delivered.
-- The spin's `is_claimed` flips to `true` on the next
+- Default (win): the prize value is credited on this call — this is
+  the finalisation step that credits standard and "explicit claim"
+  prizes alike (see [playMiniGame](#playminigame) "Prize handling").
+- With `lose: true`: no credit; the prize returns to the prize pool
+  and the "lose" engagement event fires.
+- Either way the spin's `is_claimed` flips to `true` on the next
   [getMiniGamesHistory](#getminigameshistory) fetch.
 
 **Visitor mode**: not supported.
@@ -529,6 +588,10 @@ if (r.err_code === 0) {
   await window._smartico.api.miniGameWinAcknowledgeRequest(r.request_id);
 }
 
+// Decline / forfeit — finalise the same spin as lost instead:
+// the prize is not credited and goes back to the prize pool.
+await window._smartico.api.miniGameWinAcknowledgeRequest(r.request_id, { lose: true });
+
 // Recovery — re-acknowledge any spins a batch acknowledge missed.
 const history = await window._smartico.api.getMiniGamesHistory({ limit: 20 });
 for (const row of history.filter(h => !h.is_claimed)) {

package/docs/api/interfaces/SAWDoAknowledgeRequest.md

@@ -39,3 +39,11 @@
 ### request\_id
 
 > **request\_id**: `string`
+
+***
+
+### lose?
+
+> `optional` **lose?**: `boolean`
+
+When true, finalises the spin as lost: the prize is not credited and is returned to the prize pool.

package/docs/api/interfaces/SAWPrize.md

@@ -48,54 +48,72 @@
 
 > `optional` **pool?**: `number`
 
+Remaining stock. Present only when the template's `expose_game_stat_on_api` is enabled; always present for MatchX / Quiz games
+
 ***
 
 ### pool\_initial?
 
 > `optional` **pool\_initial?**: `number`
 
+Initial (configured) stock. Present regardless of `expose_game_stat_on_api`
+
 ***
 
 ### wins\_count?
 
 > `optional` **wins\_count?**: `number`
 
+Times the prize has been won, across all players. Present only when `expose_game_stat_on_api` is enabled
+
 ***
 
 ### weekdays?
 
 > `optional` **weekdays?**: `number`[]
 
+ISO weekday numbers (1 = Monday … 7 = Sunday) the prize can be won on; absent = any day. Present only when `expose_game_stat_on_api` is enabled
+
 ***
 
 ### active\_from\_ts?
 
 > `optional` **active\_from\_ts?**: `number`
 
+Prize availability window start (epoch ms), evaluated against `relative_period_timezone`. Present only when `expose_game_stat_on_api` is enabled
+
 ***
 
 ### active\_till\_ts?
 
 > `optional` **active\_till\_ts?**: `number`
 
+Prize availability window end (epoch ms), evaluated against `relative_period_timezone`. Present only when `expose_game_stat_on_api` is enabled
+
 ***
 
 ### relative\_period\_timezone?
 
 > `optional` **relative\_period\_timezone?**: `number`
 
+Timezone offset in minutes for `weekdays` / active-window evaluation (UTC minus local, as in JS `Date.getTimezoneOffset()`)
+
 ***
 
 ### is\_surcharge?
 
 > `optional` **is\_surcharge?**: `boolean`
 
+When true, the prize stays winnable at `pool` 0 (unlimited stock)
+
 ***
 
 ### is\_deleted?
 
 > `optional` **is\_deleted?**: `boolean`
 
+Always `false` in API responses — deleted prizes are excluded server-side
+
 ***
 
 ### prize\_details\_json?

package/docs/api/interfaces/SAWTemplate.md

@@ -158,6 +158,8 @@ Latest-expiring spin's expiration time for this user (epoch ms); `null`/absent w
 
 > `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`; when disabled (default) the server strips them from the response (`pool` is kept for MatchX / Quiz games).
+
 ***
 
 ### requires\_prize\_claim?

package/docs/api/interfaces/TMiniGamePrize.md

@@ -125,6 +125,22 @@ The name of the action button in modal pop-up (additional)
 
 ***
 
+### second\_btn?
+
+> `optional` **second\_btn?**: `string`
+
+Deep link that will trigger some action in modal pop-up (second button)
+
+***
+
+### second\_btn\_action\_title?
+
+> `optional` **second\_btn\_action\_title?**: `string`
+
+The name of the action button in modal pop-up (second button)
+
+***
+
 ### out\_of\_stock\_message?
 
 > `optional` **out\_of\_stock\_message?**: `string`
@@ -137,7 +153,7 @@ Message when the prize pool is empty for that specific prize
 
 > `optional` **pool?**: `number`
 
-Number of items in stock
+Remaining stock of the prize — decrements on each win, refunded if the spin is finalised as lost. Populated only when the template's `expose_game_stat_on_api` is enabled; always populated for MatchX / Quiz games
 
 ***
 
@@ -145,7 +161,7 @@ Number of items in stock
 
 > `optional` **pool\_initial?**: `number`
 
-Initial number of items in stock
+Initial (configured) stock of the prize. Populated regardless of `expose_game_stat_on_api`
 
 ***
 
@@ -153,7 +169,7 @@ Initial number of items in stock
 
 > `optional` **wins\_count?**: `number`
 
-Number of wins in game
+Number of times the prize has been won, across all players. Populated only when the template's `expose_game_stat_on_api` is enabled
 
 ***
 
@@ -161,7 +177,7 @@ Number of wins in game
 
 > `optional` **weekdays?**: `number`[]
 
-Number of days of week, when the prize can be available
+ISO weekday numbers (1 = Monday … 7 = Sunday) on which the prize can be won; absent = any day. Populated only when the template's `expose_game_stat_on_api` is enabled
 
 ***
 
@@ -169,7 +185,7 @@ Number of days of week, when the prize can be available
 
 > `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)
+Time from which the prize can be won (epoch ms), evaluated against `relative_period_timezone`. Populated only when the template's `expose_game_stat_on_api` is enabled
 
 ***
 
@@ -177,7 +193,7 @@ Holds time from which prize will become available, for the prizes that are targe
 
 > `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)
+Time until which the prize can be won (epoch ms), evaluated against `relative_period_timezone`. Populated only when the template's `expose_game_stat_on_api` is enabled
 
 ***
 
@@ -185,7 +201,7 @@ Holds time till which prize will become available, for the prizes that are targe
 
 > `optional` **relative\_period\_timezone?**: `number`
 
-Time zone to ensure each day aligns with your local midnight.
+Timezone offset in minutes used to evaluate `weekdays` and the active window (UTC minus local, as in JS `Date.getTimezoneOffset()` — e.g. `-180` for UTC+3)
 
 ***
 
@@ -193,7 +209,7 @@ Time zone to ensure each day aligns with your local midnight.
 
 > `optional` **is\_surcharge?**: `boolean`
 
-Flag indicating that the prize is surcharged (available all the time, despite pool numbers)
+When true, the prize stays winnable even when its `pool` reaches 0 (effectively unlimited stock)
 
 ***
 
@@ -201,7 +217,7 @@ Flag indicating that the prize is surcharged (available all the time, despite po
 
 > `optional` **is\_deleted?**: `boolean`
 
-Flag indicating the state of the prize
+Always `false` in API responses — deleted prizes are excluded server-side
 
 ***
 

package/docs/api/interfaces/TMiniGameTemplate.md

@@ -200,7 +200,7 @@ List of prizes for mini-games
 
 > `optional` **expose\_game\_stat\_on\_api?**: `boolean`
 
-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
+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"
 
 ***
 
@@ -240,7 +240,7 @@ The amount of steps to complete the game and gather the prize
 
 > `optional` **custom\_section\_id?**: `number`
 
-Hold the id of the custom section
+ID of the operator-defined custom section (widget menu grouping) the mini-game is assigned to
 
 ***
 
@@ -288,4 +288,4 @@ The period of time in milliseconds during which the user can do the maximum numb
 
 > `optional` **expose\_user\_spin\_id?**: [`SAWExposeUserSpinIdName`](../enumerations/SAWExposeUserSpinIdName.md)
 
-The ID of the user spin id to expose on the game
+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

package/docs/capabilities/getJackpotEligibleGames.md

@@ -33,7 +33,7 @@ _None._
 
 ## Behavioral contract
 **Preconditions**
-- User must be authenticated. Visitor mode not supported.
+- No authentication required — works in both identified and visitor mode.
 - `jp_template_id` is mandatory.
 
 **`onUpdate` caveat**
@@ -51,7 +51,12 @@ Treat it as a no-op for now.
 Non-zero `errCode` on control-group users or generic server errors.
 Branch on `errCode === 0` and surface `errMsg` on failure.
 
-**Visitor mode**: not supported.
+**Visitor mode**: supported via
+`_smartico.vapi(lang).getJackpotEligibleGames(...)`. The eligible-games
+list is template-level (which games contribute to the pot) and carries no
+per-user fields, so a visitor session receives the same list an identified
+user would. The `lang` passed to `_smartico.vapi(lang)` drives the
+translation of game names.
 
 **UI guidance**: see [UI Guide — `getJackpotEligibleGames`](../../docs/ui/jackpots/UIGuide_getJackpotEligibleGames.md).
 
@@ -66,6 +71,10 @@ if (jp?.ach_related_game_allow_all) {
 
 const r = await window._smartico.api.getJackpotEligibleGames({ jp_template_id: 42 });
 console.log('[smartico] render', r.eligible_games.length, 'eligible game tiles');
+
+// Visitor mode — same shape, language driven by the vapi(lang) argument
+const visitor = await window._smartico.vapi('EN').getJackpotEligibleGames({ jp_template_id: 42 });
+console.log('[smartico] visitor eligible games:', visitor.eligible_games.length);
 ```
 
 ### Example response (REAL shape)

package/docs/capabilities/getMiniGames.md

@@ -57,28 +57,30 @@ Array of `TMiniGameTemplate`. Each item:
   - `acknowledge_action_title` (string) — The name of the action button in modal pop-up
   - `acknowledge_dp_additional` (string) — Deep link that will trigger some action in modal pop-up (additional)
   - `acknowledge_action_title_additional` (string) — The name of the action button in modal pop-up (additional)
+  - `second_btn` (string) — Deep link that will trigger some action in modal pop-up (second button)
+  - `second_btn_action_title` (string) — The name of the action button in modal pop-up (second button)
   - `out_of_stock_message` (string) — Message when the prize pool is empty for that specific prize
-  - `pool` (number) — Number of items in stock
-  - `pool_initial` (number) — Initial number of items in stock
-  - `wins_count` (number) — Number of wins in game
-  - `weekdays` (number[]) — Number of days of week, when the prize can be available
-  - `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` (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` (number) — Time zone to ensure each day aligns with your local midnight.
-  - `is_surcharge` (boolean) — Flag indicating that the prize is surcharged (available all the time, despite pool numbers)
-  - `is_deleted` (boolean) — Flag indicating the state of the prize
+  - `pool` (number) — Remaining stock of the prize — decrements on each win, refunded if the spin is finalised as lost. Populated only when the template's `expose_game_stat_on_api` is enabled; always populated for MatchX / Quiz games
+  - `pool_initial` (number) — Initial (configured) stock of the prize. Populated regardless of `expose_game_stat_on_api`
+  - `wins_count` (number) — Number of times the prize has been won, across all players. Populated only when the template's `expose_game_stat_on_api` is enabled
+  - `weekdays` (number[]) — ISO weekday numbers (1 = Monday … 7 = Sunday) on which the prize can be won; absent = any day. Populated only when the template's `expose_game_stat_on_api` is enabled
+  - `active_from_ts` (number) — Time from which the prize can be won (epoch ms), evaluated against `relative_period_timezone`. Populated only when the template's `expose_game_stat_on_api` is enabled
+  - `active_till_ts` (number) — Time until which the prize can be won (epoch ms), evaluated against `relative_period_timezone`. Populated only when the template's `expose_game_stat_on_api` is enabled
+  - `relative_period_timezone` (number) — Timezone offset in minutes used to evaluate `weekdays` and the active window (UTC minus local, as in JS `Date.getTimezoneOffset()` — e.g. `-180` for UTC+3)
+  - `is_surcharge` (boolean) — When true, the prize stays winnable even when its `pool` reaches 0 (effectively unlimited stock)
+  - `is_deleted` (boolean) — Always `false` in API responses — deleted prizes are excluded server-side
   - `custom_data` (any) — The custom data of the mini-game defined by operator in the BackOffice. Can be a JSON object, string or number
   - `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.
   - `allow_split_decimal` (boolean) — When enabled, you can split prize value by decimal values
   - `hide_prize_from_history` (boolean) — When enabled, you can hide prize from prize history
   - `requirements_to_get_prize` (string) — Requirements to claim the prize (lootbox specific)
   - `max_give_period_type_id` (AttemptPeriodType) — The period type for the prize to be given: Time from last attempt, Calendar days UTC, Calendar days user time zone, Lifetime
-- `expose_game_stat_on_api` (boolean) — 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) — 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` (number) — Time zone to ensure each day aligns with your local midnight.
 - `activeFromDate` (number) — Holds time from which template will become available, for the template that are targeted to be available from specific time (UNIX timestamp)
 - `activeTillDate` (number) — Holds time till which template will become available, for the templates that are targeted to be available from specific time (UNIX timestamp)
 - `steps_to_finish_game` (number) — The amount of steps to complete the game and gather the prize
-- `custom_section_id` (number) — Hold the id of the custom section
+- `custom_section_id` (number) — ID of the operator-defined custom section (widget menu grouping) the mini-game is assigned to
 - `saw_template_ui_definition` (SAWTemplateUI) — The UI definition of the mini-game
   - `skin` (string)
   - `name` (string)
@@ -128,7 +130,7 @@ Array of `TMiniGameTemplate`. Each item:
 - `show_prize_history` (boolean) — When enabled the prize history icon is visible on a certain template
 - `max_number_of_attempts` (number) — The maximum number of attempts that user can do during period of time
 - `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` (SAWExposeUserSpinIdName) — The ID of the user spin id to expose on the game
+- `expose_user_spin_id` (SAWExposeUserSpinIdName) — 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
 
 ## Behavioral contract
 **Subscription model (`onUpdate`)**
@@ -166,6 +168,27 @@ played via `playMiniGame`; the exceptions are:
  games server (not this SDK); the SAW spin is fired
  server-internally to deduct the buy-in.
 
+**Per-prize statistics (`expose_game_stat_on_api`)**
+Each template's `prizes` array always carries the definition
+fields — name, icon, `prize_type`, `prize_value`, acknowledge
+configuration. The stock-statistics fields are gated by an
+operator template setting, surfaced as
+`expose_game_stat_on_api`:
+- Populated when enabled: `pool` (remaining stock),
+ `wins_count` (total wins across all players), `weekdays`
+ (ISO 1–7 days the prize can be won), `active_from_ts` /
+ `active_till_ts` (prize availability window).
+- Omitted when disabled (the default) — this keeps the live
+ prize economy (stock levels, win rates, schedules) hidden
+ from players.
+- Exception: `pool` is always populated for `MatchX` / `Quiz`
+ templates, whose game flow needs the remaining stock.
+- `pool_initial` is populated regardless of the setting.
+When enabled, the values are also kept current — the server
+refreshes the prize rows on each fetch and drops its template
+caches after every play, so `pool` / `wins_count` are safe to
+drive an "X prizes left" scarcity UI.
+
 **Cache TTL**: the SDK caches the response for 30 seconds. Cache
 is fully cleared on login / logout.
 

package/docs/capabilities/miniGameWinAcknowledgeRequest.md

@@ -1,16 +1,17 @@
 # miniGameWinAcknowledgeRequest — API
 
-> Manually acknowledges a mini-game spin — marks the win delivered server-side.
+> Manually acknowledges a mini-game spin — marks the win delivered server-side, or (with `lose: true`) finalises it as lost and returns the prize to the pool.
 > Import: `import { /* types */ } from '@smartico/public-api'`
 > Search terms: miniGameWinAcknowledgeRequest, minigames, doSAWAcknowledge, SAWAcknowledge, acknowledge, SAWAcknowledgeType, request_id, errCode, errMsg, cid, ts, uuid, payload, duration
 
 ## Signature
 ```ts
-_smartico.api.miniGameWinAcknowledgeRequest(request_id: string): void
+_smartico.api.miniGameWinAcknowledgeRequest(request_id: string, { lose }: { lose?: boolean } = {}): void
 ```
 
 ## Parameters
 - `request_id` — Correlation id of the spin to finalise: the `request_id` from a `playMiniGame` result (played with `acknowledge: false`), or the `client_request_id` of a `getMiniGamesHistory` row.
+- `options.lose` — Optional. When `true`, finalises the spin as lost — the prize is not credited and returns to the prize pool (see "Finalising as lost"). Omit (or pass `false`) to deliver the win.
 
 ## Returns
 _No return value._
@@ -34,6 +35,23 @@ The `request_id` on a `playMiniGame` result and the
 `client_request_id` on a `getMiniGamesHistory` row are the
 same correlation id — this method accepts either.
 
+**Finalising as lost (`lose: true`)**
+Pass `{ lose: true }` to finalise the spin as LOST instead of won:
+the prize is NOT credited and is returned to the game's prize pool
+(available again for other players), and the spin fires the
+mini-game "lose" engagement event instead of the win one. On the
+next `getMiniGamesHistory` fetch the row shows `is_claimed:
+true` with no prize attached. Use this for game mechanics where the
+player can decline or forfeit the drawn prize — e.g. a
+gamble/discard step, or a client-driven game where the user's final
+action decides whether the pre-drawn prize is actually won. It only
+works on a spin that is not yet finalised, so it requires playing
+with `acknowledge: false` and calling promptly — once the automatic
+acknowledge or the server-side fallback (below) has finalised the
+spin, `lose: true` is a no-op and the prize stays credited.
+("Explicit claim" prizes are exempt from the fallback, so for them
+there is no time pressure.)
+
 **Idempotency**: safe. Acknowledging a spin that is already
 finalised — by you, by the automatic acknowledge, or by the
 fallback — is a no-op with no double credit. Acknowledging a
@@ -48,11 +66,12 @@ exception — excluded from the fallback, they require an explicit
 call here.
 
 **Side effects** (first successful call for an un-acknowledged spin)
-- For "explicit claim" prizes, the prize value is credited on this
- call. For standard prizes the value was already credited at spin
- time (see `playMiniGame` "Prize handling"); this call only
- marks the win delivered.
-- The spin's `is_claimed` flips to `true` on the next
+- Default (win): the prize value is credited on this call — this is
+ the finalisation step that credits standard and "explicit claim"
+ prizes alike (see `playMiniGame` "Prize handling").
+- With `lose: true`: no credit; the prize returns to the prize pool
+ and the "lose" engagement event fires.
+- Either way the spin's `is_claimed` flips to `true` on the next
  `getMiniGamesHistory` fetch.
 
 **Visitor mode**: not supported.
@@ -66,6 +85,10 @@ if (r.err_code === 0) {
   await window._smartico.api.miniGameWinAcknowledgeRequest(r.request_id);
 }
 
+// Decline / forfeit — finalise the same spin as lost instead:
+// the prize is not credited and goes back to the prize pool.
+await window._smartico.api.miniGameWinAcknowledgeRequest(r.request_id, { lose: true });
+
 // Recovery — re-acknowledge any spins a batch acknowledge missed.
 const history = await window._smartico.api.getMiniGamesHistory({ limit: 20 });
 for (const row of history.filter(h => !h.is_claimed)) {