@smartico/public-api 0.0.124 → 0.0.126

package/dist/index.modern.mjs

@@ -611,6 +611,34 @@ const StoreItemTransform = items => {
   });
 };
 
+const StoreItemPurchasedTransform = items => {
+  return items.filter(r => r.id >= 1).map(r => {
+    var _r$categoryIds;
+    const x = {
+      id: r.id,
+      name: r.itemPublicMeta.name,
+      price: r.itemPublicMeta.price,
+      image: r.itemPublicMeta.image_url,
+      description: r.itemPublicMeta.description,
+      ribbon: r.itemPublicMeta.label_tag === 'custom' ? r.itemPublicMeta.custom_label_tag : r.itemPublicMeta.label_tag,
+      limit_message: r.itemPublicMeta.limit_message,
+      priority: r.itemPublicMeta.priority,
+      related_item_ids: r.itemPublicMeta.related_items,
+      hint_text: r.itemPublicMeta.hint_text,
+      type: {
+        [StoreItemType.Bonus]: 'bonus',
+        [StoreItemType.Manual]: 'manual'
+      }[r.itemTypeId],
+      can_buy: r.canBuy,
+      category_ids: (_r$categoryIds = r.categoryIds) != null ? _r$categoryIds : [],
+      pool: r.shopPool,
+      purchase_ts: r.purchase_ts,
+      purchase_points_amount: r.purchase_points_amount
+    };
+    return x;
+  });
+};
+
 var AchievementStatus;
 (function (AchievementStatus) {
   AchievementStatus[AchievementStatus["Draft"] = 1] = "Draft";
@@ -990,6 +1018,7 @@ var onUpdateContextKey;
   onUpdateContextKey["LeaderBoards"] = "leaderBoards";
   onUpdateContextKey["LevelExtraCounters"] = "levelExtraCounters";
   onUpdateContextKey["Segments"] = "segments";
+  onUpdateContextKey["StoreHistory"] = "storeHistory";
 })(onUpdateContextKey || (onUpdateContextKey = {}));
 /** @group General API */
 class WSAPI {
@@ -1008,7 +1037,14 @@ class WSAPI {
     on(ClassId.LOGOUT_RESPONSE, () => OCache.clear(ECacheContext.WSAPI));
     on(ClassId.IDENTIFY_RESPONSE, () => OCache.clear(ECacheContext.WSAPI));
   }
-  /** Returns information about current user */
+  /** Returns information about current user
+   * Example usage:
+   * ```
+   * _smartico.api.getUserProfile().then((result) => {
+   *  console.log(result);
+   * });
+   * ```
+   * */
   getUserProfile() {
     if (this.api.tracker) {
       const o = Object.assign({}, this.api.tracker.userPublicProps);
@@ -1018,7 +1054,14 @@ class WSAPI {
       throw new Error('Tracker is not initialized, cannot getUserProfile');
     }
   }
-  /** Check if user belongs to specific segments */
+  /** Check if user belongs to specific segments
+   * Example usage:
+   * ```
+   * _smartico.api.checkSegmentMatch(1).then((result) => {
+   *   console.log(result);
+   * });
+   * ```
+  */
   async checkSegmentMatch(segment_id) {
     const r = await this.api.coreCheckSegments(null, [segment_id]);
     if (r && r.find(s => s.segment_id === segment_id && s.is_matching)) {
@@ -1027,20 +1070,41 @@ class WSAPI {
       return false;
     }
   }
-  /** Check if user belongs to specific list of segments */
+  /** Check if user belongs to specific list of segments
+   * Example usage:
+   * ```
+   * _smartico.api.checkSegmentListMatch([1, 2, 3]).then((result) => {
+   *    console.log(result);
+   * });
+   * ```
+  */
   async checkSegmentListMatch(segment_ids) {
-    return await this.api.coreCheckSegments(null, segment_ids);
-  }
-  /** Returns all the levels available the current user */
+    return await this.api.coreCheckSegments(null, Array.isArray(segment_ids) ? segment_ids : [segment_ids]);
+  }
+  /** Returns all the levels available the current user
+   * Example usage:
+   * ```
+   * _smartico.api.getLevels().then((result) => {
+   *   console.log(result);
+   * });
+   * ```
+  */
   async getLevels() {
     return OCache.use(onUpdateContextKey.Levels, ECacheContext.WSAPI, () => this.api.levelsGetT(null), CACHE_DATA_SEC);
   }
   /** Returns all the missions available the current user.
-   * The returned missions is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getMissions with a new onUpdate callback, the old one will be overwritten by the new one.
-   * The onUpdate callback will be called on mission OptIn and the updated missions will be passed to it. */
-  /**
-  * @param params
-  */
+   * The returned missions are cached for 30 seconds. But you can pass the onUpdate callback as a parameter.
+   * Note that each time you call getMissions with a new onUpdate callback, the old one will be overwritten by the new one.
+   * The onUpdate callback will be called on mission OptIn and the updated missions will be passed to it.
+   * Example usage:
+   * ```
+   * _smartico.api.getMissions().then((result) => {
+   *  console.log(result);
+   * });
+   * ```
+   /**
+   * @param params
+   */
   async getMissions({
     onUpdate
   } = {}) {
@@ -1053,15 +1117,37 @@ class WSAPI {
   async getBadges() {
     return OCache.use(onUpdateContextKey.Badges, ECacheContext.WSAPI, () => this.api.badgetsGetItemsT(null), CACHE_DATA_SEC);
   }
-  /** Returns the extra counters for the current user level */
+  /**
+   * Returns the extra counters for the current user level.
+   * These are counters that are configured for each Smartico client separatly by request.
+   * For example 1st counter could be total wagering amount, 2nd counter could be total deposit amount, etc.
+   * Example usage:
+   * ```
+   * _smartico.api.getUserLevelExtraCounters().then((result) => {
+   *      console.log(result);
+   * });
+   * ```
+  */
   async getUserLevelExtraCounters() {
     return OCache.use(onUpdateContextKey.LevelExtraCounters, ECacheContext.WSAPI, () => this.api.getUserGamificationInfoT(null), CACHE_DATA_SEC);
   }
-  /** Returns all the store items available the current user */
+  /** Returns all the store items available the current user
+   * Example usage:
+   * ```
+   * _smartico.api.getStoreItems().then((result) => {
+   *      console.log(result);
+   * });
+  */
   async getStoreItems() {
     return OCache.use(onUpdateContextKey.StoreItems, ECacheContext.WSAPI, () => this.api.storeGetItemsT(null), CACHE_DATA_SEC);
   }
-  /** Buy the specific shop item by item_id. Returns the err_code.*/
+  /** Buy the specific shop item by item_id. Returns the err_code in case of success or error.
+   * Example usage:
+   * ```
+   * _smartico.api.buyStoreItem(1).then((result) => {
+   *     console.log(result);
+   * });
+  */
   async buyStoreItem(item_id) {
     const r = await this.api.buyStoreItem(null, item_id);
     const o = {
@@ -1074,7 +1160,25 @@ class WSAPI {
   async getStoreCategories() {
     return OCache.use(onUpdateContextKey.StoreCategories, ECacheContext.WSAPI, () => this.api.storeGetCategoriesT(null), CACHE_DATA_SEC);
   }
-  /** Returns ach categories */
+  /** Returns store purchased items based on the provided parameters. "From" and "to" indicate the range of items to be fetched.
+  * The maximum number of messages 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.
+  * This functions return list of purchased items.
+  * The "onUpdate" callback will be triggered when the user receives a new purchased item. It will provide an updated list of items, ranging from 0 to 20, to the onUpdate callback function. */
+  /**
+  * @param params
+  */
+  async storeGetPurchasedItems({
+    from,
+    to,
+    onUpdate
+  } = {}) {
+    if (onUpdate) {
+      this.onUpdateCallback.set(onUpdateContextKey.StoreHistory, onUpdate);
+    }
+    return await this.api.storeGetPurchasedItemsT(null, from, to);
+  }
+  /** Returns missions & badges categories */
   async getAchCategories() {
     return OCache.use(onUpdateContextKey.AchCategories, ECacheContext.WSAPI, () => this.api.achGetCategoriesT(null), CACHE_DATA_SEC);
   }
@@ -1633,6 +1737,18 @@ class SmarticoAPI {
   async storeGetCategoriesT(user_ext_id) {
     return StoreCategoryTransform((await this.storeGetCategories(user_ext_id)).categories);
   }
+  async storeGetPurchasedItems(user_ext_id, limit = 20, offset = 0) {
+    const message = this.buildMessage(user_ext_id, ClassId.ACH_SHOP_ITEM_HISTORY_REQUEST, {
+      limit,
+      offset
+    });
+    return await this.send(message, ClassId.ACH_SHOP_ITEM_HISTORY_RESPONSE);
+  }
+  async storeGetPurchasedItemsT(user_ext_id, from = 0, to = 20) {
+    const limit = to - from > 20 ? 20 : to - from;
+    const offset = from;
+    return StoreItemPurchasedTransform((await this.storeGetPurchasedItems(user_ext_id, limit, offset)).items);
+  }
   async missionsGetItems(user_ext_id) {
     const message = this.buildMessage(user_ext_id, ClassId.GET_ACHIEVEMENT_MAP_REQUEST);
     const response = await this.send(message, ClassId.GET_ACHIEVEMENT_MAP_RESPONSE);
@@ -2169,5 +2285,16 @@ const QuizMarketPerSport = {
   [QuizSportType.Tennis]: [QuizMarketType.One_Two, QuizMarketType.FirstSet, QuizMarketType.SecondSet, QuizMarketType.ThirdSet, QuizMarketType.FourthSet, QuizMarketType.FifthSet, QuizMarketType.PlayerOneWinsOneSet, QuizMarketType.PlayerTwoWinsOneSet, QuizMarketType.OddEven]
 };
 
-export { AchCategoryTransform, AchievementStatus, AchievementTaskType, AchievementType, ActivityTypeLimited, BuyStoreItemErrorCode, ClassId, CookieStore, CoreUtils, GetLevelMapResponseTransform, InboxMessageBodyTransform, InboxMessageType, InboxMessagesTransform, LeaderBoardPeriodType, MarketsValueType, MiniGamePrizeTypeName, MiniGamePrizeTypeNamed, PublicLabelSettings, QuizMarketPerSport, QuizMarketType, QuizSportType, SAWAcknowledgeType, SAWAskForUsername, SAWBuyInType, SAWBuyInTypeName, SAWBuyInTypeNamed, SAWGameType, SAWGameTypeName, SAWGameTypeNamed, SAWPrizeType, SAWSpinErrorCode, SAWTemplatesTransform, SAWUtils, SAWWinSoundFiles, SAWWinSoundType, ScheduledMissionType, SmarticoAPI, StoreCategoryTransform, StoreItemTransform, StoreItemType, TournamentInstanceStatus, TournamentInstanceStatusName, TournamentItemsTransform, TournamentRegistrationError, TournamentRegistrationStatus, TournamentRegistrationStatusName, TournamentRegistrationStatusNamed, TournamentRegistrationType, TournamentRegistrationTypeGetName, TournamentType, TournamentUtils, TranslationArea, UserAchievementTransform, marketsInfo, quizSupportedSports, tournamentInfoItemTransform };
+var JackpotContributionType;
+(function (JackpotContributionType) {
+  JackpotContributionType[JackpotContributionType["Fixed"] = 1] = "Fixed";
+  JackpotContributionType[JackpotContributionType["Percentage"] = 2] = "Percentage";
+})(JackpotContributionType || (JackpotContributionType = {}));
+
+var JackpotType;
+(function (JackpotType) {
+  JackpotType[JackpotType["Main"] = 1] = "Main";
+})(JackpotType || (JackpotType = {}));
+
+export { AchCategoryTransform, AchievementStatus, AchievementTaskType, AchievementType, ActivityTypeLimited, BuyStoreItemErrorCode, ClassId, CookieStore, CoreUtils, GetLevelMapResponseTransform, InboxMessageBodyTransform, InboxMessageType, InboxMessagesTransform, JackpotContributionType, JackpotType, LeaderBoardPeriodType, MarketsValueType, MiniGamePrizeTypeName, MiniGamePrizeTypeNamed, PublicLabelSettings, QuizMarketPerSport, QuizMarketType, QuizSportType, SAWAcknowledgeType, SAWAskForUsername, SAWBuyInType, SAWBuyInTypeName, SAWBuyInTypeNamed, SAWGameType, SAWGameTypeName, SAWGameTypeNamed, SAWPrizeType, SAWSpinErrorCode, SAWTemplatesTransform, SAWUtils, SAWWinSoundFiles, SAWWinSoundType, ScheduledMissionType, SmarticoAPI, StoreCategoryTransform, StoreItemPurchasedTransform, StoreItemTransform, StoreItemType, TournamentInstanceStatus, TournamentInstanceStatusName, TournamentItemsTransform, TournamentRegistrationError, TournamentRegistrationStatus, TournamentRegistrationStatusName, TournamentRegistrationStatusNamed, TournamentRegistrationType, TournamentRegistrationTypeGetName, TournamentType, TournamentUtils, TranslationArea, UserAchievementTransform, marketsInfo, quizSupportedSports, tournamentInfoItemTransform };
 //# sourceMappingURL=index.modern.mjs.map