@smartico/public-api 0.0.361 → 0.0.362

package/dist/Avatars/AvatarCustomizeErrorCode.d.ts

@@ -0,0 +1,5 @@
+export declare enum AvatarCustomizeErrorCode {
+    AVATAR_USER_LIMIT = 12001,
+    AVATAR_LABEL_LIMIT = 12002
+}
+export declare const AvatarCustomizeErrorMessage: Record<AvatarCustomizeErrorCode, string>;

package/dist/Avatars/AvatarCustomized.d.ts

@@ -0,0 +1,8 @@
+export interface AvatarCustomized {
+    /** The avatar real id that this customization belongs to */
+    avatar_real_id: number;
+    /** CDN URL of the AI-customized avatar image */
+    url: string;
+    /** ISO date string when the customization was created */
+    dt_created: string;
+}

package/dist/Avatars/AvatarDefinition.d.ts

@@ -0,0 +1,30 @@
+export interface AvatarDefinition {
+    /** Unique identifier of the avatar */
+    avatar_real_id: number;
+    /** Whether this avatar is the default one */
+    is_default: boolean;
+    /** If true, avatar is hidden until user achieves/unlocks it */
+    hide_until_achieved: boolean;
+    /** Display priority — lower value means higher position */
+    priority: number;
+    /** Public metadata containing the avatar image URL and optional description */
+    public_meta: {
+        /** Optional description of the avatar */
+        description?: string;
+        /** Image path/URL of the avatar */
+        url: string;
+    };
+    /**
+     * Source type of the avatar.
+     * 0 = free (always available), other values = earned/purchased
+     */
+    avatar_source_type_id: number;
+    /** ISO date string from which the avatar becomes available */
+    active_from_date?: string;
+    /** ISO date string until which the avatar is available */
+    active_till_date?: string;
+    /** Whether the avatar has been granted/given to the current user */
+    is_given: boolean;
+    /** Whether this avatar is currently in use by the user */
+    is_in_use?: boolean;
+}

package/dist/Avatars/AvatarPrompt.d.ts

@@ -0,0 +1,15 @@
+export interface AvatarPrompt {
+    /** Unique identifier of the AI customization prompt */
+    prompt_id: number;
+    /** Public metadata for the prompt */
+    public_meta: {
+        /** Display name of the prompt style (e.g. "Cartoon", "Watercolor") */
+        name: string;
+        /** URL of the prompt style icon image */
+        icon_url: string;
+    };
+    /** Currency type used to pay for this customization (0=points, 1=gems, 2=diamonds) */
+    cost_currency_type_id: number;
+    /** Cost amount in the given currency */
+    cost_value: number;
+}

package/dist/Avatars/GetAvatarPromptsResponse.d.ts

@@ -0,0 +1,5 @@
+import { ProtocolResponse } from '../Base/ProtocolResponse';
+import { AvatarPrompt } from './AvatarPrompt';
+export interface GetAvatarPromptsResponse extends ProtocolResponse {
+    prompts: AvatarPrompt[];
+}

package/dist/Avatars/GetAvatarsCustomizedResponse.d.ts

@@ -0,0 +1,5 @@
+import { ProtocolResponse } from '../Base/ProtocolResponse';
+import { AvatarCustomized } from './AvatarCustomized';
+export interface GetAvatarsCustomizedResponse extends ProtocolResponse {
+    avatars: AvatarCustomized[];
+}

package/dist/Avatars/GetAvatarsListResponse.d.ts

@@ -0,0 +1,5 @@
+import { ProtocolResponse } from '../Base/ProtocolResponse';
+import { AvatarDefinition } from './AvatarDefinition';
+export interface GetAvatarsListResponse extends ProtocolResponse {
+    avatars: AvatarDefinition[];
+}

package/dist/Avatars/SetAvatarRequest.d.ts

@@ -0,0 +1,7 @@
+import { ProtocolRequest } from '../Base/ProtocolRequest';
+export interface SetAvatarRequest extends ProtocolRequest {
+    /** The avatar image URL or path to set */
+    avatar_id: string;
+    /** The avatar_real_id from the avatar catalog */
+    avatar_real_id: number;
+}

package/dist/Avatars/SetAvatarResponse.d.ts

@@ -0,0 +1,5 @@
+import { ProtocolResponse } from '../Base/ProtocolResponse';
+export interface SetAvatarResponse extends ProtocolResponse {
+    /** The resolved avatar URL after applying the avatar */
+    avatar_id: string;
+}

package/dist/Avatars/index.d.ts

@@ -0,0 +1,9 @@
+export * from './AvatarCustomizeErrorCode';
+export * from './AvatarDefinition';
+export * from './AvatarCustomized';
+export * from './AvatarPrompt';
+export * from './GetAvatarsListResponse';
+export * from './GetAvatarsCustomizedResponse';
+export * from './GetAvatarPromptsResponse';
+export * from './SetAvatarRequest';
+export * from './SetAvatarResponse';

package/dist/SmarticoAPI.d.ts

@@ -23,6 +23,7 @@ import { GetRafflesResponse } from './Raffle/GetRafflesResponse';
 import { GetActivityLogResponse } from './ActivityLog';
 import { InboxCategories } from './Inbox/InboxCategories';
 import { GetDrawRunResponse, GetRaffleDrawRunsHistoryResponse, RaffleClaimPrizeResponse, RaffleOptinResponse } from './Raffle';
+import { GetAvatarsListResponse, GetAvatarsCustomizedResponse, GetAvatarPromptsResponse, SetAvatarResponse } from './Avatars';
 import { GetJackpotWinnersResponse, JackpotWinnerHistory } from './Jackpots/GetJackpotWinnersResponse';
 import { GetJackpotEligibleGamesResponse, TGetJackpotEligibleGamesResponse } from './Jackpots/GetJackpotEligibleGamesResponse';
 import { GamesApiResponse, GamePickRound, GamePickRoundBoard, GamePickUserInfo, GamePickGameInfo } from './WSAPI/WSAPITypes';
@@ -173,6 +174,10 @@ declare class SmarticoAPI {
     gpGetGameInfo(saw_template_id: number): Promise<GamesApiResponse<GamePickGameInfo>>;
     gpGetTranslations(saw_template_id: number): Promise<GamesApiResponse<any>>;
     gpGetRoundInfoForUser(saw_template_id: number, round_id: number, int_user_id: number): Promise<GamesApiResponse<GamePickRound>>;
+    avatarsGetList(user_ext_id: string): Promise<GetAvatarsListResponse>;
+    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>;
     getWSCalls(): WSAPI;
     getRelatedItemsForGame(user_ext_id: string, related_game_id: string): Promise<GetRelatedAchTourResponse>;
     getRafflesT(user_ext_id: string): Promise<TRaffle[]>;

package/dist/WSAPI/WSAPI.d.ts

@@ -1,6 +1,6 @@
 import { ActivityTypeLimited } from '../Core';
 import { SmarticoAPI } from '../SmarticoAPI';
-import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionClaimRewardResult, TMissionOptInResult, TMissionOrBadge, TSegmentCheckResult, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUICustomSection, TUserProfile, UserLevelExtraCountersT, TBonus, TClaimBonusResult, TMiniGamePlayBatchResult, TSawHistory, TRaffle, TRaffleDraw, TRaffleDrawRun, TransformedRaffleClaimPrizeResponse, TLevelCurrent, TActivityLog, TRaffleOptinResponse, GamesApiResponse, GamePickRound, GamePickRoundBoard, GamePickUserInfo, GamePickGameInfo, GamePickRequestParams, GamePickRoundRequestParams } from './WSAPITypes';
+import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionClaimRewardResult, TMissionOptInResult, TMissionOrBadge, TSegmentCheckResult, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUICustomSection, TUserProfile, UserLevelExtraCountersT, TBonus, TClaimBonusResult, TMiniGamePlayBatchResult, TSawHistory, TRaffle, TRaffleDraw, TRaffleDrawRun, TransformedRaffleClaimPrizeResponse, TLevelCurrent, TActivityLog, TRaffleOptinResponse, GamesApiResponse, GamePickRound, GamePickRoundBoard, GamePickUserInfo, GamePickGameInfo, GamePickRequestParams, GamePickRoundRequestParams, TAvatarDefinition, TAvatarCustomized, TAvatarPrompt, TSetAvatarResult } from './WSAPITypes';
 import { LeaderBoardPeriodType } from '../Leaderboard';
 import { JackpotDetails, JackpotWinnerHistory, JackpotsOptinResponse, JackpotsOptoutResponse } from '../Jackpots';
 import { GetRelatedAchTourResponse } from '../Missions/GetRelatedAchTourResponse';
@@ -886,6 +886,79 @@ export declare class WSAPI {
     gamePickGetRoundInfoForUser(props: GamePickRoundRequestParams & {
         int_user_id: number;
     }): Promise<GamesApiResponse<GamePickRound>>;
+    /**
+     * Returns the list of avatars available in the catalog for the current user.
+     * The response includes both free avatars and earned/purchased ones.
+     * Avatars with `hide_until_achieved = true` and `is_given = false` should be hidden from the user.
+     * The result is cached for 30 seconds.
+     *
+     * **Example**:
+     * ```
+     * _smartico.api.getAvatarsList().then((result) => {
+     *      console.log(result);
+     * });
+     * ```
+     *
+     * **Visitor mode: not supported**
+     */
+    getAvatarsList(): Promise<TAvatarDefinition[]>;
+    /**
+     * Returns the list of AI-customized avatars for the current user.
+     * Each entry represents a previously generated AI customization for a specific base avatar.
+     * The result is cached for 30 seconds.
+     *
+     * **Example**:
+     * ```
+     * _smartico.api.getAvatarsCustomized().then((result) => {
+     *      console.log(result);
+     * });
+     * ```
+     *
+     * **Visitor mode: not supported**
+     */
+    getAvatarsCustomized(): Promise<TAvatarCustomized[]>;
+    /**
+     * Returns the list of AI customization prompts (styles) available for avatar customization.
+     * Each prompt represents a visual style that can be applied to a base avatar.
+     * The result is cached for 30 seconds.
+     *
+     * **Example**:
+     * ```
+     * _smartico.api.getAvatarPrompts().then((result) => {
+     *      console.log(result);
+     * });
+     * ```
+     *
+     * **Visitor mode: not supported**
+     */
+    getAvatarPrompts(): Promise<TAvatarPrompt[]>;
+    /**
+     * Sets the specified avatar as the active avatar for the current user.
+     * Pass `avatar_url` (the image path from `TAvatarDefinition.public_meta.url` or a CDN URL for AI-customized avatars)
+     * and `avatar_real_id` from the avatar catalog.
+     * After a successful call, the avatar list cache is cleared so the next `getAvatarsList()` call reflects `is_in_use`.
+     *
+     * **Example**:
+     * ```
+     * _smartico.api.getAvatarsList().then((avatars) => {
+     *      const avatar = avatars.find((a) => !a.hide_until_achieved || a.is_given);
+     *      if (avatar) {
+     *          _smartico.api.setAvatar({
+     *              avatar_url: avatar.public_meta.url,
+     *              avatar_real_id: avatar.avatar_real_id,
+     *          }).then((result) => {
+     *              console.log(result);
+     *          });
+     *      }
+     * });
+     * ```
+     *
+     * **Visitor mode: not supported**
+     */
+    setAvatar(props: {
+        avatar_url: string;
+        avatar_real_id: number;
+    }): Promise<TSetAvatarResult>;
     private updateOnSpin;
     private reloadMiniGameTemplate;
     private updateMissions;

package/dist/WSAPI/WSAPITypes.d.ts

@@ -1752,4 +1752,77 @@ export interface GamePickRoundRequestParams extends GamePickRequestParams {
     /** ID of the specific round */
     round_id: number;
 }
+/**
+ * TAvatarDefinition describes a single avatar available in the avatar catalog
+ */
+export interface TAvatarDefinition {
+    /** Unique identifier of the avatar */
+    avatar_real_id: number;
+    /** Whether this avatar is the default one */
+    is_default: boolean;
+    /** If true, avatar is hidden until user achieves/unlocks it */
+    hide_until_achieved: boolean;
+    /** Display priority — lower value means higher position in the grid */
+    priority: number;
+    /** Public metadata containing the avatar image URL and optional description */
+    public_meta: {
+        /** Optional description of the avatar */
+        description?: string;
+        /** Image path/URL of the avatar */
+        url: string;
+    };
+    /**
+     * Source type of the avatar.
+     * 0 = free (always available to all users), other values = earned/purchased
+     */
+    avatar_source_type_id: number;
+    /** ISO date string from which the avatar becomes available */
+    active_from_date?: string;
+    /** ISO date string until which the avatar is available */
+    active_till_date?: string;
+    /** Whether the avatar has been granted/given to the current user */
+    is_given: boolean;
+    /** Whether this avatar is currently in use by the user */
+    is_in_use?: boolean;
+    /** Full CDN URL of the avatar image, built from avatar_domain + public_meta.url */
+    avatar_url: string;
+}
+/**
+ * TAvatarCustomized describes an AI-customized version of a base avatar
+ */
+export interface TAvatarCustomized {
+    /** The avatar_real_id of the base avatar this customization was generated from */
+    avatar_real_id: number;
+    /** Full CDN URL of the AI-generated customized avatar image */
+    url: string;
+    /** ISO date string when the customization was created */
+    dt_created: string;
+}
+/**
+ * TAvatarPrompt describes an AI style prompt available for avatar customization
+ */
+export interface TAvatarPrompt {
+    /** Unique identifier of the AI customization prompt */
+    prompt_id: number;
+    /** Public metadata for the prompt */
+    public_meta: {
+        /** Display name of the prompt style (e.g. "Cartoon", "Watercolor") */
+        name: string;
+        /** URL of the prompt style icon image */
+        icon_url: string;
+    };
+    /** Currency type used to pay for this customization (0=points, 1=gems, 2=diamonds) */
+    cost_currency_type_id: number;
+    /** Cost amount in the given currency */
+    cost_value: number;
+}
+/**
+ * TSetAvatarResult describes the response of call to _smartico.api.setAvatar() method
+ */
+export interface TSetAvatarResult {
+    /** Error code that represents outcome of the set avatar request. Successful if err_code is 0 */
+    err_code: number;
+    /** Optional error message */
+    err_message?: string;
+}
 export { SAWAcknowledgeTypeName, PrizeModifiers, SAWTemplateUI, InboxCategories, AchCustomSectionType, SAWAskForUsername, SAWGameLayout, PointChangeSourceType, UserBalanceType, SAWGPMarketType, QuizAnswersValueType };

package/dist/index.d.ts

@@ -21,3 +21,4 @@ export * from './Bonuses';
 export * from './CustomSections';
 export * from './ActivityLog';
 export * from './Base/AchRelatedGame';
+export * from './Avatars';