@smartico/public-api 0.0.379 → 0.0.381

package/docs/api/interfaces/TLevel.md

@@ -1,9 +1,7 @@
 # Interface: TLevel
 
-TLevel describes the information of each level defined in the system
-There is no order of the levels, but it can be calculated using required_points property
-The current level of user can be taken from the user object using ach_level_current_id property
-The progress to the next level can be calculated using ach_points_ever and required_points properties of next level
+TLevel describes one level in the label's level ladder.
+Returned by `_smartico.api.getLevels()` (already sorted by `required_points` ASC).
 
 ## Extended by
 
@@ -15,7 +13,7 @@ The progress to the next level can be calculated using ach_points_ever and requi
 
 > **id**: `number`
 
-The ID of the Level
+Stable ID of the level.
 
 ***
 
@@ -23,7 +21,7 @@ The ID of the Level
 
 > **name**: `string`
 
-The name of the Level, translated to the user language
+Display name of the level, pre-translated to the user's language.
 
 ***
 
@@ -31,7 +29,7 @@ The name of the Level, translated to the user language
 
 > **description**: `string`
 
-The description of the Level, translated to the user language
+Display description of the level, pre-translated to the user's language.
 
 ***
 
@@ -39,7 +37,7 @@ The description of the Level, translated to the user language
 
 > **image**: `string`
 
-The URL of the image of the Level, 256x256px
+URL of the level image (256x256 px source).
 
 ***
 
@@ -47,7 +45,7 @@ The URL of the image of the Level, 256x256px
 
 > **required\_points**: `number`
 
-The amount of points required to reach the Level
+Total `ach_points_ever` required to reach this level.
 
 ***
 
@@ -55,7 +53,8 @@ The amount of points required to reach the Level
 
 > **visibility\_points**: `number`
 
-Number of points that user should collect in order to see this level
+Visibility threshold — clients hide the level from the user until
+`ach_points_ever >= visibility_points`. `null` means always visible.
 
 ***
 
@@ -63,9 +62,8 @@ Number of points that user should collect in order to see this level
 
 > **required\_level\_counter\_1**: `number`
 
-The counter of 1st metric used to reach the Level.
-Relevant in case of using advanced leveling logic
-https://help.smartico.ai/welcome/more/release-notes/september-2022#new-logic-for-leveling-users
+Required value of the first level counter for sliding-window leveling.
+`null` on points-only labels. See `UserLevelExtraCountersT`.
 
 ***
 
@@ -73,9 +71,8 @@ https://help.smartico.ai/welcome/more/release-notes/september-2022#new-logic-for
 
 > **required\_level\_counter\_2**: `number`
 
-The counter of 2nd metric used to reach the Level.
-Relevant in case of using advanced leveling logic
-https://help.smartico.ai/welcome/more/release-notes/september-2022#new-logic-for-leveling-users
+Required value of the second level counter for sliding-window leveling.
+`null` on points-only labels.
 
 ***
 
@@ -83,9 +80,8 @@ https://help.smartico.ai/welcome/more/release-notes/september-2022#new-logic-for
 
 > **custom\_data**: `string`
 
-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
+Operator-defined custom data. The SDK auto-parses JSON-looking
+strings, so at runtime this is `any` despite the `string` type.
 
 ***
 
@@ -93,4 +89,5 @@ Read more here - https://help.smartico.ai/welcome/products/general-concepts/cust
 
 > **ordinal\_position**: `number`
 
-The ordinal position of the level
+1-based position in the ladder (matches the order of the returned
+array, which is sorted by `required_points` ASC).

package/docs/api/interfaces/TLevelCurrent.md

@@ -1,6 +1,7 @@
 # Interface: TLevelCurrent
 
-TLevelCurrent describes the information of each level defined in the system along with ordinal position and progress of the current level
+TLevelCurrent extends `TLevel` with the user's progress toward the next level.
+Returned by `_smartico.api.getCurrentLevel()`.
 
 ## Extends
 
@@ -12,7 +13,7 @@ TLevelCurrent describes the information of each level defined in the system alon
 
 > **id**: `number`
 
-The ID of the Level
+Stable ID of the level.
 
 #### Inherited from
 
@@ -24,7 +25,7 @@ The ID of the Level
 
 > **name**: `string`
 
-The name of the Level, translated to the user language
+Display name of the level, pre-translated to the user's language.
 
 #### Inherited from
 
@@ -36,7 +37,7 @@ The name of the Level, translated to the user language
 
 > **description**: `string`
 
-The description of the Level, translated to the user language
+Display description of the level, pre-translated to the user's language.
 
 #### Inherited from
 
@@ -48,7 +49,7 @@ The description of the Level, translated to the user language
 
 > **image**: `string`
 
-The URL of the image of the Level, 256x256px
+URL of the level image (256x256 px source).
 
 #### Inherited from
 
@@ -60,7 +61,7 @@ The URL of the image of the Level, 256x256px
 
 > **required\_points**: `number`
 
-The amount of points required to reach the Level
+Total `ach_points_ever` required to reach this level.
 
 #### Inherited from
 
@@ -72,7 +73,8 @@ The amount of points required to reach the Level
 
 > **visibility\_points**: `number`
 
-Number of points that user should collect in order to see this level
+Visibility threshold — clients hide the level from the user until
+`ach_points_ever >= visibility_points`. `null` means always visible.
 
 #### Inherited from
 
@@ -84,9 +86,8 @@ Number of points that user should collect in order to see this level
 
 > **required\_level\_counter\_1**: `number`
 
-The counter of 1st metric used to reach the Level.
-Relevant in case of using advanced leveling logic
-https://help.smartico.ai/welcome/more/release-notes/september-2022#new-logic-for-leveling-users
+Required value of the first level counter for sliding-window leveling.
+`null` on points-only labels. See `UserLevelExtraCountersT`.
 
 #### Inherited from
 
@@ -98,9 +99,8 @@ https://help.smartico.ai/welcome/more/release-notes/september-2022#new-logic-for
 
 > **required\_level\_counter\_2**: `number`
 
-The counter of 2nd metric used to reach the Level.
-Relevant in case of using advanced leveling logic
-https://help.smartico.ai/welcome/more/release-notes/september-2022#new-logic-for-leveling-users
+Required value of the second level counter for sliding-window leveling.
+`null` on points-only labels.
 
 #### Inherited from
 
@@ -112,9 +112,8 @@ https://help.smartico.ai/welcome/more/release-notes/september-2022#new-logic-for
 
 > **custom\_data**: `string`
 
-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
+Operator-defined custom data. The SDK auto-parses JSON-looking
+strings, so at runtime this is `any` despite the `string` type.
 
 #### Inherited from
 
@@ -126,7 +125,8 @@ Read more here - https://help.smartico.ai/welcome/products/general-concepts/cust
 
 > **ordinal\_position**: `number`
 
-The ordinal position of the level
+1-based position in the ladder (matches the order of the returned
+array, which is sorted by `required_points` ASC).
 
 #### Inherited from
 
@@ -138,4 +138,5 @@ The ordinal position of the level
 
 > **progress**: `number`
 
-The progress of the user towards next level in the percents to complete
+Progress to the next level as a 0–100 integer percentage. `100`
+at the highest level.

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

@@ -1,6 +1,9 @@
 # Interface: TMissionClaimRewardResult
 
-TMissionClaimRewardResult describes the response of call to _smartico.api.requestMissionClaimReward(mission_id, ach_completed_id) method
+Response of `_smartico.api.requestMissionClaimReward(mission_id, ach_completed_id)`.
+
+See `requestMissionClaimReward` TSDoc for the full table of `err_code`
+values, preconditions, side effects, and recommended UI handling.
 
 ## Properties
 
@@ -8,7 +11,7 @@ TMissionClaimRewardResult describes the response of call to _smartico.api.reques
 
 > **err\_code**: `number`
 
-Error code that represents outcome of the claim request. Successful claim reward in case err_code is 0
+Error code. `0` = success (rewards credited). See `requestMissionClaimReward` TSDoc for the full table.
 
 ***
 
@@ -16,4 +19,4 @@ Error code that represents outcome of the claim request. Successful claim reward
 
 > **err\_message**: `string`
 
-Optional error message
+Optional error message; populated on non-zero `err_code`.

package/docs/api/interfaces/TMissionOptInResult.md

@@ -1,6 +1,9 @@
 # Interface: TMissionOptInResult
 
-TMissionOptInResult describes the response of call to _smartico.api.requestMissionOptIn(mission_id) method
+Response of `_smartico.api.requestMissionOptIn(mission_id)`.
+
+See `requestMissionOptIn` TSDoc for the full table of `err_code` values
+and recommended UI handling.
 
 ## Properties
 
@@ -8,7 +11,7 @@ TMissionOptInResult describes the response of call to _smartico.api.requestMissi
 
 > **err\_code**: `number`
 
-Error code that represents outcome of the opt-in request. Successful opt-in in case err_code is 0
+Error code. `0` = success. See `requestMissionOptIn` TSDoc for the full table.
 
 ***
 
@@ -16,4 +19,4 @@ Error code that represents outcome of the opt-in request. Successful opt-in in c
 
 > **err\_message**: `string`
 
-Optional error message
+Optional error message; populated on non-zero `err_code`.

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,7 +236,8 @@ The ribbon of the mission/badge item. Can be 'sale', 'hot', 'new', 'vip' or URL
 
 > `optional` **ach\_completed\_id?**: `number`
 
-ID of the completion fact from ach_completed or ach_completed_recurring tables
+Stable identifier of this specific mission completion. Undefined for
+badges and for missions that have not yet completed.
 
 ***
 
@@ -363,7 +364,7 @@ The date/timestamp indicating when the mission claim will expire
 
 ### prize\_claim\_period\_type\_id?
 
-> `optional` **prize\_claim\_period\_type\_id?**: `AchievementClaimPeriodTypeId`
+> `optional` **prize\_claim\_period\_type\_id?**: [`AchievementClaimPeriodTypeId`](../enumerations/AchievementClaimPeriodTypeId.md)
 
 The type of the prize claim period (Relative or Exact time and date)
 

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,7 +125,9 @@ The list of IDs of the categories where the store item is assigned, information
 
 > `optional` **pool?**: `number`
 
-Number of items in the pool avaliable for the purchase.
+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).
 
 ***
 
@@ -201,6 +203,14 @@ The date when the store item will be available till
 
 ***
 
+### show\_timer?
+
+> `optional` **show\_timer?**: `boolean`
+
+Should countdown timer be shown when `active_till_date` is present
+
+***
+
 ### discounted\_price?
 
 > `optional` **discounted\_price?**: `number`

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
 
@@ -707,6 +707,10 @@ Per-clan prize structure; null for non-clan tournaments
 
 > **prize\_pool\_amount**: `number`
 
+#### prize\_pool\_currency\_code
+
+> **prize\_pool\_currency\_code**: `string`
+
 #### activity\_type\_id
 
 > **activity\_type\_id**: `number`
@@ -731,6 +735,10 @@ Per-clan prize structure; null for non-clan tournaments
 
 > **image\_url**: `string`
 
+##### public\_meta.prize\_name?
+
+> `optional` **prize\_name?**: `string`
+
 #### tiers
 
 > **tiers**: `object`[]

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`.