@smartico/public-api 0.0.385 → 0.0.387

package/docs/SmarticoObject.md

@@ -108,6 +108,14 @@ login payload and (optionally) the language. Both are being consolidated into
 Logs the current user out, forgets the session, and reconnects as anonymous.
 Fires the `logout` callback on success.
 
+### `checkSuccessfullyIdentify()`
+
+Returns `true` once the SDK is initialized **and** a user has been
+successfully identified, `false` otherwise. Use it as a synchronous gate
+before calling user-scoped `_smartico.api.*` methods (e.g. `getUserProfile()`),
+as an alternative to waiting on the `identify` callback. Returns `false` in
+visitor mode.
+
 ### `changeLanguage(language)`
 
 Switches the active language. The code is normalized to a 2-letter form
@@ -396,6 +404,13 @@ Returns `true` on mobile user agents.
 Parse the current page URL / URL hash into an object (helpers for reading
 query / hash parameters).
 
+### `sendServerError(message)` · `sendServerDebug(message)`
+
+Forward a client-side message to Smartico's servers for support correlation —
+`sendServerError` for error conditions, `sendServerDebug` for diagnostic
+detail. Useful when reporting an integration issue so the message lands
+alongside your session server-side. No-ops if the SDK isn't initialized.
+
 ---
 
 ## Setup notes

package/docs/api/README.md

@@ -10,6 +10,7 @@
 
 - [PointChangeSourceType](enumerations/PointChangeSourceType.md)
 - [UserBalanceType](enumerations/UserBalanceType.md)
+- [AvatarCustomizeErrorCode](enumerations/AvatarCustomizeErrorCode.md)
 - [BonusStatus](enumerations/BonusStatus.md)
 - [JoinClanErrorCode](enumerations/JoinClanErrorCode.md)
 - [ActivityTypeLimited](enumerations/ActivityTypeLimited.md)
@@ -78,6 +79,7 @@
 
 - [PointsLog](interfaces/PointsLog.md)
 - [GemsDiamondsLog](interfaces/GemsDiamondsLog.md)
+- [AvatarCustomizeResponse](interfaces/AvatarCustomizeResponse.md)
 - [AvatarCustomized](interfaces/AvatarCustomized.md)
 - [AvatarDefinition](interfaces/AvatarDefinition.md)
 - [AvatarPrompt](interfaces/AvatarPrompt.md)

package/docs/api/classes/WSAPIAvatars.md

@@ -342,3 +342,138 @@ switch (r.err_code) {
 ```
 
 ***
+
+### avatarsCustomize()
+
+> **avatarsCustomize**(`props`): `Promise`\<[`AvatarCustomizeResponse`](../interfaces/AvatarCustomizeResponse.md)\>
+
+Generates an AI-customized variant of a base avatar by applying an
+operator-defined style prompt, returning the CDN URL of the result.
+This is a paid, generate-only step: it does NOT change the user's
+active avatar — pass the returned `cdn_url` to [setAvatar](#setavatar) to
+activate it.
+
+#### Parameters
+
+##### props
+
+###### label_id
+
+`number`
+
+Numeric Smartico label (brand) ID the user belongs to.
+
+###### user_id
+
+`number`
+
+Numeric Smartico user ID.
+
+###### prompt_id
+
+`number`
+
+Style-prompt ID (`prompt_id`) from [getAvatarPrompts](#getavatarprompts).
+
+###### avatar_url
+
+`string`
+
+CDN URL of the base avatar to customize.
+
+###### avatar_real_id
+
+`number`
+
+`avatar_real_id` of the base avatar.
+
+#### Returns
+
+`Promise`\<[`AvatarCustomizeResponse`](../interfaces/AvatarCustomizeResponse.md)\>
+
+[AvatarCustomizeResponse](../interfaces/AvatarCustomizeResponse.md) — `cdn_url` set on success;
+         `errCode` / `errMessage` set on failure.
+
+#### Remarks
+
+**Preconditions**
+- Authenticated session required; not available in visitor mode (throws).
+- All five fields are mandatory — the SDK throws synchronously
+  (`Error("<field> is required")`) if any is missing or zero.
+- `prompt_id` must be one of the prompts from [getAvatarPrompts](#getavatarprompts);
+  `avatar_url` / `avatar_real_id` identify the base avatar to style.
+
+**Cost**
+Each generation costs the currency the operator configured on the
+chosen prompt (points, gems, or diamonds — some prompts are free; read
+`cost_currency_type_id` / `cost_value` from the [getAvatarPrompts](#getavatarprompts)
+entry to gate the UI before calling). The cost is charged only on
+success; if the user can't afford it the call fails with `errCode -1`
+and nothing is generated or charged.
+
+**Latency**
+Generation runs server-side AI image synthesis and is synchronous from
+the caller's side — expect several seconds (roughly 5–20 s) before the
+promise resolves. There is no SDK cache and no push/subscription; show
+a loading state for the full duration and disable the trigger to
+prevent duplicate submissions.
+
+**Result & error codes**
+On success the result has `cdn_url` set; on failure it has `errCode` /
+`errMessage` set and no `cdn_url`. Branch on `errCode` — the generic
+message is fixed text, not cause-specific:
+- `12001` (`AvatarCustomizeErrorCode.AVATAR_USER_LIMIT`) — the user hit
+  their monthly per-user generation cap. Nothing is generated or charged.
+- `12002` (`AvatarCustomizeErrorCode.AVATAR_LABEL_LIMIT`) — the brand's
+  shared monthly pool is exhausted. Nothing is generated or charged;
+  surface a "try again later" message.
+- `-1` — generic failure: insufficient balance, an unavailable prompt,
+  or a generation error. Nothing is charged. Allow the user to retry.
+
+Both monthly caps are operator-configured and reset at the start of
+each calendar month.
+
+**Side effects (on success)**
+The generated variant is persisted to the user's customization history
+and counts toward the monthly caps **whether or not** it is later
+activated — generation is not reversible. The SDK clears the
+[getAvatarsCustomized](#getavatarscustomized) cache so the next call surfaces the new
+variant. The user's active avatar is unchanged until you call
+[setAvatar](#setavatar) with the returned `cdn_url`.
+
+**Idempotency**: not idempotent — each successful call generates (and
+charges for) a new variant. Guard the call site against double-clicks.
+
+**UI guidance**: see [UI Guide — `avatarsCustomize`](../_media/UIGuide_avatarsCustomize.md).
+
+**Visitor mode**: not supported (throws).
+
+#### Example
+
+```ts
+// label_id / user_id identify the Smartico user being customized.
+const prompts = await window._smartico.api.getAvatarPrompts();
+const prompt = prompts[0];
+
+console.log('[smartico] generating avatar — show a spinner for ~5-20s and disable the Generate button');
+const result = await window._smartico.api.avatarsCustomize({
+  label_id,
+  user_id,
+  prompt_id: prompt.prompt_id,
+  avatar_url: baseAvatar.avatar_url,
+  avatar_real_id: baseAvatar.avatar_real_id,
+});
+
+if (result.cdn_url) {
+  console.log('[smartico] generation succeeded — preview this URL, then call setAvatar to apply it:', result.cdn_url);
+  // await window._smartico.api.setAvatar({ avatar_url: result.cdn_url, avatar_real_id: baseAvatar.avatar_real_id });
+} else if (result.errCode === 12001) {
+  console.error('[smartico] user monthly limit reached — show "you have used all your custom avatars this month"');
+} else if (result.errCode === 12002) {
+  console.error('[smartico] brand monthly pool exhausted — show "custom avatars are unavailable right now, try later"');
+} else {
+  console.error('[smartico] generation failed (e.g. not enough balance) — let the user retry:', result.errMessage);
+}
+```
+
+***

package/docs/api/classes/WSAPIClans.md

@@ -334,12 +334,10 @@ below.
   tournament requires the user to be in a clan first.
 - `1006` (`JOIN_CLAN_COOLDOWN_ACTIVE`) — user is inside the
   switch-cooldown window from a previous clan join (default
-  7 days, configurable per label). Surface the
+  7 days, configurable per label). Only reachable when the user is
+  already in a *different* clan (this call is then a clan switch);
+  a first-time join never returns `1006`. Surface the
   `TClans.cooldown_until` expiry in the disabled CTA.
-- `1007` (`JOIN_CLAN_ARCHIVED`) — defined on the public enum but
-  the server does NOT emit this code in practice (archived clans
-  are reported as `1001`). Handle it as a synonym for `1001`
-  defensively, but do not rely on it.
 - `1011` (`JOIN_CLAN_JOINED_AFTER_TOURNAMENT_START`) — this
   method does NOT return `1011` directly. The code fires on
   [registerInTournament](WSAPITournaments.md#registerintournament) responses when the user joined

package/docs/api/classes/WSAPILeaderBoard.md

@@ -80,15 +80,8 @@ gems, diamonds, store items, or bonuses. The first element of
 the array is the prize for place 1, the second for place 2, and
 so on. The array length is the number of paid places.
 
-**Cache TTL — single shared key (known limitation)**
-The SDK caches the response for 30 seconds under a SINGLE shared
-key — calling `getLeaderBoard(DAILY)` followed by
-`getLeaderBoard(WEEKLY)` within the same 30 s window returns the
-cached DAILY result for the WEEKLY call. Same applies to
-switching `getPreviousPeriod`. To force a fresh fetch when
-switching periods or current/previous, call
-`_smartico.api.clearCaches()` before the second call, or simply
-wait out the TTL.
+**Cache TTL**
+The SDK caches each response for 30 seconds. 
 
 **Period boundaries**
 The server finalizes each period on a server-configurable
@@ -145,8 +138,7 @@ if (board.me) {
   }
 }
 
-// Switch to previous period view — but bust the cache first to avoid the shared-key collision.
-await window._smartico.api.clearCaches();
+// Switch to previous period view — cached separately from the current period.
 const prev = await window._smartico.api.getLeaderBoard(LeaderBoardPeriodType.WEEKLY, true);
 console.log('[smartico] previous-week standings — render with greyed-out "ended" treatment:', prev?.users.length, 'finalists');
 

package/docs/api/classes/WSAPIMissions.md

@@ -205,8 +205,17 @@ metadata and group badges by category.
 **Idempotency / Side effects**: fetch-only; safe to call repeatedly.
 The cache layer deduplicates concurrent calls within the TTL window.
 
+**Visitor mode**: not supported. Badges are an authenticated-only
+feature; calling this on the visitor-mode handle (`_smartico.vapi`)
+throws synchronously rather than silently returning an empty list.
+
 **UI guidance**: see [UI Guide — `getBadges`](../../ui/missions/UIGuide_getBadges.md).
 
+#### Throws
+
+`Error("getBadges is not available in visitor mode")` when
+        called from a visitor-mode session.
+
 #### Example
 
 ```ts

package/docs/api/classes/WSAPIUser.md

@@ -401,12 +401,25 @@ source values directly from [getUserProfile](#getuserprofile)'s
 `ach_points_ever` and [getLevels](#getlevels) would also work, but
 `progress` saves the math.
 
-**Cache TTL**: the SDK caches the response for 30 seconds. There is
-no push event that refreshes this cache; a server-side level change
-(visible immediately on [getUserProfile](#getuserprofile)'s `ach_level_current_id`
-via the user-properties update channel) becomes visible on this
-method only after the cache TTL expires, or after
-`_smartico.api.clearCaches()` is called.
+**Cache TTL & freshness**
+The response is cached for 30 seconds, but the SDK automatically
+drops that cache whenever a user-properties update arrives — the
+same live channel that backs [getUserProfile](#getuserprofile). The practical
+effect depends on the label's leveling logic:
+- **Points-based or operator-manual leveling**: a points or level
+  change flows through the user-properties channel, so the cache is
+  busted at that moment and the next `getCurrentLevel()` call
+  returns up-to-date data without waiting out the TTL.
+- **Counter-based leveling** (level driven by sliding-window
+  counters such as deposit or wagering totals over a recent window —
+  see [getUserLevelExtraCounters](#getuserlevelextracounters)): ordinary progress changes
+  are recomputed by a periodic server job and do NOT emit a
+  user-properties update, so they become visible on this method only
+  after the 30 s TTL expires (or after `_smartico.api.clearCaches()`).
+
+Avoid calling `clearCaches()` on the points/manual path — it's
+unnecessary there (the cache is already refreshed on the property
+update) and forces a slower extra round-trip.
 
 **Leveling logic**
 The semantics of how a user advances depends on the label's
@@ -432,10 +445,10 @@ const level = await window._smartico.api.getCurrentLevel();
 console.log('[smartico] render level badge — name:', level.name,
   'progress:', Math.round(level.progress), '%');
 
-// Detect level-up via getUserProfile's push channel.
+// Detect level-up via getUserProfile's push channel. No clearCaches()
+// needed — the SDK already drops the level cache on this update.
 window._smartico.on('props_change', async (changed) => {
   if ('ach_level_current_id' in changed) {
-    await window._smartico.api.clearCaches();   // bust the 30 s cache
     const fresh = await window._smartico.api.getCurrentLevel();
     console.log('[smartico] user levelled up — animate badge to new level:', fresh.name);
   }
@@ -481,14 +494,12 @@ stored under the translation keys `levelsCounter1Name` and
 `levelsCounter2Name`.
 
 **Refresh cadence**
-Sliding-window counters are recomputed by a server-side job that
-runs roughly every 60 seconds against the operator's BigQuery
-dataset; level transitions driven by counter changes have a
-latency of up to several minutes after the underlying activity
-(e.g. a deposit). The SDK caches the response for 30 seconds; no
-push event refreshes this cache. After a level change visible on
-[getUserProfile](#getuserprofile)'s `ach_level_current_id`, call
-`_smartico.api.clearCaches()` to force a fresh fetch.
+Sliding-window counters are recomputed by a periodic server-side
+job. Its rebuild cadence is operator-configured per brand —
+commonly daily, though it can be set more frequent — so level
+transitions driven by counter changes surface with a latency tied
+to that rebuild schedule after the underlying activity (e.g. a
+deposit), not in real time.
 
 **Idempotency**: safe. Read-only. Repeated calls within the cache
 window return a deep-cloned cached value without a network

package/docs/api/documents/SmarticoObject.md

@@ -108,6 +108,14 @@ login payload and (optionally) the language. Both are being consolidated into
 Logs the current user out, forgets the session, and reconnects as anonymous.
 Fires the `logout` callback on success.
 
+### `checkSuccessfullyIdentify()`
+
+Returns `true` once the SDK is initialized **and** a user has been
+successfully identified, `false` otherwise. Use it as a synchronous gate
+before calling user-scoped `_smartico.api.*` methods (e.g. `getUserProfile()`),
+as an alternative to waiting on the `identify` callback. Returns `false` in
+visitor mode.
+
 ### `changeLanguage(language)`
 
 Switches the active language. The code is normalized to a 2-letter form
@@ -396,6 +404,13 @@ Returns `true` on mobile user agents.
 Parse the current page URL / URL hash into an object (helpers for reading
 query / hash parameters).
 
+### `sendServerError(message)` · `sendServerDebug(message)`
+
+Forward a client-side message to Smartico's servers for support correlation —
+`sendServerError` for error conditions, `sendServerDebug` for diagnostic
+detail. Useful when reporting an integration issue so the message lands
+alongside your session server-side. No-ops if the SDK isn't initialized.
+
 ---
 
 ## Setup notes

package/docs/api/enumerations/AvatarCustomizeErrorCode.md

@@ -0,0 +1,21 @@
+# Enumeration: AvatarCustomizeErrorCode
+
+Limit error codes returned in `errCode` by the `avatarsCustomize` method.
+See the `avatarsCustomize` TSDoc for the full table (including the generic
+`-1` failure, which has no named member here).
+
+## Enumeration Members
+
+### AVATAR\_USER\_LIMIT
+
+> **AVATAR\_USER\_LIMIT**: `12001`
+
+The user has reached the operator-configured per-user monthly cap on custom-avatar generations.
+
+***
+
+### AVATAR\_LABEL\_LIMIT
+
+> **AVATAR\_LABEL\_LIMIT**: `12002`
+
+The brand's operator-configured shared monthly pool of custom-avatar generations is exhausted.

package/docs/api/enumerations/JoinClanErrorCode.md

@@ -1,12 +1,17 @@
 # Enumeration: JoinClanErrorCode
 
+Error codes returned in `errCode` by the `joinClan` method (also carried
+on `TClanJoinResult`). These are terse value definitions for lookup; the
+full per-code narrative and UI handling lives in the `joinClan` method
+TSDoc, which owns the error table.
+
 ## Enumeration Members
 
 ### JOIN\_CLAN\_OK
 
 > **JOIN\_CLAN\_OK**: `0`
 
-No error, join completed
+Success — join completed; entry fee (if any) deducted.
 
 ***
 
@@ -14,7 +19,7 @@ No error, join completed
 
 > **JOIN\_CLAN\_INVALID\_PARAMETERS**: `1000`
 
-Invalid parameters
+Request was malformed (missing or invalid parameters).
 
 ***
 
@@ -22,7 +27,7 @@ Invalid parameters
 
 > **JOIN\_CLAN\_NOT\_FOUND**: `1001`
 
-clan_id doesn't exist for this label
+Clan doesn't exist for this label. Archived clans are also reported as `1001`.
 
 ***
 
@@ -30,7 +35,7 @@ clan_id doesn't exist for this label
 
 > **JOIN\_CLAN\_FULL**: `1002`
 
-members_count >= capacity_limit
+Clan is full — member capacity reached.
 
 ***
 
@@ -38,7 +43,7 @@ members_count >= capacity_limit
 
 > **JOIN\_CLAN\_INSUFFICIENT\_FUNDS**: `1003`
 
-Not enough Points / Gems / Diamonds for entry fee
+Insufficient balance for the entry fee (points / gems / diamonds).
 
 ***
 
@@ -46,7 +51,7 @@ Not enough Points / Gems / Diamonds for entry fee
 
 > **JOIN\_CLAN\_SEGMENT\_MISMATCH**: `1004`
 
-User doesn't satisfy entry_conditions / entry_segment_id
+User doesn't meet the clan's entry segment or conditions.
 
 ***
 
@@ -54,7 +59,8 @@ User doesn't satisfy entry_conditions / entry_segment_id
 
 > **JOIN\_CLAN\_USER\_IS\_NOT\_IN\_CLAN**: `1005`
 
-User is not in a clan
+User is not in a clan. Note: a `registerInTournament` response code
+that shares this enum — never returned by `joinClan`.
 
 ***
 
@@ -62,15 +68,7 @@ User is not in a clan
 
 > **JOIN\_CLAN\_COOLDOWN\_ACTIVE**: `1006`
 
-User is within the CLAN_COOLDOWN_DAYS window
-
-***
-
-### JOIN\_CLAN\_ARCHIVED
-
-> **JOIN\_CLAN\_ARCHIVED**: `1007`
-
-clan_status_id != 1 (clan is archived)
+User is within the clan-switch cooldown window (switch only).
 
 ***
 
@@ -78,4 +76,5 @@ clan_status_id != 1 (clan is archived)
 
 > **JOIN\_CLAN\_JOINED\_AFTER\_TOURNAMENT\_START**: `1011`
 
-Clan joined after tournament start
+Clan joined after tournament start. Note: a `registerInTournament`
+response code that shares this enum — never returned by `joinClan`.

package/docs/api/enumerations/TournamentRegistrationError.md

@@ -1,73 +1,118 @@
 # Enumeration: TournamentRegistrationError
 
+Error codes returned in `err_code` by the `registerInTournament` method.
+
+These are terse value definitions for lookup. The full per-code narrative —
+when each fires and how the consumer's UI should react — lives in the
+`registerInTournament` method TSDoc, which owns the error table.
+
+Note the numbering break: the gems / diamonds codes are 6-digit
+(`300010` / `300011`) while the rest of the tournament block is 5-digit;
+they were appended after the original `30001`–`30009` range was occupied.
+Branch on the exact numeric value, not on digit count.
+
 ## Enumeration Members
 
 ### NO\_ERROR
 
 > **NO\_ERROR**: `0`
 
+Success — registration persisted; buy-in (if any) deducted.
+
 ***
 
 ### TOURNAMENT\_USER\_CANNOT\_JOIN\_WITHOUT\_CLAN
 
 > **TOURNAMENT\_USER\_CANNOT\_JOIN\_WITHOUT\_CLAN**: `1010`
 
+Clan-based tournament and the user does not belong to a clan yet.
+
 ***
 
 ### TOURNAMENT\_INSTANCE\_NOT\_FOUND
 
 > **TOURNAMENT\_INSTANCE\_NOT\_FOUND**: `30001`
 
+Instance id is invalid or the tournament was deleted.
+
 ***
 
 ### TOURNAMENT\_REGISTRATION\_NOT\_ENOUGH\_POINTS
 
 > **TOURNAMENT\_REGISTRATION\_NOT\_ENOUGH\_POINTS**: `30002`
 
+Insufficient points balance for a points-priced buy-in.
+
 ***
 
 ### TOURNAMENT\_INSTANCE\_NOT\_IN\_STATE
 
 > **TOURNAMENT\_INSTANCE\_NOT\_IN\_STATE**: `30003`
 
+Tournament is no longer in a registerable state (finished, cancelled, finalizing, or not yet open).
+
 ***
 
 ### TOURNAMENT\_ALREADY\_REGISTERED
 
 > **TOURNAMENT\_ALREADY\_REGISTERED**: `30004`
 
+User is already registered; treat as an idempotent success.
+
 ***
 
 ### TOURNAMENT\_USER\_DONT\_MATCH\_CONDITIONS
 
 > **TOURNAMENT\_USER\_DONT\_MATCH\_CONDITIONS**: `30005`
 
+User does not satisfy the tournament's segment / entry conditions.
+
 ***
 
 ### TOURNAMENT\_USER\_NOT\_REGISTERED
 
 > **TOURNAMENT\_USER\_NOT\_REGISTERED**: `30006`
 
+User is not registered; anomalous on a register call (usually a server-side race).
+
 ***
 
 ### TOURNAMENT\_CANT\_CHANGE\_REGISTRATION\_STATUS
 
 > **TOURNAMENT\_CANT\_CHANGE\_REGISTRATION\_STATUS**: `30007`
 
+Registration status transition is not allowed (e.g. re-registering a finished tournament).
+
 ***
 
 ### TOURNAMENT\_MAX\_REGISTRATIONS\_REACHED
 
 > **TOURNAMENT\_MAX\_REGISTRATIONS\_REACHED**: `30008`
 
+Tournament filled up — maximum registrations reached.
+
+***
+
+### TOURNAMENT\_INVALID\_USER\_CURRENCY
+
+> **TOURNAMENT\_INVALID\_USER\_CURRENCY**: `30009`
+
+The user's wallet currency could not be resolved. Emitted server-side
+during tournament score processing, NOT during registration — it is
+never returned by `registerInTournament`. Included for completeness.
+
 ***
 
 ### TOURNAMENT\_REGISTRATION\_NOT\_ENOUGH\_GEMS
 
-> **TOURNAMENT\_REGISTRATION\_NOT\_ENOUGH\_GEMS**: `30010`
+> **TOURNAMENT\_REGISTRATION\_NOT\_ENOUGH\_GEMS**: `300010`
+
+Insufficient gems balance for a gems-priced buy-in.
 
 ***
 
 ### TOURNAMENT\_REGISTRATION\_NOT\_ENOUGH\_DIAMONDS
 
-> **TOURNAMENT\_REGISTRATION\_NOT\_ENOUGH\_DIAMONDS**: `30011`
+> **TOURNAMENT\_REGISTRATION\_NOT\_ENOUGH\_DIAMONDS**: `300011`
+
+Insufficient diamonds balance for a diamonds-priced buy-in.

package/docs/api/interfaces/AvatarCustomizeResponse.md

@@ -0,0 +1,31 @@
+# Interface: AvatarCustomizeResponse
+
+Result of `_smartico.api.avatarsCustomize()`. On success only `cdn_url` is
+set; on failure only `errCode` / `errMessage`.
+
+## Properties
+
+### cdn\_url?
+
+> `optional` **cdn\_url?**: `string`
+
+CDN URL of the generated avatar variant. Present on success.
+
+***
+
+### errCode?
+
+> `optional` **errCode?**: `number`
+
+Error code. Present on failure. Typed values are members of
+[AvatarCustomizeErrorCode](../enumerations/AvatarCustomizeErrorCode.md); `-1` is a generic failure. See the
+`avatarsCustomize` TSDoc for the full table.
+
+***
+
+### errMessage?
+
+> `optional` **errMessage?**: `string`
+
+Optional error message. Present on failure; the generic (`-1`) message
+is fixed text, so branch on `errCode`, not this string.

package/docs/api/interfaces/TAvatarPrompt.md

@@ -33,7 +33,7 @@ Absolute CDN URL of the prompt's preview icon.
 
 > **cost\_currency\_type\_id**: `number`
 
-Currency used to pay for the customization. `0` = points, `1` = gems, `2` = diamonds.
+Currency used to pay for the customization. `0` = points, `1` = gems, `2` = diamonds, `3` = free. A `cost_value` of `0` is also free.
 
 ***
 
@@ -41,4 +41,4 @@ Currency used to pay for the customization. `0` = points, `1` = gems, `2` = diam
 
 > **cost\_value**: `number`
 
-Cost amount in the currency named by `cost_currency_type_id`.
+Cost amount in the currency named by `cost_currency_type_id`. `0` = free.

package/docs/api/interfaces/TMissionOrBadgeTask.md

@@ -44,6 +44,22 @@ Reward for completing the task in points
 
 ***
 
+### gems\_reward?
+
+> `optional` **gems\_reward?**: `number`
+
+Reward for completing the task in gems
+
+***
+
+### diamonds\_reward?
+
+> `optional` **diamonds\_reward?**: `number`
+
+Reward for completing the task in diamonds
+
+***
+
 ### execution\_count\_expected?
 
 > `optional` **execution\_count\_expected?**: `number`

package/docs/api/interfaces/UserAchievementTask.md

@@ -20,6 +20,22 @@
 
 ***
 
+### gems\_reward?
+
+> `optional` **gems\_reward?**: `number`
+
+Gems awarded when this task is completed.
+
+***
+
+### diamonds\_reward?
+
+> `optional` **diamonds\_reward?**: `number`
+
+Diamonds awarded when this task is completed.
+
+***
+
 ### task\_type\_id
 
 > **task\_type\_id**: [`AchievementTaskType`](../enumerations/AchievementTaskType.md)