@smartico/public-api 0.0.154 → 0.0.155

package/dist/Tournaments/TournamentUtils.d.ts

@@ -1,6 +1,6 @@
-import { Tournament } from "./Tournament";
-import { TournamentPlayer } from "./TournamentPlayer";
-import { TournamentPrize } from "./TournamentPrize";
+import { Tournament } from './Tournament';
+import { TournamentPlayer } from './TournamentPlayer';
+import { TournamentPrize } from './TournamentPrize';
 export declare class TournamentUtils {
     static isCanRegister: (tournament: Tournament) => boolean;
     static isInProgress: (tournament: Tournament) => boolean;

package/dist/Tournaments/index.d.ts

@@ -1,16 +1,16 @@
-export * from "./GetTournamentInfoRequest";
-export * from "./GetTournamentInfoResponse";
-export * from "./GetTournamentsRequest";
-export * from "./GetTournamentsResponse";
-export * from "./Tournament";
-export * from "./TournamentInstanceStatus";
-export * from "./TournamentPlayer";
-export * from "./TournamentPrize";
-export * from "./TournamentPublicMeta";
-export * from "./TournamentRegisterRequest";
-export * from "./TournamentRegisterResponse";
-export * from "./TournamentRegistrationError";
-export * from "./TournamentRegistrationStatus";
-export * from "./TournamentRegistrationType";
-export * from "./TournamentType";
-export * from "./TournamentUtils";
+export * from './GetTournamentInfoRequest';
+export * from './GetTournamentInfoResponse';
+export * from './GetTournamentsRequest';
+export * from './GetTournamentsResponse';
+export * from './Tournament';
+export * from './TournamentInstanceStatus';
+export * from './TournamentPlayer';
+export * from './TournamentPrize';
+export * from './TournamentPublicMeta';
+export * from './TournamentRegisterRequest';
+export * from './TournamentRegisterResponse';
+export * from './TournamentRegistrationError';
+export * from './TournamentRegistrationStatus';
+export * from './TournamentRegistrationType';
+export * from './TournamentType';
+export * from './TournamentUtils';

package/dist/WSAPI/WSAPI.d.ts

@@ -1,7 +1,7 @@
-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 } from "./WSAPITypes";
-import { LeaderBoardPeriodType } from "../Leaderboard";
-import { JackpotDetails, JackpotsOptinResponse, JackpotsOptoutResponse } from "../Jackpots";
+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 } from './WSAPITypes';
+import { LeaderBoardPeriodType } from '../Leaderboard';
+import { JackpotDetails, JackpotsOptinResponse, JackpotsOptoutResponse } from '../Jackpots';
 /** @group General API */
 export declare class WSAPI {
     private api;
@@ -29,7 +29,7 @@ export declare class WSAPI {
      * ```
      *
      * **Visitor mode: not supported**
-    */
+     */
     checkSegmentMatch(segment_id: number): Promise<boolean>;
     /** Check if user belongs to specific list of segments
      * **Example**:
@@ -39,7 +39,7 @@ export declare class WSAPI {
      * });
      * ```
      * **Visitor mode: not supported**
-    */
+     */
     checkSegmentListMatch(segment_ids: number[]): Promise<TSegmentCheckResult[]>;
     /** Returns all the levels available the current user
      * **Example**:
@@ -55,7 +55,7 @@ export declare class WSAPI {
      *      console.log(result);
      * });
      * ```
-    */
+     */
     getLevels(): Promise<TLevel[]>;
     /** Returns all the missions available the current user.
      * The returned missions are cached for 30 seconds. But you can pass the onUpdate callback as a parameter.
@@ -83,7 +83,7 @@ export declare class WSAPI {
      * Returns all the badges available the current user
      *
      * **Visitor mode: not supported**
-    */
+     */
     getBadges(): Promise<TMissionOrBadge[]>;
     /**
      * Returns the extra counters for the current user level.
@@ -98,7 +98,7 @@ export declare class WSAPI {
      * ```
      *
      * **Visitor mode: not supported**
-    */
+     */
     getUserLevelExtraCounters(): Promise<UserLevelExtraCountersT>;
     /**
      *
@@ -117,7 +117,7 @@ export declare class WSAPI {
      *      console.log(result);
      * });
      * ```
-    */
+     */
     getStoreItems(): Promise<TStoreItem[]>;
     /** Buy the specific shop item by item_id. Returns the err_code in case of success or error.
      * **Example**:
@@ -128,7 +128,7 @@ export declare class WSAPI {
      * ```
      *
      * **Visitor mode: not supported**
-    */
+     */
     buyStoreItem(item_id: number): Promise<TBuyStoreItemResult>;
     /**
      *
@@ -150,19 +150,19 @@ export declare class WSAPI {
      */
     getStoreCategories(): Promise<TStoreCategory[]>;
     /**
-    * Returns purchased items based on the provided parameters. "Limit" and "offset" indicate the range of items to be fetched.
-    * The maximum number of items per request is limited to 20.
-    * You can leave this params empty and by default it will return list of purchased items ranging from 0 to 20.
-    *
-    * **Example**:
-    * ```
-    * _smartico.api.getStorePurchasedItems().then((result) => {
-    *      console.log(result);
-    * });
-    * ```
-    *
-    * **Visitor mode: not supported**
-   */
+     * Returns purchased items based on the provided parameters. "Limit" and "offset" indicate the range of items to be fetched.
+     * The maximum number of items per request is limited to 20.
+     * You can leave this params empty and by default it will return list of purchased items ranging from 0 to 20.
+     *
+     * **Example**:
+     * ```
+     * _smartico.api.getStorePurchasedItems().then((result) => {
+     *      console.log(result);
+     * });
+     * ```
+     *
+     * **Visitor mode: not supported**
+     */
     getStorePurchasedItems({ limit, offset, onUpdate }?: {
         limit?: number;
         offset?: number;
@@ -188,23 +188,23 @@ export declare class WSAPI {
      * */
     getAchCategories(): Promise<TAchCategory[]>;
     /**
-    * Returns list of custom sections
-    *
-    * **Example**:
-    * ```
-    * _smartico.api.getCustomSections().then((result) => {
-    *      console.log(result);
-    * });
-    * ```
-    *
-    * **Example in the Visitor mode**:
-    * ```
-    * _smartico.vapi('EN').getCustomSections().then((result) => {
-    *      console.log(result);
-    * });
-    * ```
-    *
-    * */
+     * Returns list of custom sections
+     *
+     * **Example**:
+     * ```
+     * _smartico.api.getCustomSections().then((result) => {
+     *      console.log(result);
+     * });
+     * ```
+     *
+     * **Example in the Visitor mode**:
+     * ```
+     * _smartico.vapi('EN').getCustomSections().then((result) => {
+     *      console.log(result);
+     * });
+     * ```
+     *
+     * */
     getCustomSections(): Promise<TUICustomSection[]>;
     /**
      * Returns the list of mini-games available for user
@@ -233,19 +233,19 @@ export declare class WSAPI {
      * Plays the specified by template_id mini-game on behalf of user and returns prize_id or err_code
      *
      * **Visitor mode: not supported**
-    */
+     */
     playMiniGame(template_id: number): Promise<TMiniGamePlayResult>;
     /**
      * Requests an opt-in for the specified mission_id. Returns the err_code.
      *
      * **Visitor mode: not supported**
-    */
+     */
     requestMissionOptIn(mission_id: number): Promise<TMissionOptInResult>;
     /**
      * Request for claim reward for the specified mission id. Returns the err_code.
      *
      * **Visitor mode: not supported**
-    */
+     */
     requestMissionClaimReward(mission_id: number, ach_completed_id: number): Promise<TMissionClaimRewardResult>;
     /** Returns all the active instances of tournaments
      * The returned list is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getTournamentsList with a new onUpdate callback, the old one will be overwritten by the new one.
@@ -271,7 +271,7 @@ export declare class WSAPI {
     /**
      * Returns details information of specific tournament instance, the response will include tournament info and the leaderboard of players
      *
-    * **Example**:
+     * **Example**:
      * ```
      * _smartico.api.getTournamentsList().then((result) => {
      *      if (result.length > 0) {
@@ -298,7 +298,7 @@ export declare class WSAPI {
      * Requests registration for the specified tournament instance. Returns the err_code.
      *
      * **Visitor mode: not supported**
-    */
+     */
     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.
@@ -320,17 +320,17 @@ export declare class WSAPI {
      */
     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.
-    * This functions return list of messages without the body of the message.
-    * To get the body of the message you need to call getInboxMessageBody function and pass the message guid contained in each message of this request.
-    * All other action like mark as read, favorite, delete, etc. can be done using this message GUID.
-    * The "onUpdate" callback will be triggered when the user receives a new message. It will provide an updated list of messages, ranging from 0 to 20, to the onUpdate callback function.
-    *
-    * **Visitor mode: not supported**
-    *
-    * @param params
-    */
+     * 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.
+     * This functions return list of messages without the body of the message.
+     * To get the body of the message you need to call getInboxMessageBody function and pass the message guid contained in each message of this request.
+     * All other action like mark as read, favorite, delete, etc. can be done using this message GUID.
+     * The "onUpdate" callback will be triggered when the user receives a new message. It will provide an updated list of messages, ranging from 0 to 20, to the onUpdate callback function.
+     *
+     * **Visitor mode: not supported**
+     *
+     * @param params
+     */
     getInboxMessages({ from, to, onlyFavorite, onUpdate }?: {
         from?: number;
         to?: number;
@@ -339,9 +339,9 @@ export declare class WSAPI {
     }): Promise<TInboxMessage[]>;
     /**
      * Returns the message body of the specified message guid.
-    *
-    * **Visitor mode: not supported**
-    */
+     *
+     * **Visitor mode: not supported**
+     */
     getInboxMessageBody(messageGuid: string): Promise<TInboxMessageBody>;
     /**
      * Requests to mark inbox message with specified guid as read
@@ -353,7 +353,7 @@ export declare class WSAPI {
      * Requests to mark all inbox messages as rea
      *
      * **Visitor mode: not supported**
-    */
+     */
     markAllInboxMessagesAsRead(): Promise<InboxMarkMessageAction>;
     /**
      * Requests to mark inbox message with specified guid as favorite. Pass mark true to add message to favorite and false to remove.
@@ -375,7 +375,7 @@ export declare class WSAPI {
     deleteAllInboxMessages(): Promise<InboxMarkMessageAction>;
     /**
      * Requests translations for the given language. Returns the object including translation key/translation value pairs. All possible translation keys defined in the back office.
-    */
+     */
     getTranslations(lang_code: string): Promise<TGetTranslations>;
     private updateOnSpin;
     private updateOnAddSpin;
@@ -403,7 +403,7 @@ export declare class WSAPI {
      *      console.log(result);
      * });
      * ```
-    */
+     */
     jackpotGet(filter?: {
         related_game_id?: string;
         jp_template_id?: number;
@@ -421,7 +421,7 @@ export declare class WSAPI {
      *
      * **Visitor mode: not supported**
      *
-    */
+     */
     jackpotOptIn(filter: {
         jp_template_id: number;
     }): Promise<JackpotsOptinResponse>;
@@ -438,7 +438,7 @@ export declare class WSAPI {
      *
      * **Visitor mode: not supported**
      *
-    */
+     */
     jackpotOptOut(filter: {
         jp_template_id: number;
     }): Promise<JackpotsOptoutResponse>;

package/dist/WSAPI/WSAPITypes.d.ts

@@ -1,12 +1,12 @@
-import { BuyStoreItemErrorCode } from "../Store";
-import { MiniGamePrizeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWSpinErrorCode } from "../MiniGames";
-import { TournamentRegistrationError, TournamentRegistrationStatusName, TournamentRegistrationTypeName } from "../Tournaments";
-import { LeaderBoardPeriodType } from "../Leaderboard";
-import { AchCustomLayoutTheme, AchCustomSectionType, AchMissionsTabsOptions, AchOverviewMissionsFilter } from "../CustomSections";
+import { BuyStoreItemErrorCode } from '../Store';
+import { MiniGamePrizeTypeName, SAWBuyInTypeName, SAWGameTypeName, SAWSpinErrorCode } from '../MiniGames';
+import { TournamentRegistrationError, TournamentRegistrationStatusName, TournamentRegistrationTypeName } from '../Tournaments';
+import { LeaderBoardPeriodType } from '../Leaderboard';
+import { AchCustomLayoutTheme, AchCustomSectionType, AchMissionsTabsOptions, AchOverviewMissionsFilter } from '../CustomSections';
 type TRibbon = 'sale' | 'hot' | 'new' | 'vip' | string;
 /**
  * TMiniGamePrize describes the information of prize in the array of prizes in the TMiniGameTemplate
-*/
+ */
 export interface TMiniGamePrize {
     /** ID of the prize */
     id: number;
@@ -31,7 +31,7 @@ export interface TMiniGamePrize {
 }
 /**
  * TMiniGamePlayResult describes the response of call to _smartico.api.playMiniGame(template_id) method
-*/
+ */
 export interface TMiniGamePlayResult {
     /** Error code that represents outcome of the game play attempt. Game succeed to be played in case err_code is 0 */
     err_code: SAWSpinErrorCode;
@@ -42,7 +42,7 @@ export interface TMiniGamePlayResult {
 }
 /**
  * TMiniGameTemplate describes the information of mini-games available for the user
-*/
+ */
 export interface TMiniGameTemplate {
     /** ID of the mini-game template */
     id: number;
@@ -88,7 +88,7 @@ export interface TMiniGameTemplate {
  * The user object is returned by _smartico.api.getUserProfile() method.
  * If you want to track the changes of the user profile, you can subscribe to the callback in the following way
  *  _smartico.on('props_change', () => console.log(_smartico.api.getUserProfile()) );
-*/
+ */
 export interface TUserProfile {
     /** The language of the user */
     core_user_language: string;
@@ -101,7 +101,7 @@ export interface TUserProfile {
      * They can be treated as server-based cookies.
      * You can set tags using following method _smartico.event('core_public_tags_update', { core_public_tags: ['A', 'B'] } );
      * And then you can check for the tags
-    */
+     */
     core_public_tags: string[];
     /** The ID of the current level of the user */
     ach_level_current_id?: number;
@@ -138,14 +138,14 @@ export interface TLevel {
      * Relevant in case of using advanced leveling logic
      * https://help.smartico.ai/welcome/more/release-notes/september-2022#new-logic-for-leveling-users
      *
-    */
+     */
     required_level_counter_1: number;
     /**
      * The counter of 2nd metric used to reach the Level.
      * Relevant in case of using advanced leveling logic
      * https://help.smartico.ai/welcome/more/release-notes/september-2022#new-logic-for-leveling-users
      *
-    */
+     */
     required_level_counter_2: number;
     /** The custom data of the Level defined by operator in the BackOffice. Can be a JSON object, string or number */
     custom_data: string;
@@ -172,7 +172,7 @@ export interface TTournament {
     /**
      * 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;
@@ -312,7 +312,7 @@ export interface TStoreItem {
     /** URL of the image of the store item */
     image: string;
     /** Type of the store item. Can be 'bonus' or 'tangible' or different others. */
-    type: 'bonus' | 'tangible' | 'minigamespin' | 'changelevel' | 'prizedrop' | "unknown";
+    type: 'bonus' | 'tangible' | 'minigamespin' | 'changelevel' | 'prizedrop' | 'unknown';
     /** 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 */
@@ -329,7 +329,7 @@ export interface TStoreItem {
     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 retrieved with getStoreCategories method */
     category_ids: number[];
@@ -404,7 +404,7 @@ export interface TMissionOrBadge {
     /**
      * The ID of the custom section where the mission or badge is assigned
      * The list of custom sections can be retrieved using _smartico.api.getCustomSections() method (TODO-API)
-    */
+     */
     custom_section_id: number;
     /** The indicator if the mission or badge is visible only in the custom section and should be hidden from the main overview of missions/badges */
     only_in_custom_section: boolean;
@@ -481,7 +481,7 @@ export interface TMissionOrBadgeTask {
 }
 /**
  * TMissionOptInResult describes the response of call to _smartico.api.requestMissionOptIn(mission_id) method
-*/
+ */
 export interface TMissionOptInResult {
     /** Error code that represents outcome of the opt-in request. Successful opt-in in case err_code is 0 */
     err_code: number;
@@ -490,7 +490,7 @@ export interface TMissionOptInResult {
 }
 /**
  * TMissionClaimRewardResult describes the response of call to _smartico.api.requestMissionClaimReward(mission_id, ach_completed_id) method
-*/
+ */
 export interface TMissionClaimRewardResult {
     /** Error code that represents outcome of the claim request. Successful claim reward in case err_code is 0 */
     err_code: number;