@smartico/public-api 0.0.379 → 0.0.381

package/docs/api/interfaces/JackpotPot.md

@@ -1,12 +1,15 @@
 # Interface: JackpotPot
 
+Live snapshot of one jackpot pot's value and temperature.
+Embedded on `JackpotDetails.pot`; refreshed at the 1 s SDK cache TTL.
+
 ## Properties
 
 ### jp\_template\_id
 
 > **jp\_template\_id**: `number`
 
-ID of the jackpot template
+Template ID this pot belongs to.
 
 ***
 
@@ -14,7 +17,7 @@ ID of the jackpot template
 
 > **jp\_pot\_id**: `number`
 
-ID of the jackpot pot
+Stable numeric ID of the current pot instance (rotates when the pot explodes).
 
 ***
 
@@ -22,7 +25,7 @@ ID of the jackpot pot
 
 > **current\_pot\_amount**: `number`
 
-currency of the jackpot pot in the Jackput base currency
+Current pot amount in the jackpot's native currency (`jp_currency`).
 
 ***
 
@@ -30,7 +33,7 @@ currency of the jackpot pot in the Jackput base currency
 
 > **current\_pot\_amount\_user\_currency**: `number`
 
-currency of the jackpot pot in the user wallet currency
+Current pot amount converted to the user's wallet currency (`user_currency`).
 
 ***
 
@@ -38,7 +41,7 @@ currency of the jackpot pot in the user wallet currency
 
 > **explode\_date\_ts**: `number`
 
-the date/time when this pot exploded
+Unix ms timestamp of when this pot last exploded; `0` if it has never exploded.
 
 ***
 
@@ -46,4 +49,4 @@ the date/time when this pot exploded
 
 > **current\_pot\_temperature**: [`JackPotTemparature`](../enumerations/JackPotTemparature.md)
 
-current pot temperature
+Heat band of the pot relative to its explosion range; see [JackPotTemparature](../enumerations/JackPotTemparature.md).

package/docs/api/interfaces/LeaderBoardDetailsT.md

@@ -1,12 +1,16 @@
 # Interface: LeaderBoardDetailsT
 
+LeaderBoardDetailsT describes one period's leaderboard.
+Returned by `_smartico.api.getLeaderBoard(periodType, getPreviousPeriod?)`.
+May be `undefined` at runtime when no board is configured for the requested period.
+
 ## Properties
 
 ### board\_id
 
 > **board\_id**: `number`
 
-ID of the leaderboard
+Stable ID of the leaderboard.
 
 ***
 
@@ -14,7 +18,7 @@ ID of the leaderboard
 
 > **name**: `string`
 
-Name of the leaderboard
+Operator-defined display name.
 
 ***
 
@@ -22,7 +26,7 @@ Name of the leaderboard
 
 > **description**: `string`
 
-Description of the leaderboard
+Operator-defined description (HTML allowed).
 
 ***
 
@@ -30,7 +34,7 @@ Description of the leaderboard
 
 > **rules**: `string`
 
-Rules of the leaderboard
+Operator-defined rules / terms (HTML allowed).
 
 ***
 
@@ -38,7 +42,7 @@ Rules of the leaderboard
 
 > **period\_type\_id**: [`LeaderBoardPeriodType`](../enumerations/LeaderBoardPeriodType.md)
 
-Leaderboard period type ID
+Period type this board is bound to ([LeaderBoardPeriodType](../enumerations/LeaderBoardPeriodType.md)).
 
 ***
 
@@ -46,7 +50,7 @@ Leaderboard period type ID
 
 > **rewards**: [`LeaderBoardsRewardsT`](LeaderBoardsRewardsT.md)[]
 
-Leaderboard points rewards
+Per-place prize table; the array length is the number of paid places.
 
 ***
 
@@ -54,7 +58,7 @@ Leaderboard points rewards
 
 > **users**: [`LeaderBoardUserT`](LeaderBoardUserT.md)[]
 
-Leaderboard users
+Top-20 ranked entries (server-capped), sorted by `position` ASC.
 
 ***
 
@@ -62,4 +66,6 @@ Leaderboard users
 
 > `optional` **me?**: [`LeaderBoardUserT`](LeaderBoardUserT.md)
 
-Info about current user in leaderboard
+Current user's own entry. `undefined` for visitor sessions.
+For authenticated users, `position === -1` means the user is
+unranked / outside the ranked window.

package/docs/api/interfaces/LeaderBoardUserT.md

@@ -1,12 +1,14 @@
 # Interface: LeaderBoardUserT
 
+LeaderBoardUserT describes one participant row on a leaderboard.
+
 ## Properties
 
 ### public\_username
 
 > **public\_username**: `string`
 
-The username of the participant
+Display username (operator-defined alias).
 
 ***
 
@@ -14,7 +16,7 @@ The username of the participant
 
 > **avatar\_url**: `string`
 
-The URL to the avatar of the participant
+Resolved CDN URL for the participant's avatar.
 
 ***
 
@@ -22,7 +24,8 @@ The URL to the avatar of the participant
 
 > **position**: `number`
 
-The position of the participant in the leaderboard
+Rank in the leaderboard (DENSE_RANK over all participants).
+`-1` on the `me` entry signals "unranked / outside the window".
 
 ***
 
@@ -30,7 +33,7 @@ The position of the participant in the leaderboard
 
 > **points**: `number`
 
-The points of the participant in the leaderboard
+Participant's points for this period.
 
 ***
 
@@ -38,4 +41,4 @@ The points of the participant in the leaderboard
 
 > **is\_me**: `boolean`
 
-The indicator if the participant is current user
+`true` when this row is the current authenticated user.

package/docs/api/interfaces/LeaderBoardsRewardsT.md

@@ -1,13 +1,20 @@
 # Interface: LeaderBoardsRewardsT
 
+LeaderBoardsRewardsT describes one place's prize on a leaderboard.
+Leaderboard prizes are always gamification points (never gems / diamonds / items).
+
 ## Properties
 
 ### place
 
 > **place**: `number`
 
+Place number (1-based).
+
 ***
 
 ### points
 
 > **points**: `number`
+
+Gamification points awarded to the user occupying this place at period finalization.

package/docs/api/interfaces/PointsLog.md

@@ -0,0 +1,43 @@
+# Interface: PointsLog
+
+## Properties
+
+### create\_date
+
+> **create\_date**: `number`
+
+***
+
+### user\_ext\_id
+
+> **user\_ext\_id**: `string`
+
+***
+
+### crm\_brand\_id
+
+> **crm\_brand\_id**: `number`
+
+***
+
+### points\_collected
+
+> **points\_collected**: `number`
+
+***
+
+### user\_points\_ever
+
+> **user\_points\_ever**: `number`
+
+***
+
+### user\_points\_balance
+
+> **user\_points\_balance**: `number`
+
+***
+
+### source\_type\_id
+
+> **source\_type\_id**: [`PointChangeSourceType`](../enumerations/PointChangeSourceType.md)

package/docs/api/interfaces/RaffleWonPrize.md

@@ -0,0 +1,59 @@
+# Interface: RaffleWonPrize
+
+A single prize the user won within the raffle.
+
+## Properties
+
+### raf\_won\_id
+
+> **raf\_won\_id**: `number`
+
+Unique ID of the winning row (pass to `claimRafflePrize` when `requires_claim` is `true`).
+
+***
+
+### prize\_id
+
+> **prize\_id**: `number`
+
+ID of the prize definition.
+
+***
+
+### raffle\_run\_id
+
+> **raffle\_run\_id**: `number`
+
+Run-instance ID of the draw that awarded this prize.
+
+***
+
+### draw\_id
+
+> **draw\_id**: `number`
+
+Schedule ID of the draw that awarded this prize.
+
+***
+
+### public\_meta
+
+> **public\_meta**: [`RaffleWonPrizePublicMeta`](RaffleWonPrizePublicMeta.md)
+
+Presentation meta (name / image).
+
+***
+
+### requires\_claim
+
+> **requires\_claim**: `boolean`
+
+Whether this prize requires a claim action from the user.
+
+***
+
+### claimed\_date
+
+> **claimed\_date**: `number`
+
+Epoch ms when the prize was claimed; `null` when not yet claimed.

package/docs/api/interfaces/RaffleWonPrizePublicMeta.md

@@ -0,0 +1,27 @@
+# Interface: RaffleWonPrizePublicMeta
+
+Presentation meta for a won prize.
+
+## Properties
+
+### name
+
+> **name**: `string`
+
+Name of the prize, e.g. '1 $'.
+
+***
+
+### hide\_chance\_to\_win
+
+> **hide\_chance\_to\_win**: `boolean`
+
+Indicates whether the chance to win should be hidden in the UI.
+
+***
+
+### image\_url
+
+> **image\_url**: `string`
+
+URL of the image that represents the prize.

package/docs/api/interfaces/RaffleWonPrizeUser.md

@@ -0,0 +1,43 @@
+# Interface: RaffleWonPrizeUser
+
+The user the won-prizes list belongs to.
+
+## Properties
+
+### user\_id
+
+> **user\_id**: `number`
+
+Internal user ID.
+
+***
+
+### avatar\_id
+
+> **avatar\_id**: `string`
+
+Avatar image: a full URL for a system avatar, otherwise an avatar token to resolve against the widget's avatar domain.
+
+***
+
+### avatar\_real\_id
+
+> **avatar\_real\_id**: `number`
+
+Numeric ID of the user's selected avatar definition.
+
+***
+
+### public\_username?
+
+> `optional` **public\_username?**: `string`
+
+Public username; server-masked for other users (e.g. `"32:r*****"`).
+
+***
+
+### avatar\_url?
+
+> `optional` **avatar\_url?**: `string`
+
+Always `null` on the wire — use `avatar_id`.

package/docs/api/interfaces/SAWTemplateUI.md

@@ -563,3 +563,13 @@ controlling obstacle frequency and game speed.
 | `SAWGameDifficultyType.EASY = 1` | Easy |
 | `SAWGameDifficultyType.MEDIUM = 2` | Medium |
 | `SAWGameDifficultyType.HARD = 3` | Hard |
+
+***
+
+### voyager\_seed\_window\_min?
+
+> `optional` **voyager\_seed\_window\_min?**: `number`
+
+Minutes for the Voyager seed window.
+The seed window is the range of seeds that can be used to generate the map.
+The seed window is used to ensure that the map is generated the same way for each player.

package/docs/api/interfaces/TAchCategory.md

@@ -1,6 +1,14 @@
 # Interface: TAchCategory
 
-TAchCategory describes the badge category item. Each badge item can be assigned to 1 or more categories
+TAchCategory describes a mission/badge category. Categories are
+operator-defined groupings, configured per-label by the brand operator,
+shared across BOTH missions and badges — the same list is returned for
+both entity types. A mission or badge can belong to **zero or more**
+categories (many-to-many) via its `category_ids: number[]` field on
+`TMissionOrBadge`.
+
+Returned by `_smartico.api.getAchCategories()`. See that method's TSDoc
+for translation, refresh, and rendering details.
 
 ## Properties
 
@@ -8,7 +16,8 @@ TAchCategory describes the badge category item. Each badge item can be assigned
 
 > **id**: `number`
 
-ID of the badge category
+Stable numeric ID of the category. Used as the key when joining to
+`TMissionOrBadge.category_ids: number[]`.
 
 ***
 
@@ -16,7 +25,7 @@ ID of the badge category
 
 > **name**: `string`
 
-Name of the badge category
+Display name of the category, pre-translated server-side. Never null.
 
 ***
 
@@ -24,4 +33,5 @@ Name of the badge category
 
 > **order**: `number`
 
-Order of the badge category among other categories. Default value is 1
+Relative display position (lower = appears first). Default 1 when the
+operator did not configure an explicit order.

package/docs/api/interfaces/TAvatarCustomized.md

@@ -1,6 +1,6 @@
 # Interface: TAvatarCustomized
 
-TAvatarCustomized describes an AI-customized version of a base avatar
+One AI-generated variant of a base avatar. Returned by `getAvatarsCustomized()`.
 
 ## Properties
 
@@ -8,7 +8,7 @@ TAvatarCustomized describes an AI-customized version of a base avatar
 
 > **avatar\_real\_id**: `number`
 
-The avatar_real_id of the base avatar this customization was generated from
+`avatar_real_id` of the base avatar this variant was generated from.
 
 ***
 
@@ -16,7 +16,7 @@ The avatar_real_id of the base avatar this customization was generated from
 
 > **url**: `string`
 
-Full CDN URL of the AI-generated customized avatar image
+Absolute CDN URL of the AI-generated image. Can be passed as `avatar_url` to `setAvatar()`.
 
 ***
 
@@ -24,4 +24,4 @@ Full CDN URL of the AI-generated customized avatar image
 
 > **dt\_created**: `string`
 
-ISO date string when the customization was created
+ISO date string of when the variant was generated.

package/docs/api/interfaces/TAvatarDefinition.md

@@ -1,6 +1,6 @@
 # Interface: TAvatarDefinition
 
-TAvatarDefinition describes a single avatar available in the avatar catalog.
+One avatar in the user's catalog. Returned by `getAvatarsList()`.
 Fields from the raw `public_meta` object are flattened to the top level.
 
 ## Properties
@@ -9,7 +9,7 @@ Fields from the raw `public_meta` object are flattened to the top level.
 
 > **avatar\_real\_id**: `number`
 
-Unique identifier of the avatar
+Stable numeric identifier of the avatar. Primary key passed to `setAvatar()`.
 
 ***
 
@@ -17,7 +17,7 @@ Unique identifier of the avatar
 
 > **is\_default**: `boolean`
 
-Whether this avatar is the default one
+True when this is the system default avatar for the label.
 
 ***
 
@@ -25,7 +25,7 @@ Whether this avatar is the default one
 
 > **hide\_until\_achieved**: `boolean`
 
-If true, avatar is hidden until user achieves/unlocks it
+When true and `is_given === false`, the avatar should be hidden from the user (surprise unlock).
 
 ***
 
@@ -33,7 +33,7 @@ If true, avatar is hidden until user achieves/unlocks it
 
 > **priority**: `number`
 
-Display priority — lower value means higher position in the grid
+Display position; lower = earlier in the grid.
 
 ***
 
@@ -41,7 +41,7 @@ Display priority — lower value means higher position in the grid
 
 > `optional` **description?**: `string`
 
-Optional description of the avatar (from public_meta)
+Optional description shown alongside the avatar in detail views.
 
 ***
 
@@ -49,7 +49,7 @@ Optional description of the avatar (from public_meta)
 
 > **url**: `string`
 
-Raw image path/URL of the avatar as returned by the server (from public_meta)
+Raw image path as returned by the server (relative or absolute).
 
 ***
 
@@ -57,7 +57,7 @@ Raw image path/URL of the avatar as returned by the server (from public_meta)
 
 > **avatar\_url**: `string`
 
-Full CDN URL of the avatar image, built from avatar_domain + url
+Absolute CDN URL of the avatar image; built from the configured avatar domain + `url`.
 
 ***
 
@@ -65,8 +65,7 @@ Full CDN URL of the avatar image, built from avatar_domain + url
 
 > **avatar\_source\_type\_id**: `number`
 
-Source type of the avatar.
-0 = free (always available to all users), other values = earned/purchased
+Source type. `0` = free / always available; non-zero = earned or purchased.
 
 ***
 
@@ -74,7 +73,7 @@ Source type of the avatar.
 
 > `optional` **active\_from\_date?**: `string`
 
-ISO date string from which the avatar becomes available
+ISO date string from which the avatar becomes available; undefined when no start window.
 
 ***
 
@@ -82,7 +81,7 @@ ISO date string from which the avatar becomes available
 
 > `optional` **active\_till\_date?**: `string`
 
-ISO date string until which the avatar is available
+ISO date string until which the avatar is available; undefined when no end window.
 
 ***
 
@@ -90,7 +89,7 @@ ISO date string until which the avatar is available
 
 > **is\_given**: `boolean`
 
-Whether the avatar has been granted/given to the current user
+True when the user owns / has unlocked this avatar.
 
 ***
 
@@ -98,4 +97,4 @@ Whether the avatar has been granted/given to the current user
 
 > `optional` **is\_in\_use?**: `boolean`
 
-Whether this avatar is currently in use by the user
+True when this avatar is the user's currently active profile avatar.

package/docs/api/interfaces/TAvatarPrompt.md

@@ -1,6 +1,6 @@
 # Interface: TAvatarPrompt
 
-TAvatarPrompt describes an AI style prompt available for avatar customization.
+One AI style prompt for avatar customization. Returned by `getAvatarPrompts()`.
 Fields from the raw `public_meta` object are flattened to the top level.
 
 ## Properties
@@ -9,7 +9,7 @@ Fields from the raw `public_meta` object are flattened to the top level.
 
 > **prompt\_id**: `number`
 
-Unique identifier of the AI customization prompt
+Stable numeric identifier of the prompt.
 
 ***
 
@@ -17,7 +17,7 @@ Unique identifier of the AI customization prompt
 
 > **name**: `string`
 
-Display name of the prompt style, e.g. "Cartoon", "Watercolor" (from public_meta)
+Display name of the style, e.g. "Cartoon", "Watercolor".
 
 ***
 
@@ -25,7 +25,7 @@ Display name of the prompt style, e.g. "Cartoon", "Watercolor" (from public_meta
 
 > **icon\_url**: `string`
 
-Full CDN URL of the prompt style icon image (from public_meta)
+Absolute CDN URL of the prompt's preview icon.
 
 ***
 
@@ -33,7 +33,7 @@ Full CDN URL of the prompt style icon image (from public_meta)
 
 > **cost\_currency\_type\_id**: `number`
 
-Currency type used to pay for this customization (0=points, 1=gems, 2=diamonds)
+Currency used to pay for the customization. `0` = points, `1` = gems, `2` = diamonds.
 
 ***
 
@@ -41,4 +41,4 @@ Currency type used to pay for this customization (0=points, 1=gems, 2=diamonds)
 
 > **cost\_value**: `number`
 
-Cost amount in the given currency
+Cost amount in the currency named by `cost_currency_type_id`.