@smartico/public-api 0.0.380 → 0.0.381

package/docs/api/interfaces/TMiniGamePlayBatchResult.md

@@ -1,6 +1,11 @@
 # Interface: TMiniGamePlayBatchResult
 
-TMiniGamePlayBatchResult describes the response of call to _smartico.api.playMiniGameBatch(template_id, spin_count) method
+TMiniGamePlayBatchResult describes one entry in the array returned
+by `_smartico.api.playMiniGameBatch(template_id, spin_count)`.
+
+Note: this type uses `errCode` / `errMessage` (camelCase) —
+different from `TMiniGamePlayResult` which uses `err_code` /
+`err_message` (snake_case).
 
 ## Properties
 
@@ -8,7 +13,7 @@ TMiniGamePlayBatchResult describes the response of call to _smartico.api.playMin
 
 > **saw\_prize\_id**: `number`
 
-The saw_prize_id that user won, details of the prize can be found in the mini-game definition
+ID of the won prize for this spin. Look up in `template.prizes`.
 
 ***
 
@@ -16,7 +21,8 @@ The saw_prize_id that user won, details of the prize can be found in the mini-ga
 
 > **errCode**: [`SAWSpinErrorCode`](../enumerations/SAWSpinErrorCode.md)
 
-Error code that represents outcome of the game play attempt. Game succeed to be played in case err_code is 0
+Error code. `0` = success. See `playMiniGameBatch` TSDoc for the
+full table.
 
 ***
 
@@ -24,7 +30,7 @@ Error code that represents outcome of the game play attempt. Game succeed to be
 
 > `optional` **errMessage?**: `string`
 
-Optional error message
+Optional server-side error message.
 
 ***
 
@@ -32,7 +38,8 @@ Optional error message
 
 > `optional` **jackpot\_amount?**: `number`
 
-Jackpot amount what user won
+Jackpot amount the user won, populated when the prize type is
+`'jackpot'`.
 
 ***
 
@@ -40,4 +47,5 @@ Jackpot amount what user won
 
 > `optional` **first\_spin\_in\_period?**: `number`
 
-Period in miliseconds from last spin
+Epoch ms of the user's first spin in the current cooldown
+period; populated when `errCode === SAWSpinErrorCode.SAW_FAILED_MAX_SPINS_REACHED`.

package/docs/api/interfaces/TMiniGamePlayResult.md

@@ -1,6 +1,7 @@
 # Interface: TMiniGamePlayResult
 
-TMiniGamePlayResult describes the response of call to _smartico.api.playMiniGame(template_id) method
+TMiniGamePlayResult describes the response of
+`_smartico.api.playMiniGame(template_id)`.
 
 ## Properties
 
@@ -8,7 +9,8 @@ TMiniGamePlayResult describes the response of call to _smartico.api.playMiniGame
 
 > **err\_code**: [`SAWSpinErrorCode`](../enumerations/SAWSpinErrorCode.md)
 
-Error code that represents outcome of the game play attempt. Game succeed to be played in case err_code is 0
+Error code. `0` = success ([SAWSpinErrorCode.SAW\_OK](../enumerations/SAWSpinErrorCode.md#saw_ok)).
+See `playMiniGame` TSDoc for the full table.
 
 ***
 
@@ -16,7 +18,8 @@ Error code that represents outcome of the game play attempt. Game succeed to be
 
 > **err\_message**: `string`
 
-Optional error message
+Optional server-side error message. Present only on non-zero
+`err_code`; may be empty even then.
 
 ***
 
@@ -24,4 +27,6 @@ Optional error message
 
 > **prize\_id**: `number`
 
-The prize_id that user won, details of the prize can be found in the mini-game definition
+ID of the won prize. Look up in `template.prizes` to interpret
+(including `prize_type === 'no-prize'` for a configured loss
+slot). Always populated, even when `err_code !== 0`.

package/docs/api/interfaces/TMissionClaimRewardResult.md

@@ -11,15 +11,7 @@ values, preconditions, side effects, and recommended UI handling.
 
 > **err\_code**: `number`
 
-Error code that represents outcome of the claim request.
-`0` = success (rewards have been credited);
-`40017` = already claimed (treat as idempotent success);
-`40015` = claim window expired;
-`40016` = mission not completed yet (stale local state);
-`1` = generic server error (stale `ach_completed_id`, archived/draft
-mission, label mismatch, completion older than 6 months, or
-`requires_prize_claim=false` on the server). See
-`requestMissionClaimReward` TSDoc for the full table.
+Error code. `0` = success (rewards credited). See `requestMissionClaimReward` TSDoc for the full table.
 
 ***
 

package/docs/api/interfaces/TMissionOptInResult.md

@@ -11,11 +11,7 @@ and recommended UI handling.
 
 > **err\_code**: `number`
 
-Error code. `0` = success; `40010` = already opted-in (treat as
-idempotent success); `40013` = mission not opt-in-able (draft /
-archived / out of window); `40014` = locked (show unlock tasks);
-`105` = wrong id or visibility-condition rejection. See
-`requestMissionOptIn` TSDoc for the full table.
+Error code. `0` = success. See `requestMissionOptIn` TSDoc for the full table.
 
 ***
 

package/docs/api/interfaces/TMissionOrBadge.md

@@ -163,8 +163,8 @@ The text of the CTA button, e.g. 'Make a deposit'
 
 > **custom\_section\_id**: `number`
 
-The ID of the custom section where the mission or badge is assigned
-The list of custom sections can be retrieved using _smartico.api.getCustomSections() method (TODO-API)
+The ID of the custom section where the mission or badge is assigned.
+Resolve to section metadata via `_smartico.api.getCustomSections()`.
 
 ***
 
@@ -236,11 +236,8 @@ The ribbon of the mission/badge item. Can be 'sale', 'hot', 'new', 'vip' or URL
 
 > `optional` **ach\_completed\_id?**: `number`
 
-Stable identifier of the specific completion of this mission. Pass this
-value to `requestMissionClaimReward()` alongside the mission id. Always
-read from a fresh `getMissions()` result; never synthesise or cache
-across sessions. Undefined for badges and for missions that have not
-yet completed.
+Stable identifier of this specific mission completion. Undefined for
+badges and for missions that have not yet completed.
 
 ***
 

package/docs/api/interfaces/TRaffleOptinResponse.md

@@ -1,12 +1,14 @@
 # Interface: TRaffleOptinResponse
 
+Result of `_smartico.api.requestRaffleOptin({raffle_id, draw_id, raffle_run_id})`.
+
 ## Properties
 
 ### err\_code
 
 > **err\_code**: `number`
 
-Error code that represents outcome of the opt-in attempt. Opt-in succeed in case err_code is 0
+Error code. `0` = success. See `requestRaffleOptin` TSDoc for the full table.
 
 ***
 
@@ -14,4 +16,4 @@ Error code that represents outcome of the opt-in attempt. Opt-in succeed in case
 
 > `optional` **err\_message?**: `string`
 
-Optional error message
+Optional error message; populated on non-zero `err_code`.

package/docs/api/interfaces/TSegmentCheckResult.md

@@ -1,13 +1,23 @@
 # Interface: TSegmentCheckResult
 
+TSegmentCheckResult describes one segment-membership outcome.
+Returned by `_smartico.api.checkSegmentListMatch()` (and used
+internally by `checkSegmentMatch()`).
+
 ## Properties
 
 ### segment\_id
 
 > **segment\_id**: `number`
 
+The segment ID this result refers to (label-scoped).
+
 ***
 
 ### is\_matching
 
 > **is\_matching**: `boolean`
+
+`true` if the user currently matches this segment. `false` also
+covers the case where the segment doesn't exist for the label —
+the two are not distinguishable.

package/docs/api/interfaces/TSetAvatarResult.md

@@ -1,6 +1,6 @@
 # Interface: TSetAvatarResult
 
-TSetAvatarResult describes the response of call to _smartico.api.setAvatar() method
+Result of `_smartico.api.setAvatar()`.
 
 ## Properties
 
@@ -8,7 +8,7 @@ TSetAvatarResult describes the response of call to _smartico.api.setAvatar() met
 
 > **err\_code**: `number`
 
-Error code that represents outcome of the set avatar request. Successful if err_code is 0
+Error code. `0` = success. See `setAvatar` TSDoc for the full table.
 
 ***
 
@@ -16,4 +16,4 @@ Error code that represents outcome of the set avatar request. Successful if err_
 
 > `optional` **err\_message?**: `string`
 
-Optional error message
+Optional error message; populated on non-zero `err_code`.

package/docs/api/interfaces/TStoreItem.md

@@ -125,19 +125,9 @@ The list of IDs of the categories where the store item is assigned, information
 
 > `optional` **pool?**: `number`
 
-Number of items remaining in the pool available for purchase.
-`null` means unlimited supply (no pool configured for this item).
-A positive integer is the remaining stock.
-`0` means sold out — the item is still returned by `getStoreItems` so a
-"Sold out" state can be rendered. Operators may instead choose to hide
-pool-empty items entirely (per-item operator flag), in which case
-sold-out items simply disappear from the catalog rather than appearing
-with `pool === 0`.
-
-Pool is decremented server-side on a successful purchase; the client
-observes the new value via the `onUpdate` callback on `getStoreItems`
-(which fires only for the buyer's own purchases — other users'
-concurrent purchases do not push).
+Items remaining in the pool available for purchase. `null` = unlimited
+supply. Positive integer = remaining stock. `0` = sold out but still
+returned (operator may instead hide pool-empty items entirely).
 
 ***
 

package/docs/api/interfaces/TTournament.md

@@ -93,7 +93,7 @@ The message that should be shown to the user when the user cannot register in to
 > **custom\_section\_id**: `number`
 
 The ID of the custom section where the tournament is assigned
-The list of custom sections can be retrieved using _smartico.api.getCustomSections() method (TODO-API)
+The list of custom sections can be retrieved using _smartico.api.getCustomSections() method
 
 ***
 

package/docs/api/interfaces/TTournamentDetailed.md

@@ -133,7 +133,7 @@ The message that should be shown to the user when the user cannot register in to
 > **custom\_section\_id**: `number`
 
 The ID of the custom section where the tournament is assigned
-The list of custom sections can be retrieved using _smartico.api.getCustomSections() method (TODO-API)
+The list of custom sections can be retrieved using _smartico.api.getCustomSections() method
 
 #### Inherited from
 

package/docs/api/interfaces/TTournamentRegistrationResult.md

@@ -1,12 +1,14 @@
 # Interface: TTournamentRegistrationResult
 
+Result of `_smartico.api.registerInTournament(tournament_id)`.
+
 ## Properties
 
 ### err\_code
 
 > **err\_code**: [`TournamentRegistrationError`](../enumerations/TournamentRegistrationError.md)
 
-Error code that represents outcome of the tournament registration request. Successful registration in case err_code is 0
+Error code. `0` = success. See `registerInTournament` TSDoc for the full table.
 
 ***
 
@@ -14,4 +16,4 @@ Error code that represents outcome of the tournament registration request. Succe
 
 > **err\_message**: `string`
 
-Optional error message
+Optional error message; populated on non-zero `err_code`.

package/docs/api/interfaces/TUICustomSection.md

@@ -1,12 +1,16 @@
 # Interface: TUICustomSection
 
+One operator-configured navigation entry. Returned by `getCustomSections()`.
+`section_type_id` is the dispatch key — it determines which page component the
+consumer mounts when the user opens this section.
+
 ## Properties
 
 ### id
 
 > **id**: `number`
 
-The ID of the custom section
+Stable numeric ID of the section.
 
 ***
 
@@ -14,7 +18,7 @@ The ID of the custom section
 
 > `optional` **body?**: `string`
 
-The body of the custom section
+Raw HTML body for `HTML_PAGE` sections; Liquid template body for `LEVELS` (Liquid) sections.
 
 ***
 
@@ -22,7 +26,7 @@ The body of the custom section
 
 > `optional` **menu\_img?**: `string`
 
-The image of the custom section, 64x64px
+CDN URL of the section's nav icon, 64x64 px square.
 
 ***
 
@@ -30,7 +34,7 @@ The image of the custom section, 64x64px
 
 > `optional` **menu\_name?**: `string`
 
-The name of the custom section
+Display name shown next to the nav icon. Pre-translated server-side.
 
 ***
 
@@ -38,7 +42,7 @@ The name of the custom section
 
 > `optional` **custom\_skin\_images?**: `string`
 
-Custom images for custom section
+JSON-serialized list of skin image overrides for themed sections (e.g. `MISSION_CUSTOM_LAYOUT`).
 
 ***
 
@@ -46,7 +50,7 @@ Custom images for custom section
 
 > `optional` **section\_type\_id?**: [`AchCustomSectionType`](../enumerations/AchCustomSectionType.md)
 
-The particular type of custom section, can be Missions, Tournaments, Lootbox and etc
+Dispatch key — see [AchCustomSectionType](../enumerations/AchCustomSectionType.md).
 
 ***
 
@@ -54,7 +58,7 @@ The particular type of custom section, can be Missions, Tournaments, Lootbox and
 
 > `optional` **theme?**: [`AchCustomLayoutTheme`](../enumerations/AchCustomLayoutTheme.md)
 
-Theme of the custom section
+Themed-layout name for `MISSION_CUSTOM_LAYOUT` sections; see [AchCustomLayoutTheme](../enumerations/AchCustomLayoutTheme.md).
 
 ***
 
@@ -62,7 +66,7 @@ Theme of the custom section
 
 > `optional` **generic\_custom\_css?**: `string`
 
-Custom css for the custom section
+Custom CSS for themed layouts.
 
 ***
 
@@ -70,7 +74,7 @@ Custom css for the custom section
 
 > `optional` **mission\_tabs\_options?**: [`AchMissionsTabsOptions`](../enumerations/AchMissionsTabsOptions.md)
 
-Tabs that can be shown in custom section, e.g Overview, No Overview, All tabs
+Which tabs to render for `MISSIONS_CATEGORY` sections; see [AchMissionsTabsOptions](../enumerations/AchMissionsTabsOptions.md).
 
 ***
 
@@ -78,7 +82,7 @@ Tabs that can be shown in custom section, e.g Overview, No Overview, All tabs
 
 > `optional` **overview\_missions\_filter?**: [`AchOverviewMissionsFilter`](../enumerations/AchOverviewMissionsFilter.md)
 
-Filter that allow to show missions by criteria
+Mission-filter rule for the Overview tab; see [AchOverviewMissionsFilter](../enumerations/AchOverviewMissionsFilter.md).
 
 ***
 
@@ -86,7 +90,7 @@ Filter that allow to show missions by criteria
 
 > `optional` **overview\_missions\_count?**: `number`
 
-Quantity of missions to be shown in overview
+Maximum number of missions shown in the Overview tab.
 
 ***
 
@@ -94,7 +98,7 @@ Quantity of missions to be shown in overview
 
 > `optional` **url\_or\_dp?**: `string`
 
-URL or DP to be used for custom section
+Click target for `REDIRECT_LINK` sections — either a Smartico DP string (`dp:…`) or an external URL.
 
 ***
 
@@ -102,7 +106,7 @@ URL or DP to be used for custom section
 
 > `optional` **liquid\_entity\_data?**: [`LiquidEntityData`](../enumerations/LiquidEntityData.md)[]
 
-Data to be used for Liquid templates
+Data-context selectors for Liquid templates; see [LiquidEntityData](../enumerations/LiquidEntityData.md).
 
 ***
 
@@ -110,7 +114,7 @@ Data to be used for Liquid templates
 
 > `optional` **ach\_tournament\_id?**: `number`
 
-Tournament ID to be used for Liquid templates
+Tournament ID for a single-tournament Liquid template (`LiquidEntityData.Tournament`).
 
 ***
 
@@ -118,7 +122,7 @@ Tournament ID to be used for Liquid templates
 
 > `optional` **show\_raw\_data?**: `boolean`
 
-Indicates if the data should be shown as raw data (for Liquid templates)
+Operator debug flag — when `true`, Liquid renders raw context data instead of the templated HTML.
 
 ***
 
@@ -126,7 +130,7 @@ Indicates if the data should be shown as raw data (for Liquid templates)
 
 > `optional` **liquid\_template?**: `number`
 
-Liquid template id to be used for Liquid templates
+Liquid template ID resolved server-side; the rendered body is delivered in `body`.
 
 ***
 
@@ -134,7 +138,7 @@ Liquid template id to be used for Liquid templates
 
 > `optional` **ach\_category\_ids?**: `number`[]
 
-List of IDs of the categories where the badge item is assigned, information about categories can be retrieved with getAchCategories method
+Category IDs the section filters badges by — correlate with `getAchCategories()`.
 
 ***
 
@@ -142,7 +146,7 @@ List of IDs of the categories where the badge item is assigned, information abou
 
 > `optional` **shop\_category\_ids?**: `number`[]
 
-List of IDs of the categories where the store item is assigned, information about categories can be retrieved with getShopCategories method
+Category IDs the section filters store items by — correlate with `getStoreCategories()`.
 
 ***
 
@@ -150,4 +154,4 @@ List of IDs of the categories where the store item is assigned, information abou
 
 > `optional` **raffle\_id?**: `number`
 
-ID of the raffle to be used for Liquid templates
+Raffle ID for `RAFFLE` sections (and `LiquidEntityData.SingleRaffle` Liquid templates).

package/docs/api/interfaces/TUserProfile.md

@@ -11,7 +11,7 @@ If you want to track the changes of the user profile, you can subscribe to the c
 
 > **core\_user\_language**: `string`
 
-The language of the user
+Language code stored server-side for the user (e.g. `"en"`, `"de"`).
 
 ***
 
@@ -19,7 +19,8 @@ The language of the user
 
 > **ach\_points\_balance**: `number`
 
-The current points balance that user can use in the Store, Mini-games, Tournaments, etc..
+Current spendable points balance — decremented by store purchases,
+tournament buy-ins, and clan entry fees.
 
 ***
 
@@ -27,7 +28,8 @@ The current points balance that user can use in the Store, Mini-games, Tournamen
 
 > **ach\_points\_ever**: `number`
 
-The amount of points that user collected in total
+All-time cumulative points earned. Monotonic — NOT decremented by
+store purchases or clan/tournament fees.
 
 ***
 
@@ -35,7 +37,7 @@ The amount of points that user collected in total
 
 > **ach\_gems\_balance**: `number`
 
-The current gems balance
+Current gems balance (secondary currency).
 
 ***
 
@@ -43,7 +45,7 @@ The current gems balance
 
 > **ach\_diamonds\_balance**: `number`
 
-The current diamonds balance
+Current diamonds balance (tertiary currency).
 
 ***
 
@@ -51,10 +53,8 @@ The current diamonds balance
 
 > **core\_public\_tags**: `string`[]
 
-The array of the public tags set on the user object.
-They can be treated as server-based cookies.
-You can set tags using following method _smartico.event('core_public_tags_update', { core_public_tags: ['A', 'B'] } );
-And then you can check for the tags
+Server-stored public tags on the user (uppercase strings).
+Modify via `_smartico.updatePublicTags(operation, tags)`.
 
 ***
 
@@ -62,7 +62,7 @@ And then you can check for the tags
 
 > `optional` **ach\_level\_current\_id?**: `number`
 
-The ID of the current level of the user
+FK into the level ladder; resolve via `getCurrentLevel()` or `getLevels()`.
 
 ***
 
@@ -70,7 +70,7 @@ The ID of the current level of the user
 
 > `optional` **core\_is\_test\_account?**: `boolean`
 
-The indicator if user is marked as test user
+`true` when the user is flagged as a test account.
 
 ***
 
@@ -78,7 +78,7 @@ The indicator if user is marked as test user
 
 > `optional` **avatar\_url?**: `string`
 
-The URL to the user avatar
+Resolved CDN URL for the user's avatar.
 
 ***
 
@@ -86,7 +86,7 @@ The URL to the user avatar
 
 > `optional` **public\_username?**: `string`
 
-The username of current user
+Display username (operator-defined alias).
 
 ***
 
@@ -94,7 +94,7 @@ The username of current user
 
 > `optional` **core\_inbox\_unread\_count?**: `number`
 
-THe number of unread inbox messages
+Unread inbox messages count. Push-updated in real time.
 
 ***
 
@@ -102,7 +102,8 @@ THe number of unread inbox messages
 
 > `optional` **core\_recommended\_deposit\_amount?**: `number`
 
-The recommended deposit amount for the user
+AI-recommended deposit amount for this user. Undefined when no
+recommendation is currently available.
 
 ***
 
@@ -110,4 +111,5 @@ The recommended deposit amount for the user
 
 > `optional` **core\_recommended\_casino\_bet\_amount?**: `number`
 
-The recommended casino bet amount for the user
+AI-recommended casino bet amount for this user. Undefined when no
+recommendation is currently available.

package/docs/api/interfaces/TransformedRaffleClaimPrizeResponse.md

@@ -1,12 +1,16 @@
 # Interface: TransformedRaffleClaimPrizeResponse
 
+Result of `_smartico.api.claimRafflePrize({raffle_id, draw_id, raffle_run_id})`.
+Uses camelCase `errorCode` / `errorMessage` — distinct from most other SDK
+result wrappers which use snake_case `err_code` / `err_message`.
+
 ## Properties
 
 ### errorCode
 
 > **errorCode**: `number`
 
-Error code, 0 means no error
+Error code. `0` = success. See `claimRafflePrize` TSDoc for the full table.
 
 ***
 
@@ -14,4 +18,4 @@ Error code, 0 means no error
 
 > `optional` **errorMessage?**: `string`
 
-Error message, will be exposed only if ErrorCode is not 0
+Optional error message; populated on non-zero `errorCode`.

package/docs/api/interfaces/UserLevelExtraCountersT.md

@@ -1,12 +1,18 @@
 # Interface: UserLevelExtraCountersT
 
+UserLevelExtraCountersT exposes the user's current values for the two
+label-defined sliding-window level counters. Returned by
+`_smartico.api.getUserLevelExtraCounters()`. Both fields are
+`undefined` on points-only labels.
+
 ## Properties
 
 ### level\_counter\_1?
 
 > `optional` **level\_counter\_1?**: `number`
 
-The counter of 1st metric used to reach the level.
+Current value of the user's first level counter. Operator-defined
+semantics per label. `undefined` on points-only labels.
 
 ***
 
@@ -14,4 +20,5 @@ The counter of 1st metric used to reach the level.
 
 > `optional` **level\_counter\_2?**: `number`
 
-The counter of 2nd metric used to reach the level.
+Current value of the user's second level counter. Operator-defined
+semantics per label. `undefined` on points-only labels.

package/docs/api/type-aliases/ActivityLogEntry.md

@@ -0,0 +1,3 @@
+# Type Alias: ActivityLogEntry
+
+> **ActivityLogEntry** = [`PointsLog`](../interfaces/PointsLog.md) \| [`GemsDiamondsLog`](../interfaces/GemsDiamondsLog.md)

package/docs/native/ADDING_METHODS.md

@@ -18,8 +18,13 @@ Requirements:
 1. Find request/response ClassId in ../../src/SmarticoAPI.ts and ../../src/Base/ClassId.ts
 2. Document raw message structure (not transformed T-prefixed types)
 3. For complex types — link to ../api/interfaces/*.md files
-4. If raw interface MD file doesn't exist in ../api/interfaces/ — create it following typedoc style like existing files there:
-   - Format: `# Interface: Name`, `## Properties`, `### property_name`, `• **property_name**: \`type\``, `___` separators between properties
+4. If the interface MD file doesn't exist in ../api/interfaces/, DO NOT hand-create it
+   there — that directory is TypeDoc output and is wiped on every `npm run doc`
+   (`cleanOutputDir: true`). Instead, add the interface's source `.ts` file to
+   `typedocOptions.entryPoints` in ../../tsconfig.json and re-run `npm run doc`;
+   TypeDoc then generates the interface page. (Example: `PointsLog` /
+   `GemsDiamondsLog` live in `src/ActivityLog/ActivityLogEntry.ts`, which must be
+   an entry point for their pages to exist.)
 5. Add method to Table of Contents in appropriate category
 6. Follow the same format as other methods in PROTOCOL.md (Request section with ClassId and fields table, Response section with ClassId and fields table, JSON examples where helpful)
 7. All documentation must be in English