@smartico/public-api 0.0.8 → 0.0.10

package/dist/Core/ActivityTypeLimited.d.ts

@@ -0,0 +1,7 @@
+export declare enum ActivityTypeLimited {
+    DoNothing = 8,
+    Points = 12,
+    Popup = 30,
+    Inbox = 31,
+    Bonus = 100
+}

package/dist/Core/index.d.ts

@@ -1,3 +1,4 @@
+import { ActivityTypeLimited } from './ActivityTypeLimited';
 import { GetLabelInfoRequest } from './GetLabelInfoRequest';
 import { GetLabelInfoResponse } from './GetLabelInfoResponse';
 import { GetTranslationsRequest } from './GetTranslationsRequest';
@@ -5,4 +6,4 @@ import { GetTranslationsResponse } from './GetTranslationsResponse';
 import { PublicLabelSettings } from './PublicLabelSettings';
 import { ResponseIdentify } from './ResponseIdentify';
 import { TranslationArea } from './TranslationArea';
-export { GetTranslationsRequest, GetTranslationsResponse, GetLabelInfoRequest, GetLabelInfoResponse, TranslationArea, PublicLabelSettings, ResponseIdentify };
+export { GetTranslationsRequest, GetTranslationsResponse, GetLabelInfoRequest, GetLabelInfoResponse, TranslationArea, PublicLabelSettings, ResponseIdentify, ActivityTypeLimited };

package/dist/SmarticoAPI.d.ts

@@ -1,25 +1,29 @@
 import { ClassId } from "./Base/ClassId";
 import { SAWGetTemplatesResponse } from './MiniGames/SAWGetTemplatesResponse';
-import { SAWTemplate } from './MiniGames/SAWTemplate';
 import { ILogger } from './ILogger';
 import { SAWDoSpinResponse } from './MiniGames';
 import { GetTranslationsResponse, ResponseIdentify, TranslationArea } from './Core';
 import { GetLabelInfoResponse } from './Core/GetLabelInfoResponse';
 import { GetInboxMessagesResponse } from './Inbox';
+import { GetStoreItemsResponse } from './Store';
+import { GetAchievementMapResponse } from './Missions';
+import { GetTournamentInfoResponse, GetTournamentsResponse } from './Tournaments';
 interface IOptions {
     logger?: ILogger;
     logCIDs?: ClassId[];
     logHTTPTiming?: boolean;
 }
+type MessageSender = (message: any, publicApuUrl: string) => Promise<any>;
 declare class SmarticoAPI {
     private label_api_key;
     private brand_api_key;
+    private messageSender;
     private publicUrl;
     private avatarDomain;
     private logger;
     private logCIDs;
     private logHTTPTiming;
-    constructor(label_api_key: string, brand_api_key: string, options?: IOptions);
+    constructor(label_api_key: string, brand_api_key: string, messageSender: MessageSender, options?: IOptions);
     private send;
     private buildMessage;
     coreReportCustomEvent(user_ext_id: string, eventType: string, payload?: any): Promise<any>;
@@ -30,8 +34,11 @@ declare class SmarticoAPI {
         public_username_custom: string;
     }>;
     sawGetTemplates(user_ext_id: string): Promise<SAWGetTemplatesResponse>;
-    sawFormatTemplatesForWidget(templates: SAWTemplate[], pointsBalance: number): Promise<any[]>;
     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>;
+    missionsGetItems(user_ext_id: string): Promise<GetAchievementMapResponse>;
+    tournamentsGetLobby(user_ext_id: string): Promise<GetTournamentsResponse>;
+    tournamentsGetInfo(user_ext_id: string, tournamentInstanceId: number): Promise<GetTournamentInfoResponse>;
 }
-export { SmarticoAPI };
+export { SmarticoAPI, MessageSender };

package/dist/Store/BuyStoreItemErrorCode.d.ts

@@ -0,0 +1,10 @@
+export declare enum BuyStoreItemErrorCode {
+    FAILED_TO_BUY_SHOP_ITEM = 121,
+    SHOP_NO_BALANCE = 11000,
+    SHOP_WRONG_LABEL = 11001,
+    SHOP_FAILED_TO_BUY_BONUS = 11002,
+    SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION = 11003,
+    SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION_PURSHASE = 11004,
+    SHOP_FAILED_TO_BUY_MATCHING_BONUS = 11005,
+    SHOP_FAILED_MAX_BOUGHT_ITEMS_REACHED = 11006
+}

package/dist/Store/BuyStoreItemRequest.d.ts

@@ -0,0 +1,4 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+export interface BuyStoreItemRequest extends ProtocolMessage {
+    itemId: number;
+}

package/dist/Store/BuyStoreItemResponse.d.ts

@@ -0,0 +1,4 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+export interface BuyStoreItemResponse extends ProtocolResponse {
+    success?: boolean;
+}

package/dist/Store/GetCategoriesStoreResponse.d.ts

@@ -0,0 +1,5 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { StoreCategory } from "./StoreCategory";
+export interface GetCategoriesStoreResponse extends ProtocolResponse {
+    categories: StoreCategory[];
+}

package/dist/Store/GetStoreItemsResponse.d.ts

@@ -0,0 +1,5 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { StoreItem } from "./StoreItem";
+export interface GetStoreItemsResponse extends ProtocolResponse {
+    items: StoreItem[];
+}

package/dist/Store/StoreCategory.d.ts

@@ -0,0 +1,5 @@
+import { StoreCategoryPublicMeta } from "./StoreCategoryPublicMeta";
+export interface StoreCategory {
+    id?: number;
+    publicMeta?: StoreCategoryPublicMeta;
+}

package/dist/Store/StoreCategoryPublicMeta.d.ts

@@ -0,0 +1,4 @@
+export interface StoreCategoryPublicMeta {
+    name?: string;
+    order?: number;
+}

package/dist/Store/StoreItem.d.ts

@@ -0,0 +1,9 @@
+import { StoreItemPublicMeta } from "./StoreItemPublicMeta";
+import { StoreItemType } from "./StoreItemType";
+export interface StoreItem {
+    id: number;
+    itemTypeId: StoreItemType;
+    itemPublicMeta: StoreItemPublicMeta;
+    categoryIds?: number[];
+    canBuy?: boolean;
+}

package/dist/Store/StoreItemPublicMeta.d.ts

@@ -0,0 +1,10 @@
+export interface StoreItemPublicMeta {
+    price: string;
+    image_url: string;
+    name: string;
+    description: string;
+    label_tag: string;
+    limit_message: string;
+    priority: number;
+    related_items: number[];
+}

package/dist/Store/StoreItemType.d.ts

@@ -0,0 +1,4 @@
+export declare enum StoreItemType {
+    Bonus = 1,
+    Manual = 2
+}

package/dist/Store/index.d.ts

@@ -1,11 +1,11 @@
-import { BuyShopItemErrorCode } from "./BuyShopItemErrorCode";
-import { BuyShopItemRequest } from "./BuyShopItemRequest";
-import { BuyShopItemResponse } from "./BuyShopItemResponse";
-import { GetCategoriesShopResponse } from "./GetCategoriesShopResponse";
-import { GetShopItemsResponse } from "./GetShopItemsResponse";
-import { ShopCategory } from "./ShopCategory";
-import { ShopCategoryPublicMeta } from "./ShopCategoryPublicMeta";
-import { ShopItem } from "./ShopItem";
-import { ShopItemPublicMeta } from "./ShopItemPublicMeta";
-import { ShopItemType } from "./ShopItemType";
-export { BuyShopItemErrorCode, BuyShopItemRequest, BuyShopItemResponse, GetCategoriesShopResponse, GetShopItemsResponse, ShopCategory, ShopCategoryPublicMeta, ShopItem, ShopItemPublicMeta, ShopItemType, };
+import { BuyStoreItemErrorCode } from "./BuyStoreItemErrorCode";
+import { BuyStoreItemRequest } from "./BuyStoreItemRequest";
+import { BuyStoreItemResponse } from "./BuyStoreItemResponse";
+import { GetCategoriesStoreResponse } from "./GetCategoriesStoreResponse";
+import { GetStoreItemsResponse } from "./GetStoreItemsResponse";
+import { StoreCategory } from "./StoreCategory";
+import { StoreCategoryPublicMeta } from "./StoreCategoryPublicMeta";
+import { StoreItem } from "./StoreItem";
+import { StoreItemPublicMeta } from "./StoreItemPublicMeta";
+import { StoreItemType } from "./StoreItemType";
+export { BuyStoreItemErrorCode, BuyStoreItemRequest, BuyStoreItemResponse, GetCategoriesStoreResponse, GetStoreItemsResponse, StoreCategory, StoreCategoryPublicMeta, StoreItem, StoreItemPublicMeta, StoreItemType, };

package/dist/Tournaments/GetTournamentInfoRequest.d.ts

@@ -0,0 +1,4 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+export interface GetTournamentInfoRequest extends ProtocolMessage {
+    tournamentInstanceId: number;
+}

package/dist/Tournaments/GetTournamentInfoResponse.d.ts

@@ -0,0 +1,20 @@
+import { Tournament } from "./Tournament";
+import { TournamentPlayer } from "./TournamentPlayer";
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { TournamentPrize } from "./TournamentPrize";
+export interface GetTournamentInfoResponse extends ProtocolResponse {
+    /** tournament info */
+    tournamentInfo: {
+        /** id of label, not in use */
+        labelId: number;
+        tournamentLobbyInfo: Tournament;
+        /** list of registered users */
+        players: TournamentPlayer[];
+    };
+    /** information about current user position */
+    userPosition: TournamentPlayer;
+    /** prizes structure */
+    prizeStructure?: {
+        prizes: TournamentPrize[];
+    };
+}

package/dist/Tournaments/GetTournamentsRequest.d.ts

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

package/dist/Tournaments/GetTournamentsResponse.d.ts

@@ -0,0 +1,6 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { Tournament } from "./Tournament";
+export interface GetTournamentsResponse extends ProtocolResponse {
+    /** array of the tournaments */
+    tournaments?: Tournament[];
+}

package/dist/Tournaments/Tournament.d.ts

@@ -0,0 +1,43 @@
+import { TournamentRegistrationType } from "./TournamentRegistrationType";
+import { TournamentInstanceStatus } from "./TournamentInstanceStatus";
+import { TournamentRegistrationStatus } from "./TournamentRegistrationStatus";
+import { TournamentType } from "./TournamentType";
+import { TournamentPublicMeta } from "./TournamentPublicMeta";
+export interface Tournament {
+    /** ID of tournament template */
+    tournamentId?: number;
+    /** ID of tournament instance. Generated every time when tournament based on specific template is scheduled for run */
+    tournamentInstanceId?: number;
+    /** Type of the tournament. For now only SCHEDULED is support */
+    tournamentType?: TournamentType;
+    /** Meta information about tournament that should be used to build UI */
+    publicMeta?: TournamentPublicMeta;
+    /** Cost of registration in the tournament in gamification points */
+    buyInAmount?: number;
+    /** Not in use */
+    prizePool?: number;
+    /** The time when tournament is going to start */
+    startTime?: string;
+    /** The time when tournament is going to finish */
+    endTime?: string;
+    /** Number of users registered in the tournament */
+    registrationCount?: number;
+    /** Not in use */
+    totalCount?: number;
+    /** Type of registration in the tournament */
+    registrationType?: TournamentRegistrationType;
+    /** Status of registration in the tournament for current user */
+    tournamentRegistrationStatus?: TournamentRegistrationStatus;
+    /** Status of tournament instance */
+    tournamentInstanceStatus?: TournamentInstanceStatus;
+    /** flag indicating if current user is registered in the tournament */
+    isUserRegistered?: boolean;
+    /** Indicator if tournament allows later registration, when tournament is already started */
+    allowLateRegistration?: boolean;
+    /** Minimum number of participant for this tournament. If tournament doesnt have enough registrations, it will not start */
+    playersMinCount?: number;
+    /** Maximum number of participant for this tournament. When reached, new users won't be able to register */
+    playersMaxCount?: number;
+    /** Tournament duration in millisecnnds */
+    durationMs?: number;
+}

package/dist/Tournaments/TournamentInstanceStatus.d.ts

@@ -0,0 +1,10 @@
+export declare enum TournamentInstanceStatus {
+    PUBLISHED = 1,
+    REGISTER = 2,
+    STARTED = 3,
+    FINISHED = 4,
+    CANCELLED = 5,
+    FAILED = 6,
+    FINALIZING = 7
+}
+export declare const TournamentInstanceStatusName: (s: TournamentInstanceStatus) => string;

package/dist/Tournaments/TournamentPlayer.d.ts

@@ -0,0 +1,9 @@
+export interface TournamentPlayer {
+    userAltName: string;
+    position: number;
+    scores: number;
+    isMe: boolean;
+    userId: number;
+    avatar_id: string;
+    avatar_url?: string;
+}

package/dist/Tournaments/TournamentPrize.d.ts

@@ -0,0 +1,10 @@
+import { ActivityTypeLimited } from "../Core/ActivityTypeLimited";
+export interface TournamentPrize {
+    name: string;
+    description: string;
+    image_url: string;
+    place_from: number;
+    place_to: number;
+    type: ActivityTypeLimited;
+    points: number;
+}

package/dist/Tournaments/TournamentPublicMeta.d.ts

@@ -0,0 +1,22 @@
+export interface TournamentPublicMeta {
+    /** Name of tournament */
+    name?: string;
+    /** 1st image */
+    image_url?: string;
+    /** 2nd image */
+    image_url2?: string;
+    /** Description, html capable */
+    description?: string;
+    /** Short explanation of prize pool */
+    prize_pool_short?: string;
+    /** Message to show when user is not matching to the segment allowed to register (error code 30005 in registration response) */
+    segment_dont_match_message?: string;
+    /** Short explanation of registration price */
+    custom_price_text?: string;
+    /** Indicator if the scores of other users should be shown in the leaderboard of tournament */
+    show_other_users_score?: boolean;
+    custom_section_id?: number;
+    only_in_custom_section?: boolean;
+    label_tag?: string;
+    featured?: boolean;
+}

package/dist/Tournaments/TournamentRegisterRequest.d.ts

@@ -0,0 +1,4 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+export interface TournamentRegisterRequest extends ProtocolMessage {
+    tournamentInstanceId: number;
+}

package/dist/Tournaments/TournamentRegisterResponse.d.ts

@@ -0,0 +1,5 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { TournamentRegistrationError } from "./TournamentRegistrationError";
+export interface TournamentRegisterResponse extends ProtocolResponse {
+    errCode?: TournamentRegistrationError;
+}

package/dist/Tournaments/TournamentRegistrationError.d.ts

@@ -0,0 +1,11 @@
+export declare enum TournamentRegistrationError {
+    NO_ERROR = 0,
+    TOURNAMENT_INSTANCE_NOT_FOUND = 30001,
+    TOURNAMENT_REGISTRATION_NOT_ENOUGH_POINTS = 30002,
+    TOURNAMENT_INSTANCE_NOT_IN_STATE = 30003,
+    TOURNAMENT_ALREADY_REGISTERED = 30004,
+    TOURNAMENT_USER_DONT_MATCH_CONDITIONS = 30005,
+    TOURNAMENT_USER_NOT_REGISTERED = 30006,
+    TOURNAMENT_CANT_CHANGE_REGISTRATION_STATUS = 30007,
+    TOURNAMENT_MAX_REGISTRATIONS_REACHED = 30008
+}

package/dist/Tournaments/TournamentRegistrationStatus.d.ts

@@ -0,0 +1,9 @@
+export declare enum TournamentRegistrationStatus {
+    NOT_REGISTERED = 0,
+    REGISTERED = 1,
+    FINISHED = 2,
+    PENDING = 3,
+    CANCELLED = 4,
+    REGISTERED_PENDING_QUALIFICATION = 5,
+    QUALIFIED_PENDING_REGISTRATION = 6
+}

package/dist/Tournaments/TournamentRegistrationType.d.ts

@@ -0,0 +1,7 @@
+export declare enum TournamentRegistrationType {
+    AUTO = 1,
+    OPT_IN = 2,
+    BUY_IN_POINTS = 3,
+    MANUAL_APPROVAL = 4,
+    REQUIRES_QUALIFICATION = 5
+}

package/dist/Tournaments/TournamentType.d.ts

@@ -0,0 +1,5 @@
+export declare enum TournamentType {
+    SCHEDULED = 1,
+    SNG = 2,
+    TEST = 3
+}

package/dist/Tournaments/index.d.ts

@@ -0,0 +1,16 @@
+import { GetTournamentInfoRequest } from "./GetTournamentInfoRequest";
+import { GetTournamentInfoResponse } from "./GetTournamentInfoResponse";
+import { GetTournamentsRequest } from "./GetTournamentsRequest";
+import { GetTournamentsResponse } from "./GetTournamentsResponse";
+import { Tournament } from "./Tournament";
+import { TournamentInstanceStatus } from "./TournamentInstanceStatus";
+import { TournamentPlayer } from "./TournamentPlayer";
+import { TournamentPrize } from "./TournamentPrize";
+import { TournamentPublicMeta } from "./TournamentPublicMeta";
+import { TournamentRegisterRequest } from "./TournamentRegisterRequest";
+import { TournamentRegisterResponse } from "./TournamentRegisterResponse";
+import { TournamentRegistrationError } from "./TournamentRegistrationError";
+import { TournamentRegistrationStatus } from "./TournamentRegistrationStatus";
+import { TournamentRegistrationType } from "./TournamentRegistrationType";
+import { TournamentType } from "./TournamentType";
+export { GetTournamentInfoRequest, GetTournamentInfoResponse, GetTournamentsRequest, GetTournamentsResponse, Tournament, TournamentInstanceStatus, TournamentPlayer, TournamentPrize, TournamentPublicMeta, TournamentRegisterRequest, TournamentRegisterResponse, TournamentRegistrationError, TournamentRegistrationStatus, TournamentRegistrationType, TournamentType, };

package/dist/index.d.ts

@@ -1,10 +1,11 @@
 import { ClassId } from './Base/ClassId';
 import { ILogger } from './ILogger';
-import { SmarticoAPI } from './SmarticoAPI';
+import { MessageSender, SmarticoAPI } from './SmarticoAPI';
 export * from './Core';
 export * from './Inbox';
 export * from './Leaderboard';
 export * from './MiniGames';
 export * from './Missions';
 export * from './Store';
-export { SmarticoAPI, ClassId, ILogger };
+export * from './Tournaments';
+export { SmarticoAPI, MessageSender, ClassId, ILogger };