@smartico/public-api 0.0.110 → 0.0.112

package/dist/Leaderboard/LeaderBoards.d.ts

@@ -0,0 +1,3 @@
+import { LeaderBoardDetailsT } from "src/WSAPI/WSAPITypes";
+import { LeaderBoardDetails } from "./LeaderBoardDetails";
+export declare const getLeaderBoardTransform: (board: LeaderBoardDetails) => LeaderBoardDetailsT;

package/dist/Level/LevelPublicMeta.d.ts

@@ -14,4 +14,6 @@ export interface LevelPublicMeta {
         dx: number;
         dy: number;
     };
+    /**custom data as string or JSON string that can be used in UIWidget */
+    custom_data: string;
 }

package/dist/SmarticoAPI.d.ts

@@ -11,7 +11,7 @@ import { GetTournamentInfoResponse, GetTournamentsResponse, TournamentRegisterRe
 import { LeaderBoardDetails, LeaderBoardPeriodType } from "./Leaderboard";
 import { GetLevelMapResponse } from "./Level";
 import { WSAPI } from "./WSAPI/WSAPI";
-import { TInboxMessage, TInboxMessageBody, TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TAchCategory, TStoreItem, TTournament, TTournamentDetailed } from "./WSAPI/WSAPITypes";
+import { TInboxMessage, TInboxMessageBody, TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TAchCategory, TStoreItem, TTournament, TTournamentDetailed, LeaderBoardDetailsT } from "./WSAPI/WSAPITypes";
 interface Tracker {
     label_api_key: string;
     userPublicProps: any;
@@ -77,6 +77,7 @@ declare class SmarticoAPI {
     tournamentsGetInfo(user_ext_id: string, tournamentInstanceId: number): Promise<GetTournamentInfoResponse>;
     tournamentsGetInfoT(user_ext_id: string, tournamentInstanceId: number): Promise<TTournamentDetailed>;
     leaderboardGet(user_ext_id: string, period_type_id?: LeaderBoardPeriodType, prevPeriod?: boolean): Promise<LeaderBoardDetails>;
+    leaderboardsGetT(user_ext_id: string, period_type_id?: LeaderBoardPeriodType, prevPeriod?: boolean): Promise<LeaderBoardDetailsT>;
     levelsGet(user_ext_id: string): Promise<GetLevelMapResponse>;
     levelsGetT(user_ext_id: string): Promise<TLevel[]>;
     getTranslationsT(user_ext_id: string, lang_code: string, areas: TranslationArea[], cacheSec?: number): Promise<GetTranslationsResponse>;

package/dist/WSAPI/WSAPI.d.ts

@@ -1,5 +1,6 @@
 import { SmarticoAPI } from "../SmarticoAPI";
-import { InboxMarkMessageAction, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionOptInResult, TMissionOrBadge, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUserProfile } from "./WSAPITypes";
+import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionOptInResult, TMissionOrBadge, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUserProfile } from "./WSAPITypes";
+import { LeaderBoardPeriodType } from "src/Leaderboard";
 /** @group General API */
 export declare class WSAPI {
     private api;
@@ -56,6 +57,10 @@ export declare class WSAPI {
     getTournamentInstanceInfo(tournamentInstanceId: number): Promise<TTournamentDetailed>;
     /** Requests registration for the specified tournament instance. Returns the err_code. */
     registerInTournament(tournamentInstanceId: number): Promise<TTournamentRegistrationResult>;
+    /** Returns the leaderboard for the current type (default is Daily). If getPreviousPeriod is passed as true, a leaderboard for the previous period for the current type will be returned.
+        For example, if the type is Weekly and getPreviousPeriod is true, a leaderboard for the previous week will be returned.
+     */
+    getLeaderBoard(periodType: LeaderBoardPeriodType, getPreviousPeriod?: boolean): Promise<LeaderBoardDetailsT>;
     /** Returns inbox messages based on the provided parameters. "From" and "to" indicate the range of messages to be fetched.
     * The maximum number of messages per request is limited to 20. An indicator "onlyFavorite" can be passed to get only messages marked as favorites.
     * You can leave this params empty and by default it will return list of messages ranging from 0 to 20.

package/dist/WSAPI/WSAPITypes.d.ts

@@ -1,6 +1,7 @@
 import { BuyStoreItemErrorCode } from "../Store";
 import { MiniGamePrizeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWSpinErrorCode } from "../MiniGames";
 import { TournamentRegistrationError, TournamentRegistrationStatusName, TournamentRegistrationTypeName } from "../Tournaments";
+import { LeaderBoardPeriodType } from "src/Leaderboard";
 type TRibbon = 'sale' | 'hot' | 'new' | 'vip' | string;
 /**
  * TMiniGamePrize describes the information of prize in the array of prizes in the TMiniGameTemplate
@@ -139,6 +140,8 @@ export interface TLevel {
      *
     */
     required_level_counter_2: number;
+    /** The custom data of the mini-game defined by operator. Can be a JSON object, string or number */
+    custom_data: string;
 }
 /**
  * TTournament describes the general information of the tournament item
@@ -321,6 +324,8 @@ export interface TStoreItem {
     category_ids: number[];
     /** Number of items in the pool avaliable for the purchase.*/
     pool?: number;
+    /** The T&C text for the store item */
+    hint_text?: string;
 }
 /**
  * TAchCategory describes the badge category item. Each badge item can be assigned to 1 or more categories
@@ -387,6 +392,8 @@ export interface TMissionOrBadge {
     related_games?: AchRelatedGame[];
     /** The list of IDs of the categories where the badge item is assigned, information about categories can be retrieved with getAchCategories method */
     category_ids: number[];
+    /** The T&C text for the missions */
+    hint_text?: string;
 }
 export interface AchRelatedGame {
     /** The ID of the related game */
@@ -486,4 +493,38 @@ export interface InboxMarkMessageAction {
     /** Optional error message */
     err_message: string;
 }
+export interface LeaderBoardDetailsT {
+    /** ID of the leaderboard */
+    board_id: number;
+    /** Name of the leaderboard */
+    name: string;
+    /** Description of the leaderboard */
+    description: string;
+    /** Rules of the leaderboard */
+    rules: string;
+    /** Leaderboard period type ID */
+    period_type_id: LeaderBoardPeriodType;
+    /** Leaderboard points rewards */
+    rewards: LeaderBoardsRewardsT[];
+    /** Leaderboard users */
+    users: LeaderBoardUserT[];
+    /** Info about current user in leaderboard */
+    me?: LeaderBoardUserT;
+}
+export interface LeaderBoardsRewardsT {
+    place: number;
+    points: number;
+}
+export interface LeaderBoardUserT {
+    /** The username of the participant */
+    public_username: string;
+    /** The URL to the avatar of the participant */
+    avatar_url: string;
+    /** The position of the participant in the leaderboard */
+    position: number;
+    /** The points of the participant in the leaderboard */
+    points: number;
+    /** The indicator if the participant is current user */
+    is_me: boolean;
+}
 export {};