@smartico/public-api 0.0.142 → 0.0.144

package/README.md

@@ -13,7 +13,7 @@ and for terms of API usage
 
 To use the API you need the smartico.js library installed and initialized on your site according to this guide https://help.smartico.ai/welcome/technical-guides/front-end-integration
 
-As soon as the _smartico object is available in the global context and the user is identified, you can call API methods to get the data or act on behalf of the logged-in user.
+As soon as the **_smartico** object is available in the global context of the browser window and the user is identified, you can call API methods to get the data or act on behalf of the logged-in user.
 
 ```javascript
 
@@ -40,6 +40,19 @@ _smartico.api.getMiniGames( { onUpdate: miniGamesUpdates} ).then( games => {
 
 See the [API documentation](docs/classes/WSAPI.md) for all available methods and returning data.
 
+## Visitor mode
+
+You can also get gamification data for the visitors (not authorized users). 
+
+Calls to the methods look similar, with the only exception that you need to use **_smartico.vapi('EN')** method in order to get access to the Visitor API object with specific language.
+
+```javascript
+
+_smartico.vapi('EN').getLevels().then( levels => {
+    console.log('There are ' + levels.length + ' levels available');
+});
+
+```
 
 ## Backend usage (NodeJS context)
 

package/dist/CustomSections/AchCustomSection.d.ts

@@ -0,0 +1,27 @@
+export declare enum AchCustomSectionType {
+    HTML_PAGE = 1,
+    MISSIONS_CATEGORY = 2,
+    TOURNAMENTS_CATEGORY = 3,
+    LEVELS = 4,
+    MINI_GAMES = 5,
+    MISSION_CUSTOM_LAYOUT = 6,
+    MATCH_X = 7
+}
+export declare enum AchCustomLayoutTheme {
+    VALENTINES_LIGHT = "valentines-light",
+    VALENTINES_DARK = "valentines-dark",
+    EURO_2024 = "euro-2024",
+    GENERIC = "generic"
+}
+export declare enum AchMissionsTabsOptions {
+    ONLY_OVERVIEW = 1,
+    NO_OVERVIEW = 2,
+    ALL = 3
+}
+export declare enum AchOverviewMissionsFilter {
+    ANY = 1,
+    ALL_MISSIONS = 2,
+    ALL_EXCEPT_COMPLETED = 3,
+    ALL_EXCEPT_LOCKED = 4,
+    ALL_EXCEPT_COMPLETED_AND_LOCKED = 5
+}

package/dist/CustomSections/GetCustomSectionsRequest.d.ts

@@ -0,0 +1,3 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+export interface GetCustomSectionsRequest extends ProtocolMessage {
+}

package/dist/CustomSections/GetCustomSectionsResponse.d.ts

@@ -0,0 +1,7 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { UICustomSection } from "./UICustomSection";
+export interface GetCustomSectionsResponse extends ProtocolResponse {
+    customSections: {
+        [key: string]: UICustomSection;
+    };
+}

package/dist/CustomSections/UICustomSection.d.ts

@@ -0,0 +1,15 @@
+import { TUICustomSection } from "../WSAPI/WSAPITypes";
+import { AchCustomLayoutTheme, AchCustomSectionType, AchMissionsTabsOptions, AchOverviewMissionsFilter } from "./AchCustomSection";
+export interface UICustomSection {
+    body?: string;
+    menu_img?: string;
+    menu_name?: string;
+    custom_skin_images?: string;
+    section_type_id?: AchCustomSectionType;
+    theme?: AchCustomLayoutTheme;
+    generic_custom_css?: string;
+    mission_tabs_options?: AchMissionsTabsOptions;
+    overview_missions_filter?: AchOverviewMissionsFilter;
+    overview_missions_count?: number;
+}
+export declare const UICustomSectionTransform: (items: UICustomSection[]) => TUICustomSection[];

package/dist/CustomSections/index.d.ts

@@ -0,0 +1,4 @@
+export * from './AchCustomSection';
+export * from './UICustomSection';
+export * from './GetCustomSectionsRequest';
+export * from './GetCustomSectionsResponse';

package/dist/Missions/AchievementPublicMeta.d.ts

@@ -17,4 +17,5 @@ export interface AchievementPublicMeta {
     hint_text?: string;
     hide_badge_from_ui?: boolean;
     show_badge_first_task_completed?: boolean;
+    custom_section_type_id?: number;
 }

package/dist/Missions/UserAchievement.d.ts

@@ -34,5 +34,6 @@ export interface UserAchievement {
     completed_today?: boolean;
     completed_this_week?: boolean;
     completed_this_month?: boolean;
+    custom_section_type_id?: number;
 }
 export declare const UserAchievementTransform: (items: UserAchievement[]) => TMissionOrBadge[];

package/dist/Quiz/MarketsAnswers.d.ts

@@ -0,0 +1,38 @@
+export declare enum QuizAnswersValueType {
+    HomeTeam = "1",
+    AwayTeam = "2",
+    Draw = "x",
+    HomeTeamHomeTeam = "1/1",
+    HomeTeamDraw = "1/x",
+    HomeTeamAwayTeam = "1/2",
+    DrawHomeTeam = "x/1",
+    DrawDraw = "x/x",
+    DrawAwayTeam = "x/2",
+    AwayTeamHomeTeam = "2/1",
+    AwayTeamDraw = "2/x",
+    AwayTeamAwayTeam = "2/2",
+    Yes = "yes",
+    No = "no",
+    Odd = "odd",
+    Even = "even",
+    HomeOdd = "1/odd",
+    HomeEven = "1/even",
+    AwayOdd = "2/odd",
+    AwayEven = "2/even"
+}
+export declare const quizAnswerHomeTeamReplacementText = "{quiz_home_team}";
+export declare const quizAnswerAwayTeamReplacementText = "{quiz_away_team}";
+export declare const quizDrawReplacementText = "{quiz_draw}";
+export declare const quizYesReplacementText = "{yes}";
+export declare const quizNoReplacementText = "{no}";
+export declare const quizOddReplacementText = "{odd}";
+export declare const quizEvenReplacementText = "{even}";
+export declare const quizOrReplacementText = "{or}";
+export declare const quizAnswersTrKeys: {
+    "{quiz_draw}": string;
+    "{yes}": string;
+    "{no}": string;
+    "{odd}": string;
+    "{even}": string;
+    "{or}": string;
+};

package/dist/Quiz/MarketsInfo.d.ts

@@ -1,15 +1,7 @@
-import { MarketsValueType } from "./MarketsAnswersType";
-import { QuizMarketType } from "./MarketsType";
-export declare const quizAnswerHomeTeamReplacementText = "{quiz_home_team}";
-export declare const quizAnswerAwayTeamReplacementText = "{quiz_away_team}";
-export declare const quizDrawReplacementText = "{quiz_draw}";
-export declare const quizYesReplacementText = "{yes}";
-export declare const quizNoReplacementText = "{no}";
-export declare const quizOddReplacementText = "{odd}";
-export declare const quizEvenReplacementText = "{even}";
-export declare const quizOrReplacementText = "{or}";
+import { QuizAnswersValueType } from "./MarketsAnswers";
+import { SAWGPMarketType } from "./MarketsType";
 export declare const marketsInfo: {
-    type: QuizMarketType;
+    type: SAWGPMarketType;
     name: string;
     question: {
         text: string;
@@ -17,6 +9,6 @@ export declare const marketsInfo: {
     };
     answers: {
         text: string;
-        value: MarketsValueType;
+        value: QuizAnswersValueType;
     }[];
 }[];

package/dist/Quiz/MarketsPerSport.d.ts

@@ -1,6 +1,6 @@
-import { QuizMarketType } from "./MarketsType";
+import { SAWGPMarketType } from "./MarketsType";
 export declare const QuizMarketPerSport: {
-    6: QuizMarketType[];
-    1: QuizMarketType[];
-    5: QuizMarketType[];
+    6: SAWGPMarketType[];
+    1: SAWGPMarketType[];
+    5: SAWGPMarketType[];
 };

package/dist/Quiz/MarketsType.d.ts

@@ -1,4 +1,4 @@
-export declare enum QuizMarketType {
+export declare enum SAWGPMarketType {
     TwoTeamsWithScore = 1,
     RedCard = 2,
     OneXTwo = 3,

package/dist/Quiz/index.d.ts

@@ -3,4 +3,4 @@ export * from './MarketsType';
 export * from './ScoreResultTypes';
 export * from './MarketsInfo';
 export * from './MarketsPerSport';
-export * from './MarketsAnswersType';
+export * from './MarketsAnswers';

package/dist/SmarticoAPI.d.ts

@@ -11,9 +11,10 @@ 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, LeaderBoardDetailsT, UserLevelExtraCountersT, TSegmentCheckResult } from "./WSAPI/WSAPITypes";
+import { TInboxMessage, TInboxMessageBody, TLevel, TMiniGameTemplate, TMissionOrBadge, TStoreCategory, TAchCategory, TStoreItem, TTournament, TTournamentDetailed, LeaderBoardDetailsT, UserLevelExtraCountersT, TSegmentCheckResult, TUICustomSection } from "./WSAPI/WSAPITypes";
 import { GetAchievementsUserInfoResponse } from "./Core/GetAchievementsUserInfoResponse";
 import { GetJackpotsPotsResponse, GetJackpotsResponse, JackpotsOptinResponse, JackpotsOptoutResponse } from "./Jackpots";
+import { GetCustomSectionsResponse } from "./CustomSections";
 interface Tracker {
     label_api_key: string;
     userPublicProps: any;
@@ -101,6 +102,8 @@ declare class SmarticoAPI {
     leaderboardsGetT(user_ext_id: string, period_type_id?: LeaderBoardPeriodType, prevPeriod?: boolean): Promise<LeaderBoardDetailsT>;
     levelsGet(user_ext_id: string, force_language?: string): Promise<GetLevelMapResponse>;
     levelsGetT(user_ext_id: string): Promise<TLevel[]>;
+    getCustomSections(user_ext_id: string): Promise<GetCustomSectionsResponse>;
+    getCustomSectionsT(user_ext_id: string): Promise<TUICustomSection[]>;
     getTranslationsT(user_ext_id: string, lang_code: string, areas: TranslationArea[], cacheSec?: number): Promise<GetTranslationsResponse>;
     getInboxMessages(user_ext_id: string, limit: number, offset: number, starred_only: boolean): Promise<GetInboxMessagesResponse>;
     getInboxMessagesT(user_ext_id: string, from?: number, to?: number, favoriteOnly?: boolean): Promise<TInboxMessage[]>;

package/dist/WSAPI/WSAPI.d.ts

@@ -1,5 +1,5 @@
 import { SmarticoAPI } from "../SmarticoAPI";
-import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionClaimRewardResult, TMissionOptInResult, TMissionOrBadge, TSegmentCheckResult, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUserProfile, UserLevelExtraCountersT } 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 } from "./WSAPITypes";
 import { LeaderBoardPeriodType } from "../Leaderboard";
 import { JackpotDetails, JackpotsOptinResponse, JackpotsOptoutResponse } from "../Jackpots";
 /** @group General API */
@@ -116,6 +116,7 @@ export declare class WSAPI {
      * _smartico.vapi('EN').getStoreItems().then((result) => {
      *      console.log(result);
      * });
+     * ```
     */
     getStoreItems(): Promise<TStoreItem[]>;
     /** Buy the specific shop item by item_id. Returns the err_code in case of success or error.
@@ -145,6 +146,7 @@ export declare class WSAPI {
      * _smartico.vapi('EN').getStoreCategories().then((result) => {
      *      console.log(result);
      * });
+     * ```
      */
     getStoreCategories(): Promise<TStoreCategory[]>;
     /**
@@ -185,6 +187,25 @@ 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);
+    * });
+    * ```
+    *
+    * */
+    getCustomSections(): Promise<TUICustomSection[]>;
     /**
      * Returns the list of mini-games available for user
      * The returned list of mini-games is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getMiniGames with a new onUpdate callback, the old one will be overwritten by the new one.

package/dist/WSAPI/WSAPITypes.d.ts

@@ -2,6 +2,7 @@ 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
@@ -434,6 +435,8 @@ export interface TMissionOrBadge {
     completed_this_week?: boolean;
     /** Flag for mission/badge indicating that mission/badge completed this month */
     completed_this_month?: boolean;
+    /** ID of specific Custom Section type */
+    custom_section_type_id?: number;
 }
 export interface AchRelatedGame {
     /** The ID of the related game */
@@ -586,4 +589,26 @@ export interface TSegmentCheckResult {
     segment_id: number;
     is_matching: boolean;
 }
+export interface TUICustomSection {
+    /** The body of the custom section */
+    body?: string;
+    /** The image of the custom section */
+    menu_img?: string;
+    /** The name of the custom section */
+    menu_name?: string;
+    /** Custom images for custom section */
+    custom_skin_images?: string;
+    /** The particular type of custom section, can be Missions, Tournaments, Lootbox and etc */
+    section_type_id?: AchCustomSectionType;
+    /** Theme of the custom section */
+    theme?: AchCustomLayoutTheme;
+    /** Custom css for the custom section */
+    generic_custom_css?: string;
+    /** Tabs that can be shown in custom section, e.g Overview, No Overview, All tabs */
+    mission_tabs_options?: AchMissionsTabsOptions;
+    /** Filter that allow to show missions by criteria */
+    overview_missions_filter?: AchOverviewMissionsFilter;
+    /** Quantity of missions to be shown in overview */
+    overview_missions_count?: number;
+}
 export {};