@smartico/public-api 0.0.380 → 0.0.381

package/docs/api/interfaces/TClanInfo.md

@@ -1,6 +1,7 @@
 # Interface: TClanInfo
 
 TClanInfo describes the detailed info of a single clan including its members.
+Returned by `_smartico.api.getClanInfo(clanId)`.
 
 ## Properties
 
@@ -8,12 +9,16 @@ TClanInfo describes the detailed info of a single clan including its members.
 
 > **clan\_id**: `number`
 
+Clan ID.
+
 ***
 
 ### public\_meta
 
 > **public\_meta**: `object`
 
+Translated clan metadata (name, description, image URL).
+
 #### name
 
 > **name**: `string`
@@ -32,80 +37,122 @@ TClanInfo describes the detailed info of a single clan including its members.
 
 > **member\_count**: `number`
 
+Current number of members in clan.
+
 ***
 
 ### capacity\_limit
 
 > **capacity\_limit**: `number`
 
+Max number of members allowed in clan.
+
 ***
 
 ### entry\_fee\_currency\_type\_id
 
 > **entry\_fee\_currency\_type\_id**: `number`
 
+Currency type for `entry_fee_amount`. `0` = points, `1` = gems,
+`2` = diamonds, `3` = free.
+
 ***
 
 ### entry\_fee\_amount
 
 > **entry\_fee\_amount**: `number`
 
+Entry fee amount in the currency indicated by `entry_fee_currency_type_id`.
+
 ***
 
 ### rating\_position
 
 > **rating\_position**: `number`
 
+Global rank among all active clans in the label, by `rating_score` DESC.
+`1` = highest-rated.
+
 ***
 
 ### rating\_score
 
 > **rating\_score**: `number`
 
+Clan rating score (higher is better).
+
 ***
 
 ### cooldown\_until
 
 > **cooldown\_until**: `string`
 
+User-level switch-cooldown expiry as ISO 8601 UTC string
+("YYYY-MM-DDTHH:MM:SS" with no timezone suffix). `null` when no
+cooldown. Same semantic as `TClans.cooldown_until` but always fresh
+(the list version may be up to 30 s stale).
+
 ***
 
 ### members
 
 > **members**: `object`[]
 
+Members of this clan, server-ordered by `contribution_score` DESC
+(i.e. `position` ASC).
+
 #### user\_id
 
 > **user\_id**: `number`
 
+Member's internal user ID.
+
 #### public\_username
 
 > **public\_username**: `string`
 
+Member's display username.
+
 #### avatar\_id
 
 > **avatar\_id**: `string`
 
+Avatar identifier; resolve via `avatar_url` below or rebuild
+from `avatar_id` + brand avatar domain.
+
 #### avatar\_real\_id
 
 > **avatar\_real\_id**: `number`
 
+Numeric avatar ID (alternative identifier).
+
 #### avatar\_url?
 
 > `optional` **avatar\_url?**: `string`
 
+Pre-resolved CDN URL for the avatar.
+
 #### position
 
 > **position**: `number`
 
+Member's rank within this clan; `1` = top contributor.
+
 #### contribution\_score
 
 > **contribution\_score**: `number`
 
+Member's contribution to the clan rating score.
+
 #### is\_me?
 
 > `optional` **is\_me?**: `boolean`
 
+`true` when this row is the current authenticated user.
+
 #### clean\_ext\_user\_id?
 
 > `optional` **clean\_ext\_user\_id?**: `string`
+
+External user identifier (operator-provided alias);
+preferred over `public_username` on some surfaces.

package/docs/api/interfaces/TClanJoinResult.md

@@ -1,6 +1,9 @@
 # Interface: TClanJoinResult
 
-TClanJoinResult describes the result of a join clan request.
+TClanJoinResult describes the result of a join-clan request.
+Note: this type uses `errCode` / `errMsg` (camelCase) — different
+from most other SDK result types in this library which use
+`err_code` / `err_message` (snake_case).
 
 ## Properties
 
@@ -8,8 +11,15 @@ TClanJoinResult describes the result of a join clan request.
 
 > **errCode**: `number`
 
+Error code. `0` = success. Typed values are members of
+[JoinClanErrorCode](../enumerations/JoinClanErrorCode.md). See `joinClan` TSDoc for the full
+table and per-code UI guidance.
+
 ***
 
 ### errMsg
 
 > **errMsg**: `string`
+
+Optional server-side error message. Present only on non-zero
+`errCode`; may be empty even then.

package/docs/api/interfaces/TClanTournamentPlayer.md

@@ -0,0 +1,55 @@
+# Interface: TClanTournamentPlayer
+
+## Properties
+
+### user\_id
+
+> **user\_id**: `number`
+
+***
+
+### clean\_ext\_user\_id
+
+> **clean\_ext\_user\_id**: `string`
+
+***
+
+### public\_username
+
+> **public\_username**: `string`
+
+***
+
+### avatar\_id
+
+> **avatar\_id**: `string`
+
+***
+
+### avatar\_real\_id
+
+> **avatar\_real\_id**: `number`
+
+***
+
+### avatar\_url?
+
+> `optional` **avatar\_url?**: `string`
+
+***
+
+### position
+
+> **position**: `number`
+
+***
+
+### scores
+
+> **scores**: `number`
+
+***
+
+### is\_me
+
+> **is\_me**: `boolean`

package/docs/api/interfaces/TClanTournamentPlayersResult.md

@@ -0,0 +1,27 @@
+# Interface: TClanTournamentPlayersResult
+
+## Properties
+
+### clan\_id
+
+> **clan\_id**: `number`
+
+***
+
+### clan\_public\_meta
+
+> **clan\_public\_meta**: `object`
+
+#### name
+
+> **name**: `string`
+
+#### image\_url
+
+> **image\_url**: `string`
+
+***
+
+### players
+
+> **players**: [`TClanTournamentPlayer`](TClanTournamentPlayer.md)[]

package/docs/api/interfaces/TClans.md

@@ -24,7 +24,9 @@ The clan ID the current user belongs to; null if clanless
 
 > **cooldown\_until**: `string`
 
-Cooldown-until date string; null if no cooldown
+Switch-cooldown expiry as ISO 8601 UTC string ("YYYY-MM-DDTHH:MM:SS"
+with no timezone suffix; interpret as UTC). `null` when no cooldown.
+User-level: while set, the user cannot join any clan.
 
 ***
 

package/docs/api/interfaces/TGetTranslations.md

@@ -1,11 +1,15 @@
 # Interface: TGetTranslations
 
+Result of `getTranslations(lang_code)`.
+
 ## Properties
 
 ### translations
 
 > **translations**: `object`
 
+Flat dictionary of operator-defined translation key → translated string.
+
 #### Index Signature
 
 \[`key`: `string`\]: `string`

package/docs/api/interfaces/TInboxMessage.md

@@ -1,12 +1,18 @@
 # Interface: TInboxMessage
 
+TInboxMessage is the lightweight envelope returned by
+`_smartico.api.getInboxMessages()`. Fetch the rich body (title,
+preview, icon, html_body, buttons) separately via
+`_smartico.api.getInboxMessageBody(message_guid)`.
+
 ## Properties
 
 ### message\_guid
 
 > **message\_guid**: `string`
 
-Uniq identifier of the message. It is needed to request the message body, mark the message as read/deleted/favorite.
+Unique identifier of the message. Pass to `getInboxMessageBody`
+and the mark / favorite / delete mutations.
 
 ***
 
@@ -14,7 +20,7 @@ Uniq identifier of the message. It is needed to request the message body, mark t
 
 > **sent\_date**: `string`
 
-Date when the message was sent
+Date when the message was sent (server timestamp).
 
 ***
 
@@ -22,7 +28,7 @@ Date when the message was sent
 
 > **read**: `boolean`
 
-Indicator if a message is read
+`true` when the message has been marked read.
 
 ***
 
@@ -30,7 +36,7 @@ Indicator if a message is read
 
 > **favorite**: `boolean`
 
-Indicator if a message is added to favorites
+`true` when the message has been starred (favorited).
 
 ***
 
@@ -38,7 +44,7 @@ Indicator if a message is added to favorites
 
 > `optional` **category\_id?**: [`InboxCategories`](../enumerations/InboxCategories.md)
 
-Category id per inbox message, can be part of System inboxes, Personal inboxes or General inbox messages
+Operator-assigned category ([InboxCategories](../enumerations/InboxCategories.md)).
 
 ***
 
@@ -46,4 +52,6 @@ Category id per inbox message, can be part of System inboxes, Personal inboxes o
 
 > `optional` **expire\_on\_dt?**: `number`
 
-The epoch timestamp, with milliseconds, when the message is going to be expired
+Expiry timestamp as Unix-ms epoch. Server filters out expired
+messages from list responses — consumers rarely see this set
+unless the expiry is upcoming.

package/docs/api/interfaces/TInboxMessageBody.md

@@ -1,12 +1,16 @@
 # Interface: TInboxMessageBody
 
+TInboxMessageBody is the rich body of one inbox message.
+Returned by `_smartico.api.getInboxMessageBody(message_guid)`.
+Fetched from a CDN (not over WebSocket).
+
 ## Properties
 
 ### title
 
 > **title**: `string`
 
-Message title
+Display title.
 
 ***
 
@@ -14,7 +18,7 @@ Message title
 
 > **preview\_body**: `string`
 
-Short preview body of the message
+Short preview text (typically rendered alongside the title in list items).
 
 ***
 
@@ -22,7 +26,7 @@ Short preview body of the message
 
 > **icon**: `string`
 
-Message icon, 128x128px
+Message icon URL (128×128 px recommended).
 
 ***
 
@@ -30,10 +34,10 @@ Message icon, 128x128px
 
 > **action**: `string`
 
-The action that should be performed when user clicks on the message.
-Can be URL or deep link, e.g. 'dp:deposit'. The most safe to execute CTA is to pass it to _smartico.dp(cta_action);
-The 'dp' function will handle the CTA and will execute it in the most safe way.
-If the message has a rich html body - the action will always be 'dp:inbox' which will open the inbox widget when triggered.
+Click-action — either a deep-link (e.g. `'dp:deposit'`) or a
+plain URL. The literal `'dp:inbox'` indicates the message has a
+rich `html_body`; for any other value `html_body` and `buttons`
+are absent. Pass to `_smartico.dp(action)` for safe execution.
 
 ***
 
@@ -41,7 +45,7 @@ If the message has a rich html body - the action will always be 'dp:inbox' which
 
 > `optional` **html\_body?**: `string`
 
-Rich HTML body of the message.
+Rich HTML body. Populated only when `action === 'dp:inbox'`.
 
 ***
 
@@ -49,19 +53,20 @@ Rich HTML body of the message.
 
 > `optional` **buttons?**: `object`[]
 
-Optional additional buttons to show in the message, available only if message has rich HTML body. Max count - 2.
+Up to 2 additional action buttons. Populated only when
+`action === 'dp:inbox'`.
 
 #### action
 
 > **action**: `string`
 
-The action that should be performed when user clicks on the button. The logic is the same as for message actions
+Button click-action (deep-link or URL).
 
 #### text
 
 > **text**: `string`
 
-Button text
+Button label.
 
 ***
 
@@ -69,4 +74,5 @@ Button text
 
 > `optional` **custom\_data?**: `string`
 
-The custom data of the inbox message defined by operator. Can be a JSON object, string or number
+Operator-defined custom data. The SDK auto-parses JSON-looking
+strings, so at runtime this is `any` despite the `string` type.

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.