@smartico/public-api 0.0.5 → 0.0.7

package/dist/Base/ClassId.d.ts

@@ -1,14 +1,60 @@
 export declare enum ClassId {
-    GET_LABEL_INFO = 3,
-    GET_LABEL_INFO_RESPONSE = 4,
+    INIT = 3,
+    INIT_RESPONSE = 4,
     IDENTIFY = 5,
     IDENTIFY_RESPONSE = 6,
+    LOGIN = 7,
+    LOGOUT = 8,
     EVENT = 9,
     EVENT_RESPONSE = 10,
+    LOGIN_RESPONSE = 11,
+    LOGOUT_RESPONSE = 12,
     GET_TRANSLATIONS_REQUEST = 13,
     GET_TRANSLATIONS_RESPONSE = 14,
-    CHANGE_USERNAME = 159,
-    CHANGE_USERNAME_RESPONSE = 160,
+    CLIENT_ENGAGEMENT_IMPRESSION_REQUEST = 103,
+    CLIENT_ENGAGEMENT_ACTION_REQUEST = 104,
+    CLIENT_EXECUTE_DEEPLINK_EVENT = 105,
+    CLIENT_ENGAGEMENT_FAILED_REQUEST = 106,
+    CLIENT_EXECUTE_JS_EVENT = 107,
+    CLIENT_PUBLIC_PROPERTIES_CHANGED_EVENT = 108,
+    CLIENT_ENGAGEMENT_EVENT_NEW = 110,
+    CLIENT_SET_AVATAR_REQUEST = 157,
+    CLIENT_SET_AVATAR_RESPONSE = 158,
+    CLIENT_SET_CUSTOM_USERNAME_REQUEST = 159,
+    CLIENT_SET_CUSTOM_USERNAME_RESPONSE = 160,
+    GET_LEVEL_MAP_REQUEST = 500,
+    GET_LEVEL_MAP_RESPONSE = 501,
+    GET_ACHIEVEMENT_MAP_REQUEST = 502,
+    GET_ACHIEVEMENT_MAP_RESPONSE = 503,
+    RELOAD_ACHIEVEMENTS_EVENT = 504,
+    GET_LEADERS_BOARD_REQUEST = 505,
+    GET_LEADERS_BOARD_RESPONSE = 506,
+    GET_ACTIVITY_LOG_REQUEST = 507,
+    GET_ACTIVITY_LOG_RESPONSE = 508,
+    GET_SHOP_ITEMS_REQUEST = 509,
+    GET_SHOP_ITEMS_RESPONSE = 510,
+    BUY_SHOP_ITEM_REQUEST = 511,
+    BUY_SHOP_ITEM_RESPONSE = 512,
+    GET_INBOX_MESSAGES_REQUEST = 513,
+    GET_INBOX_MESSAGES_RESPONSE = 514,
+    GET_SHOP_CATEGORIES_REQUEST = 515,
+    GET_SHOP_CATEGORIES_RESPONSE = 516,
+    GET_TOURNAMENT_LOBBY_REQUEST = 517,
+    GET_TOURNAMENT_LOBBY_RESPONSE = 518,
+    GET_TOURNAMENT_INFO_REQUEST = 519,
+    GET_TOURNAMENT_INFO_RESPONSE = 520,
+    TOURNAMENT_REGISTER_REQUEST = 521,
+    TOURNAMENT_REGISTER_RESPONSE = 522,
+    GET_CUSTOM_SECTIONS_REQUEST = 523,
+    GET_CUSTOM_SECTIONS_RESPONSE = 524,
+    MISSION_OPTIN_REQUEST = 525,
+    MISSION_OPTIN_RESPONSE = 526,
+    GET_ACHIEVEMENT_USER_REQUEST = 527,
+    GET_ACHIEVEMENT_USER_RESPONSE = 528,
+    GET_BONUSES_REQUEST = 600,
+    GET_BONUSES_RESPONSE = 601,
+    CLAIM_BONUS_REQUEST = 602,
+    CLAIM_BONUS_RESPONSE = 603,
     SAW_GET_SPINS_REQUEST = 700,
     SAW_GET_SPINS_RESPONSE = 701,
     SAW_DO_SPIN_REQUEST = 702,
@@ -17,5 +63,8 @@ export declare enum ClassId {
     SAW_AKNOWLEDGE_RESPONSE = 705,
     SAW_SPINS_COUNT_PUSH = 706,
     SAW_SHOW_SPIN_PUSH = 707,
+    REGISTER_PUSH_NOTIFICATIONS_TOKEN_REQ = 1003,
+    REGISTER_PUSH_NOTIFICATIONS_TOKEN_RESP = 2003,
+    CLIENT_DEBUG_REQUEST = 77777,
     UNSUPPORTED_COMMAND = 99999
 }

package/dist/Inbox/GetInboxMessagesRequest.d.ts

@@ -0,0 +1,5 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+export interface GetInboxMessagesRequest extends ProtocolMessage {
+    limit?: number;
+    offset?: number;
+}

package/dist/Inbox/GetInboxMessagesResponse.d.ts

@@ -0,0 +1,5 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { InboxMessage } from "./InboxMessage";
+export interface GetInboxMessagesResponse extends ProtocolResponse {
+    log: InboxMessage[];
+}

package/dist/Inbox/InboxMessage.d.ts

@@ -0,0 +1,14 @@
+import { InboxMessageType } from "./InboxMessageType";
+export interface InboxMessage {
+    createDate: string;
+    body: {
+        action: string;
+        body: string;
+        type: InboxMessageType;
+        image: string;
+        title: string;
+        html_body: string;
+    };
+    engagement_uuid: string;
+    ff: string;
+}

package/dist/Inbox/InboxMessageType.d.ts

@@ -0,0 +1,11 @@
+export declare enum InboxMessageType {
+    Custom = 0,
+    MissionCompleted = 1,
+    MissionUnlocked = 2,
+    LeaderboardWon = 3,
+    LevelChanged = 4,
+    BonusGiven = 5,
+    PointsAdded = 6,
+    PointsUsed = 7,
+    PersonalMessage = 8
+}

package/dist/Inbox/index.d.ts

@@ -0,0 +1,5 @@
+import { GetInboxMessagesRequest } from "./GetInboxMessagesRequest";
+import { GetInboxMessagesResponse } from "./GetInboxMessagesResponse";
+import { InboxMessage } from "./InboxMessage";
+import { InboxMessageType } from "./InboxMessageType";
+export { InboxMessage, InboxMessageType, GetInboxMessagesRequest, GetInboxMessagesResponse, };

package/dist/Leaderboard/GetLeaderBoardsRequest.d.ts

@@ -0,0 +1,7 @@
+import { ProtocolMessage } from "../Base/ProtocolMessage";
+import { LeaderBoardPeriodType } from "./LeaderBoardPeriodType";
+export interface GetLeaderBoardsRequest extends ProtocolMessage {
+    period_type_id?: LeaderBoardPeriodType;
+    snapshot_offset?: number;
+    include_users?: boolean;
+}

package/dist/Leaderboard/GetLeaderBoardsResponse.d.ts

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

package/dist/Leaderboard/LeaderBoardDetails.d.ts

@@ -0,0 +1,13 @@
+import { LeaderBoardPeriodType } from "./LeaderBoardPeriodType";
+import { LeaderBoardPosition } from "./LeaderBoardPosition";
+import { LeaderBoardPublicMeta } from "./LeaderBoardPublicMeta";
+export interface LeaderBoardDetails {
+    board_id: number;
+    period_type_id: LeaderBoardPeriodType;
+    create_date?: number;
+    versiod_id: number;
+    reward_points: number[];
+    board_public_meta: LeaderBoardPublicMeta;
+    positions: LeaderBoardPosition[];
+    userPosition: LeaderBoardPosition;
+}

package/dist/Leaderboard/LeaderBoardPeriodType.d.ts

@@ -0,0 +1,5 @@
+export declare enum LeaderBoardPeriodType {
+    DAILY = 1,
+    WEEKLY = 2,
+    MONTHLY = 3
+}

package/dist/Leaderboard/LeaderBoardPosition.d.ts

@@ -0,0 +1,10 @@
+export interface LeaderBoardPosition {
+    public_username?: string;
+    user_alt_name: string;
+    position_in_board: number;
+    points_accumulated: number;
+    is_me: boolean;
+    level_id: number;
+    avatar_id: string;
+    avatar_url?: string;
+}

package/dist/Leaderboard/LeaderBoardPublicMeta.d.ts

@@ -0,0 +1,5 @@
+export interface LeaderBoardPublicMeta {
+    name: string;
+    description: string;
+    rules: string;
+}

package/dist/Leaderboard/index.d.ts

@@ -0,0 +1,7 @@
+import { GetLeaderBoardsRequest } from "./GetLeaderBoardsRequest";
+import { GetLeaderBoardsResponse } from "./GetLeaderBoardsResponse";
+import { LeaderBoardDetails } from "./LeaderBoardDetails";
+import { LeaderBoardPeriodType } from "./LeaderBoardPeriodType";
+import { LeaderBoardPosition } from "./LeaderBoardPosition";
+import { LeaderBoardPublicMeta } from "./LeaderBoardPublicMeta";
+export { GetLeaderBoardsRequest, GetLeaderBoardsResponse, LeaderBoardDetails, LeaderBoardPeriodType, LeaderBoardPosition, LeaderBoardPublicMeta, };

package/dist/Missions/AchievementOptinRequest.d.ts

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

package/dist/Missions/AchievementOptinResponse.d.ts

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

package/dist/Missions/AchievementPublicMeta.d.ts

@@ -0,0 +1,15 @@
+export interface AchievementPublicMeta {
+    description?: string;
+    unlock_mission_description?: string;
+    cta_text?: string;
+    cta_action?: string;
+    label_tag?: string;
+    reward?: string;
+    image_url?: string;
+    name?: string;
+    position?: number;
+    hide_tasks?: boolean;
+    hide_locked_mission?: boolean;
+    custom_section_id?: number;
+    only_in_custom_section?: boolean;
+}

package/dist/Missions/AchievementStatus.d.ts

@@ -0,0 +1,8 @@
+export declare enum AchievementStatus {
+    Draft = 1,
+    AvailableUnlocked = 2,
+    AvailableLocked = 3,
+    Archived = 4,
+    FeaturedManually = 5,
+    FeaturedAI = 6
+}

package/dist/Missions/AchievementTaskPublicMeta.d.ts

@@ -0,0 +1,3 @@
+export interface AchievementTaskPublicMeta {
+    name?: string;
+}

package/dist/Missions/AchievementTaskType.d.ts

@@ -0,0 +1,4 @@
+export declare enum AchievementTaskType {
+    CompleteAchievement = 1,
+    UnlockAchievement = 2
+}

package/dist/Missions/AchievementType.d.ts

@@ -0,0 +1,4 @@
+export declare enum AchievementType {
+    Mission = 1,
+    Badge = 2
+}

package/dist/Missions/GetAchievementMapRequest.d.ts

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

package/dist/Missions/GetAchievementMapResponse.d.ts

@@ -0,0 +1,5 @@
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { UserAchievement } from "./UserAchievement";
+export interface GetAchievementMapResponse extends ProtocolResponse {
+    achievements?: UserAchievement[];
+}

package/dist/Missions/ReloadAchievementsEvent.d.ts

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

package/dist/Missions/UserAchievement.d.ts

@@ -0,0 +1,21 @@
+import { AchievementPublicMeta } from "./AchievementPublicMeta";
+import { AchievementStatus } from "./AchievementStatus";
+import { AchievementType } from "./AchievementType";
+import { UserAchievementTask } from "./UserAchievementTask";
+export interface UserAchievement {
+    ach_id?: number;
+    ach_type_id?: AchievementType;
+    ach_public_meta?: AchievementPublicMeta;
+    isCompleted?: boolean;
+    isLocked?: boolean;
+    requiresOptin?: boolean;
+    isOptedIn?: boolean;
+    start_date?: string;
+    time_limit_ms?: number;
+    progress?: number;
+    complete_date?: string;
+    unlock_date?: string;
+    completed_tasks?: number;
+    achievementTasks?: UserAchievementTask[];
+    ach_status_id?: AchievementStatus;
+}

package/dist/Missions/UserAchievementTask.d.ts

@@ -0,0 +1,14 @@
+import { AchievementTaskPublicMeta } from "./AchievementTaskPublicMeta";
+import { AchievementTaskType } from "./AchievementTaskType";
+export interface UserAchievementTask {
+    task_id?: number;
+    task_public_meta?: AchievementTaskPublicMeta;
+    points_reward?: number;
+    task_type_id: AchievementTaskType;
+    isCompleted?: boolean;
+    userExecutedCount?: number;
+    userProgress?: number;
+    lastExecutionDate: string;
+    unlocked_by_mission_id?: number;
+    unlocked_by_level_id?: number;
+}

package/dist/Missions/index.d.ts

@@ -0,0 +1,13 @@
+import { AchievementOptinRequest } from "./AchievementOptinRequest";
+import { AchievementOptinResponse } from "./AchievementOptinResponse";
+import { AchievementPublicMeta } from "./AchievementPublicMeta";
+import { AchievementStatus } from "./AchievementStatus";
+import { AchievementTaskPublicMeta } from "./AchievementTaskPublicMeta";
+import { AchievementTaskType } from "./AchievementTaskType";
+import { AchievementType } from "./AchievementType";
+import { GetAchievementMapRequest } from "./GetAchievementMapRequest";
+import { GetAchievementMapResponse } from "./GetAchievementMapResponse";
+import { ReloadAchievementsEvent } from "./ReloadAchievementsEvent";
+import { UserAchievement } from "./UserAchievement";
+import { UserAchievementTask } from "./UserAchievementTask";
+export { AchievementOptinRequest, AchievementOptinResponse, AchievementPublicMeta, AchievementStatus, AchievementTaskPublicMeta, AchievementTaskType, AchievementType, GetAchievementMapRequest, GetAchievementMapResponse, ReloadAchievementsEvent, UserAchievement, UserAchievementTask, };

package/dist/NodeCache.d.ts

@@ -0,0 +1,9 @@
+declare class NodeCache {
+    private static ttlChecker;
+    private static cache;
+    constructor();
+    get(key: string): any;
+    set(key: string, value: any, ttlSeconds?: number): void;
+    flushAll(): void;
+}
+export { NodeCache };

package/dist/SmarticoAPI.d.ts

@@ -5,6 +5,7 @@ import { ILogger } from './ILogger';
 import { SAWDoSpinResponse } from './MiniGames';
 import { GetTranslationsResponse, ResponseIdentify, TranslationArea } from './Core';
 import { GetLabelInfoResponse } from './Core/GetLabelInfoResponse';
+import { GetInboxMessagesResponse } from './Inbox';
 interface IOptions {
     logger?: ILogger;
     logCIDs?: ClassId[];
@@ -31,5 +32,6 @@ declare class SmarticoAPI {
     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>;
 }
 export { SmarticoAPI };

package/dist/Store/BuyShopItemErrorCode.d.ts

@@ -0,0 +1,10 @@
+export declare enum BuyShopItemErrorCode {
+    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/BuyShopItemRequest.d.ts

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

package/dist/Store/BuyShopItemResponse.d.ts

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

package/dist/Store/GetCategoriesShopResponse.d.ts

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

package/dist/Store/GetShopItemsResponse.d.ts

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

package/dist/Store/ShopCategory.d.ts

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

package/dist/Store/ShopCategoryPublicMeta.d.ts

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

package/dist/Store/ShopItem.d.ts

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

package/dist/Store/ShopItemPublicMeta.d.ts

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

package/dist/Store/ShopItemType.d.ts

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

package/dist/Store/index.d.ts

@@ -0,0 +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, };

package/dist/index.d.ts

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