@smartico/public-api 0.0.6 → 0.0.7

package/dist/Inbox/InboxMessage.d.ts

@@ -9,4 +9,6 @@ export interface InboxMessage {
         title: string;
         html_body: string;
     };
+    engagement_uuid: string;
+    ff: string;
 }

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/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

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

package/dist/index.js

@@ -733,6 +733,53 @@ exports.InboxMessageType = void 0;
 })(exports.InboxMessageType || (exports.InboxMessageType = {}));
 // keep in sync with BO enum
 
+exports.LeaderBoardPeriodType = void 0;
+(function (LeaderBoardPeriodType) {
+  LeaderBoardPeriodType[LeaderBoardPeriodType["DAILY"] = 1] = "DAILY";
+  LeaderBoardPeriodType[LeaderBoardPeriodType["WEEKLY"] = 2] = "WEEKLY";
+  LeaderBoardPeriodType[LeaderBoardPeriodType["MONTHLY"] = 3] = "MONTHLY";
+})(exports.LeaderBoardPeriodType || (exports.LeaderBoardPeriodType = {}));
+
+exports.AchievementStatus = void 0;
+(function (AchievementStatus) {
+  AchievementStatus[AchievementStatus["Draft"] = 1] = "Draft";
+  AchievementStatus[AchievementStatus["AvailableUnlocked"] = 2] = "AvailableUnlocked";
+  AchievementStatus[AchievementStatus["AvailableLocked"] = 3] = "AvailableLocked";
+  AchievementStatus[AchievementStatus["Archived"] = 4] = "Archived";
+  AchievementStatus[AchievementStatus["FeaturedManually"] = 5] = "FeaturedManually";
+  AchievementStatus[AchievementStatus["FeaturedAI"] = 6] = "FeaturedAI";
+})(exports.AchievementStatus || (exports.AchievementStatus = {}));
+
+exports.AchievementTaskType = void 0;
+(function (AchievementTaskType) {
+  AchievementTaskType[AchievementTaskType["CompleteAchievement"] = 1] = "CompleteAchievement";
+  AchievementTaskType[AchievementTaskType["UnlockAchievement"] = 2] = "UnlockAchievement";
+})(exports.AchievementTaskType || (exports.AchievementTaskType = {}));
+
+exports.AchievementType = void 0;
+(function (AchievementType) {
+  AchievementType[AchievementType["Mission"] = 1] = "Mission";
+  AchievementType[AchievementType["Badge"] = 2] = "Badge";
+})(exports.AchievementType || (exports.AchievementType = {}));
+
+exports.BuyShopItemErrorCode = void 0;
+(function (BuyShopItemErrorCode) {
+  BuyShopItemErrorCode[BuyShopItemErrorCode["FAILED_TO_BUY_SHOP_ITEM"] = 121] = "FAILED_TO_BUY_SHOP_ITEM";
+  BuyShopItemErrorCode[BuyShopItemErrorCode["SHOP_NO_BALANCE"] = 11000] = "SHOP_NO_BALANCE";
+  BuyShopItemErrorCode[BuyShopItemErrorCode["SHOP_WRONG_LABEL"] = 11001] = "SHOP_WRONG_LABEL";
+  BuyShopItemErrorCode[BuyShopItemErrorCode["SHOP_FAILED_TO_BUY_BONUS"] = 11002] = "SHOP_FAILED_TO_BUY_BONUS";
+  BuyShopItemErrorCode[BuyShopItemErrorCode["SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION"] = 11003] = "SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION";
+  BuyShopItemErrorCode[BuyShopItemErrorCode["SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION_PURSHASE"] = 11004] = "SHOP_FAILED_TO_BUY_SHOP_ITEM_CONDITION_PURSHASE";
+  BuyShopItemErrorCode[BuyShopItemErrorCode["SHOP_FAILED_TO_BUY_MATCHING_BONUS"] = 11005] = "SHOP_FAILED_TO_BUY_MATCHING_BONUS";
+  BuyShopItemErrorCode[BuyShopItemErrorCode["SHOP_FAILED_MAX_BOUGHT_ITEMS_REACHED"] = 11006] = "SHOP_FAILED_MAX_BOUGHT_ITEMS_REACHED";
+})(exports.BuyShopItemErrorCode || (exports.BuyShopItemErrorCode = {}));
+
+exports.ShopItemType = void 0;
+(function (ShopItemType) {
+  ShopItemType[ShopItemType["Bonus"] = 1] = "Bonus";
+  ShopItemType[ShopItemType["Manual"] = 2] = "Manual";
+})(exports.ShopItemType || (exports.ShopItemType = {}));
+
 exports.SAWBuyInTypeName = SAWBuyInTypeName;
 exports.SAWGameTypeName = SAWGameTypeName;
 exports.SAWUtils = SAWUtils;