@smartico/public-api 0.0.379 → 0.0.381

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/UserAchievement.md

@@ -214,4 +214,4 @@
 
 ### prize\_claim\_period\_type\_id?
 
-> `optional` **prize\_claim\_period\_type\_id?**: `AchievementClaimPeriodTypeId`
+> `optional` **prize\_claim\_period\_type\_id?**: [`AchievementClaimPeriodTypeId`](../enumerations/AchievementClaimPeriodTypeId.md)

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