@smartico/public-api 0.0.50 → 0.0.52

package/dist/MiniGames/SAWTemplateUI.d.ts

@@ -23,6 +23,8 @@ export interface SAWTemplateUI {
     promo_image?: string;
     promo_text?: string;
     matchx_banner?: string;
+    matchx_seasonal_ranking?: boolean;
+    matchx_general_board_users_count: number;
     ask_for_username?: SAWAskForUsername;
     show_prize_board?: boolean;
     max_spins_period_ms?: number;

package/dist/SmarticoAPI.d.ts

@@ -11,7 +11,7 @@ import { GetTournamentInfoResponse, GetTournamentsResponse } from './Tournaments
 import { LeaderBoardDetails, LeaderBoardPeriodType } from "./Leaderboard";
 import { GetLevelMapResponse } from "./Level";
 import { WSAPI } from "./WSAPI/WSAPI";
-import { TLevel, TMissionOrBadge } from "./WSAPI/WSAPITypes";
+import { TLevel, TMissionOrBadge, TStoreItem, TTournament, TTournamentDetailed } from "./WSAPI/WSAPITypes";
 interface Tracker {
     label_api_key: string;
     userPublicProps: any;
@@ -54,15 +54,18 @@ declare class SmarticoAPI {
     sawSpinRequest(user_ext_id: string, saw_template_id: number, round_id: number): Promise<SAWDoSpinResponse>;
     inboxGetMessages(user_ext_id: string, limit?: number, offset?: number): Promise<GetInboxMessagesResponse>;
     storeGetItems(user_ext_id: string): Promise<GetStoreItemsResponse>;
+    storeGetItemsT(user_ext_id: string): Promise<TStoreItem[]>;
     missionsGetItems(user_ext_id: string): Promise<GetAchievementMapResponse>;
-    missionsGetItemsT(user_ext_id?: string): Promise<TMissionOrBadge[]>;
+    missionsGetItemsT(user_ext_id: string): Promise<TMissionOrBadge[]>;
     badgetsGetItems(user_ext_id: string): Promise<GetAchievementMapResponse>;
-    badgetsGetItemsT(user_ext_id?: string): Promise<TMissionOrBadge[]>;
+    badgetsGetItemsT(user_ext_id: string): Promise<TMissionOrBadge[]>;
     tournamentsGetLobby(user_ext_id: string): Promise<GetTournamentsResponse>;
+    tournamentsGetLobbyT(user_ext_id: string): Promise<TTournament[]>;
     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>;
-    levelsGet(user_ext_id?: string): Promise<GetLevelMapResponse>;
-    levelsGetT(user_ext_id?: string): Promise<TLevel[]>;
+    levelsGet(user_ext_id: string): Promise<GetLevelMapResponse>;
+    levelsGetT(user_ext_id: string): Promise<TLevel[]>;
     getWSCalls(): WSAPI;
 }
 export { SmarticoAPI, MessageSender };

package/dist/Store/StoreItem.d.ts

@@ -1,3 +1,4 @@
+import { TStoreItem } from "../WSAPI/WSAPITypes";
 import { StoreItemPublicMeta } from "./StoreItemPublicMeta";
 import { StoreItemType } from "./StoreItemType";
 export interface StoreItem {
@@ -7,3 +8,4 @@ export interface StoreItem {
     categoryIds?: number[];
     canBuy?: boolean;
 }
+export declare const StoreItemTransform: (items: StoreItem[]) => TStoreItem[];

package/dist/Tournaments/GetTournamentInfoResponse.d.ts

@@ -2,6 +2,7 @@ import { Tournament } from "./Tournament";
 import { TournamentPlayer } from "./TournamentPlayer";
 import { ProtocolResponse } from "../Base/ProtocolResponse";
 import { TournamentPrize } from "./TournamentPrize";
+import { TTournamentDetailed } from "../WSAPI/WSAPITypes";
 export interface GetTournamentInfoResponse extends ProtocolResponse {
     /** tournament info */
     tournamentInfo: {
@@ -18,3 +19,4 @@ export interface GetTournamentInfoResponse extends ProtocolResponse {
         prizes: TournamentPrize[];
     };
 }
+export declare const tournamentInfoItemTransform: (t: GetTournamentInfoResponse) => TTournamentDetailed;

package/dist/Tournaments/Tournament.d.ts

@@ -3,6 +3,7 @@ import { TournamentInstanceStatus } from "./TournamentInstanceStatus";
 import { TournamentRegistrationStatus } from "./TournamentRegistrationStatus";
 import { TournamentType } from "./TournamentType";
 import { TournamentPublicMeta } from "./TournamentPublicMeta";
+import { TTournament } from "../WSAPI/WSAPITypes";
 export interface Tournament {
     /** ID of tournament template */
     tournamentId?: number;
@@ -20,6 +21,10 @@ export interface Tournament {
     startTime?: string;
     /** The time when tournament is going to finish */
     endTime?: string;
+    /** The time when tournament is going to start, epoch */
+    startTimeTs?: number;
+    /** The time when tournament is going to finish, epoch */
+    endTimeTs?: number;
     /** Number of users registered in the tournament */
     registrationCount?: number;
     /** Not in use */
@@ -41,3 +46,4 @@ export interface Tournament {
     /** Tournament duration in millisecnnds */
     durationMs?: number;
 }
+export declare const TournamentItemsTransform: (items: Tournament[]) => TTournament[];

package/dist/Tournaments/TournamentRegistrationStatus.d.ts

@@ -1,3 +1,4 @@
+/** @hidden */
 export declare enum TournamentRegistrationStatus {
     NOT_REGISTERED = 0,
     REGISTERED = 1,
@@ -7,3 +8,6 @@ export declare enum TournamentRegistrationStatus {
     REGISTERED_PENDING_QUALIFICATION = 5,
     QUALIFIED_PENDING_REGISTRATION = 6
 }
+export type TournamentRegistrationStatusName = 'NOT_REGISTERED' | 'REGISTERED' | 'FINISHED' | 'PENDING' | 'CANCELLED' | 'REGISTERED_PENDING_QUALIFICATION' | 'QUALIFIED_PENDING_REGISTRATION';
+/** @hidden */
+export declare const TournamentRegistrationStatusName: (type: TournamentRegistrationStatus) => TournamentRegistrationStatusName;

package/dist/Tournaments/TournamentRegistrationType.d.ts

@@ -1,3 +1,4 @@
+/** @hidden */
 export declare enum TournamentRegistrationType {
     AUTO = 1,
     OPT_IN = 2,
@@ -5,3 +6,6 @@ export declare enum TournamentRegistrationType {
     MANUAL_APPROVAL = 4,
     REQUIRES_QUALIFICATION = 5
 }
+export type TournamentRegistrationTypeName = 'AUTO' | 'OPT_IN' | 'BUY_IN_POINTS' | 'MANUAL_APPROVAL' | 'REQUIRES_QUALIFICATION' | 'UNKNOWN';
+/** @hidden */
+export declare const TournamentRegistrationTypeGetName: (type: TournamentRegistrationType) => TournamentRegistrationTypeName;

package/dist/WSAPI/WSAPI.d.ts

@@ -1,5 +1,5 @@
 import { SmarticoAPI } from "../SmarticoAPI";
-import { TLevel, TMissionOrBadge, TUserProfile } from "./WSAPITypes";
+import { TLevel, TMissionOrBadge, TStoreItem, TTournament, TTournamentDetailed, TUserProfile } from "./WSAPITypes";
 /** @group General API */
 export declare class WSAPI {
     private api;
@@ -13,4 +13,10 @@ export declare class WSAPI {
     getMissions(): Promise<TMissionOrBadge[]>;
     /** Returns all the badges available the current user */
     getBadges(): Promise<TMissionOrBadge[]>;
+    /** Returns all the store items available the current user */
+    getStoreItems(): Promise<TStoreItem[]>;
+    /** Returns all the active instances of tournaments */
+    getTournamentsList(): Promise<TTournament[]>;
+    /** Returns details information of specific tournament instance, the response will includ tournamnet info and the leaderboard of players */
+    getTournamentInstanceInfo(tournamentInstanceId: number): Promise<TTournamentDetailed>;
 }

package/dist/WSAPI/WSAPITypes.d.ts

@@ -1,3 +1,5 @@
+import { TournamentRegistrationStatusName, TournamentRegistrationTypeName } from "../Tournaments";
+type TRibbon = 'sale' | 'hot' | 'new' | 'vip' | string;
 /**
  * TUser interface describes the information of the user
  * The user object is returned by _smartico.api.getUserProfile() method.
@@ -63,6 +65,132 @@ export interface TLevel {
     */
     required_level_counter_2: number;
 }
+/**
+ * TTournament interface describes the general information of the tournament item
+ */
+export interface TTournament {
+    /** ID of tournament instance. Generated every time when tournament based on specific template is scheduled for run */
+    instance_id: number;
+    /** ID of tournament template */
+    tournament_id: number;
+    /** Name of the tournament, translated to the user language */
+    name: string;
+    /** Description of the tournament, translated to the user language */
+    description: string;
+    image1: string;
+    image2: string;
+    prize_pool_short: string;
+    custom_price_text: string;
+    /** The message that should be shown to the user when the user cannot register in tournament with error code TOURNAMENT_USER_DONT_MATCH_CONDITIONS  */
+    segment_dont_match_message: string;
+    /**
+     * The ID of the custom section where the tournament is assigned
+     * The list of custom sections can be retrieved using _smartico.api.getCustomSections() method (TODO-API)
+    */
+    custom_section_id: number;
+    /** The custom data of the tournament defined by operator. Can be a JSON object, string or number */
+    custom_data: any;
+    /** The indicator if the tournament is 'Featured' */
+    is_featured: boolean;
+    /** The ribbon of the tournament item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon */
+    ribbon: TRibbon;
+    /** The time when tournament is going to start, epoch with milliseconds */
+    start_time: number;
+    /** The time when tournament is going to finish, epoch with milliseconds */
+    end_time: number;
+    /** Type of registration in the tournament */
+    registration_type: TournamentRegistrationTypeName;
+    /** Number of users registered in the tournament */
+    registration_count: number;
+    /** flag indicating if current user is registered in the tournament */
+    is_user_registered: boolean;
+    /** Minimum number of participant for this tournament. If tournament doesnt have enough registrations, it will not start */
+    players_min_count: number;
+    /** Maximum number of participant for this tournament. When reached, new users won't be able to register */
+    players_max_count: number;
+    /** Status of registration in the tournament for current user */
+    registration_status: TournamentRegistrationStatusName;
+    /** Tournament duration in millisecnnds */
+    duration_ms: number;
+    /** Cost of registration in the tournament in gamification points */
+    registration_cost_points: number;
+    /** Indicator if tournament instance is active, means in one of the statues -  PUBLISHED, REGISTED, STARTED */
+    is_active: boolean;
+    /** Indicator if user can register in this tournament instance, e.g tournament is active, max users is not reached, user is not registered yet */
+    is_can_register: boolean;
+    /** Indicator if tournament instance is cancelled (status CANCELLED) */
+    is_cancelled: boolean;
+    /** Indicator if tournament instance is finished (status FINISHED, CANCELLED OR FINIALIZING) */
+    is_finished: boolean;
+    /** Indicator if tournament instance is running (status STARTED) */
+    is_in_progress: boolean;
+    /** Indicator if tournament instance is upcoming (status PUBLISHED or REGISTER) */
+    is_upcoming: boolean;
+}
+/**
+ * TTournamentDetailed interface describes the information of the tournament item and includes list of participants, their scores and position in the tournament leaderboard
+ */
+export interface TTournamentDetailed extends TTournament {
+    /** The list of the tournament participants */
+    players?: {
+        /** 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 tournament */
+        position: number;
+        /** The scores of the participant in the tournament */
+        scores: number;
+        /** The indicator if the participant is current user */
+        is_me: boolean;
+    }[];
+    /** The information about current user in the tournament if he is registered in the tournamnet */
+    me?: {
+        /** The username of the current user */
+        public_username: string;
+        /** The URL to the avatar of the current user */
+        avatar_url: string;
+        /** The position of the current user in the tournament */
+        position: number;
+        /** The scores of the current user in the tournament */
+        scores: number;
+    };
+}
+/**
+ * TStoreItem interface describes the information of the store item defined in the system
+ */
+export interface TStoreItem {
+    /** ID of the store item  */
+    id: number;
+    /** Name of the store item, translated to the user language */
+    name: string;
+    /** Description of the store item, translated to the user language */
+    description: string;
+    /** URL of the image of the store item */
+    image: string;
+    /** Type of the store item. Can be 'bonus' or 'manual'. Manual, means it's tangible item, e.g. iPhone */
+    type: 'bonus' | 'manual';
+    /** The price of the store item in the gamification points */
+    price: number;
+    /** The ribbon of the store item. Can be 'sale', 'hot', 'new', 'vip' or URL to the image in case of custom ribbon */
+    ribbon: TRibbon;
+    /**
+     *  The message that should be shown to the user if he is not eligible to buy it. this message can be used to explain the reason why user cannot buy the item, e.g. 'You should be VIP to buy this item' and can be used in case can_buy property is false.
+        The message is translated to the user language.
+        **Note**: when user is trying to buy the item, the response from server can return custom error messages that can be shown to the user as well
+    */
+    limit_message: string;
+    /** The priority of the store item. Can be used to sort the items in the store */
+    priority: number;
+    /** The list of IDs of the related items. Can be used to show the related items in the store */
+    related_item_ids: number[];
+    /** The indicator if the user can buy the item
+     *  This indicator is taking into account the segment conditions for the store item, the price of item towards users balance,
+    */
+    can_buy: boolean;
+    /** The list of IDs of the categories where the store item is assigned, information about categories can be retrievend with getStoreCategories method */
+    category_ids: number[];
+}
 /**
  * TMissionOrBadge interface describes the information of mission or badge defined in the system
  */
@@ -130,3 +258,4 @@ export interface TMissionOrBadgeTask {
     /** The progress of the task in percents */
     progress: number;
 }
+export {};