@smartico/public-api 0.0.386 → 0.0.388

package/README.md

@@ -74,9 +74,9 @@ The SDK surface is split across one class per feature area, joined by an interna
 | **Jackpots** | [`WSAPIJackpots`](docs/api/classes/WSAPIJackpots.md) | `jackpotGet`, `jackpotOptIn`, `jackpotOptOut`, `getJackpotWinners`, `getJackpotEligibleGames` | [`jackpotGet`](docs/ui/jackpots/UIGuide_jackpotGet.md) · [`jackpotOptIn`](docs/ui/jackpots/UIGuide_jackpotOptIn.md) · [`jackpotOptOut`](docs/ui/jackpots/UIGuide_jackpotOptOut.md) · [`getJackpotWinners`](docs/ui/jackpots/UIGuide_getJackpotWinners.md) · [`getJackpotEligibleGames`](docs/ui/jackpots/UIGuide_getJackpotEligibleGames.md) |
 | **Raffles / Draws** | [`WSAPIRaffles`](docs/api/classes/WSAPIRaffles.md) | `getRaffles`, `getRaffleDrawRun`, `getRaffleDrawRunsHistory`, `claimRafflePrize`, `requestRaffleOptin`, `getRaffleWonPrizes` | [`getRaffles`](docs/ui/raffles/UIGuide_getRaffles.md) · [`getRaffleDrawRun`](docs/ui/raffles/UIGuide_getRaffleDrawRun.md) · [`getRaffleDrawRunsHistory`](docs/ui/raffles/UIGuide_getRaffleDrawRunsHistory.md) · [`claimRafflePrize`](docs/ui/raffles/UIGuide_claimRafflePrize.md) · [`requestRaffleOptin`](docs/ui/raffles/UIGuide_requestRaffleOptin.md) · [`getRaffleWonPrizes`](docs/ui/raffles/UIGuide_getRaffleWonPrizes.md) |
 | **MiniGames / SAW** | [`WSAPIMiniGames`](docs/api/classes/WSAPIMiniGames.md) | `getMiniGames`, `getMiniGamesHistory`, `playMiniGame`, `miniGameWinAcknowledgeRequest`, `playMiniGameBatch` | [`getMiniGames`](docs/ui/minigames/UIGuide_getMiniGames.md) · [`getMiniGamesHistory`](docs/ui/minigames/UIGuide_getMiniGamesHistory.md) · [`playMiniGame`](docs/ui/minigames/UIGuide_playMiniGame.md) · [`playMiniGameBatch`](docs/ui/minigames/UIGuide_playMiniGameBatch.md) |
-| **Avatars** | [`WSAPIAvatars`](docs/api/classes/WSAPIAvatars.md) | `getAvatarsList`, `getAvatarsCustomized`, `getAvatarPrompts`, `setAvatar` | [`getAvatarsList`](docs/ui/avatars/UIGuide_getAvatarsList.md) · [`getAvatarsCustomized`](docs/ui/avatars/UIGuide_getAvatarsCustomized.md) · [`getAvatarPrompts`](docs/ui/avatars/UIGuide_getAvatarPrompts.md) · [`setAvatar`](docs/ui/avatars/UIGuide_setAvatar.md) |
+| **Avatars** | [`WSAPIAvatars`](docs/api/classes/WSAPIAvatars.md) | `getAvatarsList`, `getAvatarsCustomized`, `getAvatarPrompts`, `setAvatar`, `avatarsCustomize` | [`getAvatarsList`](docs/ui/avatars/UIGuide_getAvatarsList.md) · [`getAvatarsCustomized`](docs/ui/avatars/UIGuide_getAvatarsCustomized.md) · [`getAvatarPrompts`](docs/ui/avatars/UIGuide_getAvatarPrompts.md) · [`setAvatar`](docs/ui/avatars/UIGuide_setAvatar.md) · [`avatarsCustomize`](docs/ui/avatars/UIGuide_avatarsCustomize.md) |
 | **Game Pick (sports / quiz)** | [`WSAPIGamePick`](docs/api/classes/WSAPIGamePick.md) | `gamePickGet*`, `gamePickSubmit*` (9 methods) | [`gamePickGetActiveRounds`](docs/ui/gamepick/UIGuide_gamePickGetActiveRounds.md) · [`gamePickGetActiveRound`](docs/ui/gamepick/UIGuide_gamePickGetActiveRound.md) · [`gamePickGetHistory`](docs/ui/gamepick/UIGuide_gamePickGetHistory.md) · [`gamePickGetBoard`](docs/ui/gamepick/UIGuide_gamePickGetBoard.md) · [`gamePickSubmitSelection`](docs/ui/gamepick/UIGuide_gamePickSubmitSelection.md) · [`gamePickSubmitSelectionQuiz`](docs/ui/gamepick/UIGuide_gamePickSubmitSelectionQuiz.md) · [`gamePickGetUserInfo`](docs/ui/gamepick/UIGuide_gamePickGetUserInfo.md) · [`gamePickGetGameInfo`](docs/ui/gamepick/UIGuide_gamePickGetGameInfo.md) · [`gamePickGetRoundInfoForUser`](docs/ui/gamepick/UIGuide_gamePickGetRoundInfoForUser.md) |
-| **Leaderboard** | [`WSAPILeaderBoard`](docs/api/classes/WSAPILeaderBoard.md) | `getLeaderBoard` | [`getLeaderBoard`](docs/ui/leaderboard/UIGuide_getLeaderBoard.md) |
+| **Leaderboard** | [`WSAPILeaderBoard`](docs/api/classes/WSAPILeaderBoard.md) | `getLeaderBoard`, `getLeaderBoards` | [`getLeaderBoard`](docs/ui/leaderboard/UIGuide_getLeaderBoard.md) |
 | **Inbox / Messages / Engagement** | [`WSAPIInbox`](docs/api/classes/WSAPIInbox.md) | `getInboxMessages`, `getInboxUnreadCount`, `getInboxMessageBody`, `markInboxMessageAsRead`, `markAllInboxMessagesAsRead`, `markUnmarkInboxMessageAsFavorite`, `deleteInboxMessage`, `deleteAllInboxMessages`, `reportImpressionEvent`, `reportClickEvent` | [`getInboxMessages`](docs/ui/inbox/UIGuide_getInboxMessages.md) · [`getInboxMessageBody`](docs/ui/inbox/UIGuide_getInboxMessageBody.md) · [`markInboxMessageAsRead`](docs/ui/inbox/UIGuide_markInboxMessageAsRead.md) · [`markUnmarkInboxMessageAsFavorite`](docs/ui/inbox/UIGuide_markUnmarkInboxMessageAsFavorite.md) · [`deleteInboxMessage`](docs/ui/inbox/UIGuide_deleteInboxMessage.md) |
 
 The shared return / param types live in [`WSAPITypes`](docs/api/classes/WSAPITypes.md). For the full type / enum / interface listing, see [`docs/api/globals.md`](docs/api/globals.md).

package/dist/Avatars/AvatarCustomizeErrorCode.d.ts

@@ -1,5 +1,11 @@
+/**
+ * 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).
+ */
 export declare enum AvatarCustomizeErrorCode {
+    /** The user has reached the operator-configured per-user monthly cap on custom-avatar generations. */
     AVATAR_USER_LIMIT = 12001,
+    /** The brand's operator-configured shared monthly pool of custom-avatar generations is exhausted. */
     AVATAR_LABEL_LIMIT = 12002
 }
-export declare const AvatarCustomizeErrorMessage: Record<AvatarCustomizeErrorCode, string>;

package/dist/Avatars/AvatarCustomizeResponse.d.ts

@@ -0,0 +1,16 @@
+import { AvatarCustomizeErrorCode } from './AvatarCustomizeErrorCode';
+/**
+ * Result of `_smartico.api.avatarsCustomize()`. On success only `cdn_url` is
+ * set; on failure only `errCode` / `errMessage`.
+ */
+export interface AvatarCustomizeResponse {
+    /** CDN URL of the generated avatar variant. Present on success. */
+    cdn_url?: string;
+    /** Error code. Present on failure. Typed values are members of
+     * {@link AvatarCustomizeErrorCode}; `-1` is a generic failure. See the
+     * `avatarsCustomize` TSDoc for the full table. */
+    errCode?: AvatarCustomizeErrorCode | number;
+    /** Optional error message. Present on failure; the generic (`-1`) message
+     * is fixed text, so branch on `errCode`, not this string. */
+    errMessage?: string;
+}

package/dist/Avatars/index.d.ts

@@ -1,4 +1,5 @@
 export * from './AvatarCustomizeErrorCode';
+export * from './AvatarCustomizeResponse';
 export * from './AvatarDefinition';
 export * from './AvatarCustomized';
 export * from './AvatarPrompt';

package/dist/CustomSections/AchCustomSection.d.ts

@@ -43,5 +43,6 @@ export declare enum LiquidEntityData {
     Badges = 9,
     Tournament = 10,
     Raffles = 11,
-    SingleRaffle = 12
+    SingleRaffle = 12,
+    Clans = 13
 }

package/dist/Missions/UserAchievementTask.d.ts

@@ -5,6 +5,10 @@ export interface UserAchievementTask {
     task_id?: number;
     task_public_meta?: AchievementTaskPublicMeta;
     points_reward?: number;
+    /** Gems awarded when this task is completed. */
+    gems_reward?: number;
+    /** Diamonds awarded when this task is completed. */
+    diamonds_reward?: number;
     task_type_id: AchievementTaskType;
     isCompleted?: boolean;
     userExecutedCount?: number;

package/dist/SmarticoAPI.d.ts

@@ -28,6 +28,7 @@ import { GetAvatarsListResponse } from './Avatars/GetAvatarsListResponse';
 import { GetAvatarsCustomizedResponse } from './Avatars/GetAvatarsCustomizedResponse';
 import { GetAvatarPromptsResponse } from './Avatars/GetAvatarPromptsResponse';
 import { SetAvatarResponse } from './Avatars';
+import { AvatarCustomizeResponse } from './Avatars/AvatarCustomizeResponse';
 import { GetJackpotWinnersResponse, JackpotWinnerHistory } from './Jackpots/GetJackpotWinnersResponse';
 import { GetJackpotEligibleGamesResponse, TGetJackpotEligibleGamesResponse } from './Jackpots/GetJackpotEligibleGamesResponse';
 import { GamePickGameInfo, GamePickRound, GamePickRoundBoard, GamePickUserInfo, GamesApiResponse } from './GamePick';
@@ -61,6 +62,7 @@ declare class SmarticoAPI {
     private gamesApiUrl;
     private baseRgApiParams;
     avatarDomain: string;
+    private avatarOriginDomain;
     private envId;
     private logger;
     private logCIDs;
@@ -76,6 +78,7 @@ declare class SmarticoAPI {
     static getPublicUrl(label_api_key: string): string;
     static getPublicWsUrl(label_api_key: string): string;
     static getAvatarUrl(label_api_key: string): string;
+    static getAvatarOriginUrl(label_api_key: string): string;
     private send;
     private buildMessage;
     coreReportCustomEvent(user_ext_id: string, eventType: string, payload?: any): Promise<any>;
@@ -155,8 +158,10 @@ declare class SmarticoAPI {
     tournamentsGetInfo(user_ext_id: string, tournamentInstanceId: number, force_language?: string): Promise<GetTournamentInfoResponse>;
     tournamentsGetInfoT(user_ext_id: string, tournamentInstanceId: number): Promise<TTournamentDetailed>;
     clanTournamentGetPlayers(user_ext_id: string, tournament_instance_id: number, clan_id: number, force_language?: string): Promise<TClanTournamentPlayers>;
-    leaderboardGet(user_ext_id: string, period_type_id?: LeaderBoardPeriodType, prevPeriod?: boolean, force_language?: string): Promise<LeaderBoardDetails>;
-    leaderboardsGetT(user_ext_id: string, period_type_id?: LeaderBoardPeriodType, prevPeriod?: boolean): Promise<LeaderBoardDetailsT>;
+    leaderboardGet(user_ext_id: string, period_type_id?: LeaderBoardPeriodType, prevPeriod?: boolean | number, force_language?: string): Promise<LeaderBoardDetails>;
+    leaderboardsGetT(user_ext_id: string, period_type_id?: LeaderBoardPeriodType, prevPeriod?: boolean | number): Promise<LeaderBoardDetailsT>;
+    leaderboardsGetList(user_ext_id: string, force_language?: string): Promise<LeaderBoardDetails[]>;
+    leaderboardsGetListT(user_ext_id: string): Promise<LeaderBoardDetailsT[]>;
     levelsGet(user_ext_id: string, force_language?: string): Promise<GetLevelMapResponse>;
     levelsGetT(user_ext_id: string): Promise<TLevel[]>;
     getLevelCurrent(user_ext_id: string): Promise<TLevelCurrent>;
@@ -175,6 +180,7 @@ declare class SmarticoAPI {
     deleteAllInboxMessages(user_ext_id: string): Promise<MarkInboxMessageDeletedResponse>;
     private buildGamesApiParams;
     private sendGamesApi;
+    private sendAvatarApi;
     gpGetActiveRounds(saw_template_id: number): Promise<GamesApiResponse<GamePickRound[]>>;
     gpGetActiveRound(saw_template_id: number, round_id?: number): Promise<GamesApiResponse<GamePickRound>>;
     gpGetGamesHistory(saw_template_id: number): Promise<GamesApiResponse<GamePickRound[]>>;
@@ -188,6 +194,13 @@ declare class SmarticoAPI {
     avatarsGetCustomized(user_ext_id: string): Promise<GetAvatarsCustomizedResponse>;
     avatarsGetPrompts(user_ext_id: string): Promise<GetAvatarPromptsResponse>;
     avatarSetAvatar(user_ext_id: string, avatar_id: string, avatar_real_id: number): Promise<SetAvatarResponse>;
+    avatarsCustomize(params: {
+        label_id: number;
+        user_id: number;
+        prompt_id: number;
+        avatar_url: string;
+        avatar_real_id: number;
+    }): Promise<AvatarCustomizeResponse>;
     avatarsGetListT(user_ext_id: string): Promise<TAvatarDefinition[]>;
     avatarsGetCustomizedT(user_ext_id: string): Promise<TAvatarCustomized[]>;
     avatarsGetPromptsT(user_ext_id: string): Promise<TAvatarPrompt[]>;

package/dist/WSAPI/WSAPIAvatars.d.ts

@@ -1,5 +1,6 @@
 import { TAvatarDefinition, TAvatarCustomized, TAvatarPrompt, TSetAvatarResult } from './WSAPITypes';
 import { WSAPIMiniGames } from './WSAPIMiniGames';
+import { AvatarCustomizeResponse } from '../Avatars/AvatarCustomizeResponse';
 /** @group Avatars */
 export declare class WSAPIAvatars extends WSAPIMiniGames {
     /**
@@ -293,4 +294,106 @@ export declare class WSAPIAvatars extends WSAPIMiniGames {
         avatar_url: string;
         avatar_real_id: number;
     }): Promise<TSetAvatarResult>;
+    /**
+     * 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 {@link setAvatar} to
+     * activate it.
+     *
+     * @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 {@link 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 {@link 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
+     * {@link getAvatarsCustomized} cache so the next call surfaces the new
+     * variant. The user's active avatar is unchanged until you call
+     * {@link 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`](../../docs/ui/avatars/UIGuide_avatarsCustomize.md).
+     *
+     * **Visitor mode**: not supported (throws).
+     *
+     * @param props.label_id        Numeric Smartico label (brand) ID the user belongs to.
+     * @param props.user_id         Numeric Smartico user ID.
+     * @param props.prompt_id       Style-prompt ID (`prompt_id`) from {@link getAvatarPrompts}.
+     * @param props.avatar_url      CDN URL of the base avatar to customize.
+     * @param props.avatar_real_id  `avatar_real_id` of the base avatar.
+     * @returns {@link AvatarCustomizeResponse} — `cdn_url` set on success;
+     *          `errCode` / `errMessage` set on failure.
+     *
+     * @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);
+     * }
+     * ```
+     */
+    avatarsCustomize(props: {
+        label_id: number;
+        user_id: number;
+        prompt_id: number;
+        avatar_url: string;
+        avatar_real_id: number;
+    }): Promise<AvatarCustomizeResponse>;
 }

package/dist/WSAPI/WSAPILeaderBoard.d.ts

@@ -12,7 +12,9 @@ export declare class WSAPILeaderBoard extends WSAPIGamePick {
      *
      * The leaderboard for each period type is configured separately by
      * the operator. A label may have any combination of DAILY, WEEKLY,
-     * and MONTHLY boards configured (or none).
+     * and MONTHLY boards configured (or none). To discover which boards
+     * exist before loading any standings, call {@link getLeaderBoards}
+     * (metadata only) and drive the tab selector from its `period_type_id`s.
      *
      * @remarks
      * **Return value note** — the runtime may return `undefined` if no
@@ -24,10 +26,13 @@ export declare class WSAPILeaderBoard extends WSAPIGamePick {
      * Pass a `periodType` from {@link LeaderBoardPeriodType}
      * (`DAILY = 1`, `WEEKLY = 2`, `MONTHLY = 3`). Pass
      * `getPreviousPeriod: true` to fetch the most-recently-ended
-     * period's snapshot (yesterday's results, last week's results,
-     * last month's results) instead of the current live period. The
-     * SDK only exposes one period back — older snapshots are not
-     * reachable through this method.
+     * period's snapshot (yesterday's / last week's / last month's
+     * results) instead of the current live period. To reach older
+     * snapshots, pass a number instead of a boolean: `1` = previous
+     * period, `2` = the one before that, and so on (`0` / `false` =
+     * current). Use the snapshot's `create_date` / `version_id` to label
+     * which historical run a previous-period board is. How far back
+     * snapshots are retained is operator-configured.
      *
      * **Top-20 cap**
      * The server hard-caps `users[]` at 20 entries, ordered by
@@ -81,10 +86,11 @@ export declare class WSAPILeaderBoard extends WSAPIGamePick {
      *                           Selects which pre-configured board to
      *                           fetch; the board itself is bound to one
      *                           period by the operator.
-     * @param getPreviousPeriod  When `true`, returns the most recent
-     *                           finalized snapshot for that period type
-     *                           (e.g. last week's results). Defaults to
-     *                           `false` (current in-progress period).
+     * @param getPreviousPeriod  Which period to fetch. `false` (default)
+     *                           = current in-progress period; `true` =
+     *                           the most recent finalized snapshot; a
+     *                           number `n` = the n-th previous snapshot
+     *                           (`1` = previous, `2` = the one before, …).
      * @returns                  Promise resolving to `LeaderBoardDetailsT`.
      *                           **At runtime, may resolve to `undefined`**
      *                           when no board is configured for the
@@ -127,5 +133,65 @@ export declare class WSAPILeaderBoard extends WSAPIGamePick {
      * // const visitorBoard = await window._smartico.vapi('EN').getLeaderBoard(LeaderBoardPeriodType.DAILY);
      * ```
      */
-    getLeaderBoard(periodType: LeaderBoardPeriodType, getPreviousPeriod?: boolean): Promise<LeaderBoardDetailsT>;
+    getLeaderBoard(periodType: LeaderBoardPeriodType, getPreviousPeriod?: boolean | number): Promise<LeaderBoardDetailsT>;
+    /**
+     * Returns the list of leaderboards the operator has configured for this
+     * label — **metadata only, without participants**. Use it to discover
+     * which boards exist (and their period types) so you can render the
+     * board/tab selector, then load a specific board's standings on demand
+     * with {@link getLeaderBoard}.
+     *
+     * This is the lightweight discovery counterpart to {@link getLeaderBoard}:
+     * it issues one round-trip that returns every board's identity, name,
+     * description, rules, `period_type_id`, and prize table, but **not** the
+     * ranked players. Fetching the full standings for one board (the top-20
+     * `users[]` and the caller's own `me` entry) is what {@link getLeaderBoard}
+     * does per period.
+     *
+     * @remarks
+     * **Returned shape**
+     * An array of `LeaderBoardDetailsT`, one per configured board, ordered by
+     * `period_type_id` ascending (DAILY, WEEKLY, MONTHLY, …). On every entry
+     * `users` is an empty array and `me` is `undefined` — this call never
+     * carries participant data. Read `period_type_id` from each entry and pass
+     * it to {@link getLeaderBoard} to load that board's standings.
+     *
+     * **Empty result**
+     * Resolves to an empty array when the label has no leaderboards configured
+     * — treat that as "hide the leaderboard surface".
+     *
+     * **Cache TTL**
+     * Cached for 30 seconds under a dedicated key (independent of
+     * {@link getLeaderBoard}'s per-period cache). Repeated calls within the
+     * window return the cached list without a round-trip.
+     *
+     * **Refresh model**: one-shot fetch — no subscription, no push. Board
+     * configuration changes surface on the next cache miss.
+     *
+     * **Idempotency / Side effects**: safe. Read-only.
+     *
+     * **Visitor mode**: supported. Returns the brand's public board list.
+     *
+     * @returns Promise resolving to the array of configured boards
+     *          (metadata only). Empty array when none are configured.
+     *
+     * @example
+     * ```ts
+     * const boards = await window._smartico.api.getLeaderBoards();
+     *
+     * if (boards.length === 0) {
+     *   console.log('[smartico] no leaderboards configured — hide the leaderboard surface');
+     *   return;
+     * }
+     *
+     * // Render one tab per board from the lightweight list (no players yet).
+     * console.log('[smartico] render leaderboard tabs:', boards.map(b => b.name));
+     *
+     * // When the user opens a tab, load that board's standings on demand.
+     * const first = boards[0];
+     * const full = await window._smartico.api.getLeaderBoard(first.period_type_id);
+     * console.log('[smartico] loaded standings for', first.name, '—', full?.users.length ?? 0, 'players');
+     * ```
+     */
+    getLeaderBoards(): Promise<LeaderBoardDetailsT[]>;
 }

package/dist/WSAPI/WSAPITypes.d.ts

@@ -899,6 +899,10 @@ export interface TMissionOrBadgeTask {
     progress: number;
     /** Reward for completing the task in points */
     points_reward: number;
+    /** Reward for completing the task in gems */
+    gems_reward?: number;
+    /** Reward for completing the task in diamonds */
+    diamonds_reward?: number;
     /** This is the total number of times the user needs to execute to complete task. e.g. he needs to bet 100 times. Here will be 100 */
     execution_count_expected?: number;
     /** This is the number of times the user has executed 'activity' of the task. e.g. he bet 5 times out of 100. Here will be 5 */
@@ -1040,9 +1044,16 @@ export interface LeaderBoardDetailsT {
     rules: string;
     /** Period type this board is bound to ({@link LeaderBoardPeriodType}). */
     period_type_id: LeaderBoardPeriodType;
+    /** Snapshot version. `0` for the live current period; a positive value
+     * identifies a finalized previous-period snapshot (see `getPreviousPeriod`). */
+    version_id: number;
+    /** Snapshot creation timestamp (Unix ms). `0` for the live current period;
+     * the finalization time for a previous-period snapshot. */
+    create_date: number;
     /** Per-place prize table; the array length is the number of paid places. */
     rewards: LeaderBoardsRewardsT[];
-    /** Top-20 ranked entries (server-capped), sorted by `position` ASC. */
+    /** Top-20 ranked entries (server-capped), sorted by `position` ASC.
+     * Empty when fetched via `getLeaderBoards()` (metadata-only list). */
     users: LeaderBoardUserT[];
     /** Current user's own entry. `undefined` for visitor sessions.
      * For authenticated users, `position === -1` means the user is
@@ -1065,14 +1076,20 @@ export interface LeaderBoardsRewardsT {
 export interface LeaderBoardUserT {
     /** Display username (operator-defined alias). */
     public_username: string;
-    /** Resolved CDN URL for the participant's avatar. */
+    /** Resolved CDN URL for the participant's avatar. May be empty when the
+     * participant has no custom avatar — fall back to a level-based default
+     * using `level_id`. */
     avatar_url: string;
+    /** The participant's level id — use it to resolve a level-based default
+     * avatar when `avatar_url` is empty. */
+    level_id: number;
     /** Rank in the leaderboard (DENSE_RANK over all participants).
      * `-1` on the `me` entry signals "unranked / outside the window". */
     position: number;
     /** Participant's points for this period. */
     points: number;
-    /** `true` when this row is the current authenticated user. */
+    /** `true` when this row is the current authenticated user. Always `true`
+     * on the `me` entry. */
     is_me: boolean;
 }
 /**
@@ -1675,9 +1692,9 @@ export interface TAvatarPrompt {
     name: string;
     /** Absolute CDN URL of the prompt's preview icon. */
     icon_url: string;
-    /** 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. */
     cost_currency_type_id: 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. */
     cost_value: number;
 }
 /**