@smartico/public-api 0.0.136 → 0.0.138

package/dist/Jackpots/JackpotDetails.d.ts

@@ -3,15 +3,31 @@ import { JackpotContributionType } from "./JackpotContributionType";
 import { JackpotPot } from "./JackpotPot";
 import { JackpotPublicMeta } from "./JackpotPublicMeta";
 import { JackpotType } from "./JackpotType";
+/**
+ * JackpotDetails the information about Jackpot template
+ * It also includes JackpotPot object that holds the current value of the jackpot
+ * Flag is_opted_in indicates if the current user is opted in to the jackpot
+*/
 interface JackpotDetails {
+    /** ID of the jackpot template */
     jp_template_id: number;
+    /** type of jackpot logic */
     jp_type_id: JackpotType;
+    /** UI information of jackpot, like name, description, etc. */
     jp_public_meta: JackpotPublicMeta;
+    /** base currency of the jackpot */
     jp_currency: string;
+    /**  wallet currency of currently logged in user */
+    user_currency: string;
+    /**  list of related games that are eligible for the jackpot */
     related_games?: AchRelatedGame[];
+    /**  type of the user contribution to the jackpot */
     contribution_type: JackpotContributionType;
+    /**  value of the user contribution. Fixed amount or percentage of bet depending on the contribution type */
     contribution_value: number;
+    /**  information of current value of the jackpot */
     pot: JackpotPot;
+    /**  indication if the current user is opted in to the jackpot */
     is_opted_in: boolean;
 }
 export { JackpotDetails };

package/dist/Jackpots/JackpotPot.d.ts

@@ -1,7 +1,13 @@
 interface JackpotPot {
+    /** ID of the jackpot template */
     jp_template_id: number;
+    /** ID of the jackpot pot */
     jp_pot_id: number;
+    /** currency of the jackpot pot in the Jackput base currency */
     current_pot_amount: number;
+    /** currency of the jackpot pot in the user wallet currency */
+    current_pot_amount_user_currency: number;
+    /** the date/time when this pot exploded */
     explode_date_ts: number;
 }
 export { JackpotPot };

package/dist/Jackpots/JackpotPublicMeta.d.ts

@@ -1,11 +1,18 @@
 import { JackpotHtmlTemplate } from './JackpotHtmlTemplate';
 interface JackpotPublicMeta {
+    /** name of the jackpot */
     name: string;
+    /** description/rules of the jackpot */
     description: string;
+    /** image url of the jackpot */
     image_url: string;
+    /** HTML template for the winner of the jackpt */
     winner_template: JackpotHtmlTemplate;
+    /** HTML template for the not winner of the jackpot */
     not_winner_template: JackpotHtmlTemplate;
+    /** custom value of placeholder1 defined by operator and can be used in the HTML templates */
     placeholder1: string;
+    /** custom value of placeholder2 defined by operator and can be used in the HTML templates */
     placeholder2: string;
 }
 export { JackpotPublicMeta };

package/dist/MiniGames/SAWTemplateUI.d.ts

@@ -36,8 +36,8 @@ export interface SAWTemplateUI {
     custom_section_id?: number;
     only_in_custom_section?: boolean;
     custom_data: any;
-    placeholder_1?: string;
-    placeholder_2?: string;
+    placeholder1?: string;
+    placeholder2?: string;
     prize_drop_template?: {
         id: string;
         content: string;

package/dist/SmarticoAPI.d.ts

@@ -84,7 +84,7 @@ declare class SmarticoAPI {
     storeGetCategories(user_ext_id: string): Promise<GetCategoriesStoreResponse>;
     storeGetCategoriesT(user_ext_id: string): Promise<TStoreCategory[]>;
     storeGetPurchasedItems(user_ext_id: string, limit?: number, offset?: number): Promise<GetStoreHistoryResponse>;
-    storeGetPurchasedItemsT(user_ext_id: string, from?: number, to?: number): Promise<TStoreItem[]>;
+    storeGetPurchasedItemsT(user_ext_id: string, limit?: number, offset?: number): Promise<TStoreItem[]>;
     missionsGetItems(user_ext_id: string): Promise<GetAchievementMapResponse>;
     missionsGetItemsT(user_ext_id: string): Promise<TMissionOrBadge[]>;
     getUserGamificationInfo(user_ext_id: string): Promise<GetAchievementsUserInfoResponse>;

package/dist/SmarticoLib/index.d.ts

@@ -408,8 +408,8 @@ export interface SAWTemplateUI {
     custom_section_id?: number;
     only_in_custom_section?: boolean;
     custom_data: any;
-    placeholder_1?: string;
-    placeholder_2?: string;
+    placeholder1?: string;
+    placeholder2?: string;
     prize_drop_template?: {
         id: string;
         content: string;
@@ -512,6 +512,8 @@ export interface TournamentPublicMeta {
     image_url?: string;
     /** 2nd image */
     image_url2?: string;
+    /** 2nd image for mobile */
+    image_url2_mobile?: string;
     /** Description, html capable */
     description?: string;
     /** Short explanation of prize pool */

package/dist/Store/GetStoreHistoryRequest.d.ts

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

package/dist/Store/GetStoreHistoryResponse.d.ts

@@ -2,5 +2,5 @@ import { ProtocolResponse } from "../Base/ProtocolResponse";
 import { StoreItemPurchased } from "./StoreItemPurchased";
 export interface GetStoreHistoryResponse extends ProtocolResponse {
     items: StoreItemPurchased[];
-    hasMore: boolean;
+    hasMore?: boolean;
 }

package/dist/WSAPI/WSAPI.d.ts

@@ -93,17 +93,19 @@ export declare class WSAPI {
     buyStoreItem(item_id: number): Promise<TBuyStoreItemResult>;
     /** Returns store categories */
     getStoreCategories(): Promise<TStoreCategory[]>;
-    /** 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
-    */
-    storeGetPurchasedItems({ from, to, onUpdate }?: {
-        from?: number;
-        to?: number;
+    /** Returns purchased items based on the provided parameters. "Limit" and "offset" indicate the range of items to be fetched.
+    * The maximum number of items 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.
+    * Example usage:
+    * ```
+    * _smartico.api.getStorePurchasedItems().then((result) => {
+    *      console.log(result);
+    * });
+    * ```
+   */
+    getStorePurchasedItems({ limit, offset, onUpdate }?: {
+        limit?: number;
+        offset?: number;
         onUpdate?: (data: TStoreItem[]) => void;
     }): Promise<TStoreItem[]>;
     /** Returns missions & badges categories */
@@ -179,13 +181,42 @@ export declare class WSAPI {
     private updateInboxMessages;
     private updateEntity;
     private jackpotClearCache;
+    /** Returns list of Jackpots that are active in the systen and matching to the filter definition.
+     * If filter is not provided, all active jackpots will be returned.
+     * Filter can be used to get jackpots related to specific game or specific jackpot template.
+     * You can call this method every second in order to get up to date information about current value of the jackpot(s) and present them to the end-users
+     * Example usage:
+     * ```
+     * _smartico.api.jackpotGet({ related_game_id: 'wooko-slot' }).then((result) => {
+     *      console.log(result);
+     * });
+     * ```
+    */
     jackpotGet(filter?: {
         related_game_id?: string;
         jp_template_id?: number;
     }): Promise<JackpotDetails[]>;
+    /** Opt-in currently logged in user to the jackpot with the specified jp_template_id.
+     * You may call jackpotGet method after doing optin to see that user is opted in to the jackpot.
+     * Example usage:
+     * ```
+     * _smartico.api.jackpotOptIn({ jp_template_id: 123 }).then((result) => {
+     *      console.log('Opted in to the jackpot');
+     * });
+     * ```
+    */
     jackpotOptIn(filter: {
         jp_template_id: number;
     }): Promise<JackpotsOptinResponse>;
+    /** Opt-out currently logged in user from the jackpot with the specified jp_template_id.
+     * You may call jackpotGet method after doing optout to see that user is not opted in to the jackpot.
+     * Example usage:
+     * ```
+     * _smartico.api.jackpotOptOut({ jp_template_id: 123 }).then((result) => {
+     *      console.log('Opted out from the jackpot');
+     * });
+     * ```
+    */
     jackpotOptOut(filter: {
         jp_template_id: number;
     }): Promise<JackpotsOptoutResponse>;

package/dist/WSAPI/WSAPITypes.d.ts

@@ -160,6 +160,7 @@ export interface TTournament {
     description: string;
     image1: string;
     image2: string;
+    image2_mobile: string;
     prize_pool_short: string;
     custom_price_text: string;
     /** The message that should be shown to the user when the user cannot register in tournament with error code TOURNAMENT_USER_DONT_MATCH_CONDITIONS  */

package/dist/index.js

@@ -900,6 +900,7 @@ var TournamentItemsTransform = function TournamentItemsTransform(items) {
       segment_dont_match_message: r.publicMeta.segment_dont_match_message,
       image1: r.publicMeta.image_url,
       image2: r.publicMeta.image_url2,
+      image2_mobile: r.publicMeta.image_url2_mobile,
       prize_pool_short: r.publicMeta.prize_pool_short,
       custom_price_text: r.publicMeta.custom_price_text,
       custom_section_id: r.publicMeta.custom_section_id,
@@ -1346,26 +1347,30 @@ var WSAPI = /*#__PURE__*/function () {
       return Promise.reject(e);
     }
   }
-  /** 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.
+  /** Returns purchased items based on the provided parameters. "Limit" and "offset" indicate the range of items to be fetched.
+  * The maximum number of items 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
+  * Example usage:
+  * ```
+  * _smartico.api.getStorePurchasedItems().then((result) => {
+  *      console.log(result);
+  * });
+  * ```
   */
   ;
-  _proto.storeGetPurchasedItems = function storeGetPurchasedItems(_temp2) {
+  _proto.getStorePurchasedItems = function getStorePurchasedItems(_temp2) {
     var _ref2 = _temp2 === void 0 ? {} : _temp2,
-      from = _ref2.from,
-      to = _ref2.to,
+      limit = _ref2.limit,
+      offset = _ref2.offset,
       onUpdate = _ref2.onUpdate;
     try {
       var _this11 = this;
       if (onUpdate) {
         _this11.onUpdateCallback.set(onUpdateContextKey.StoreHistory, onUpdate);
       }
-      return Promise.resolve(_this11.api.storeGetPurchasedItemsT(null, from, to));
+      return Promise.resolve(OCache.use(onUpdateContextKey.StoreHistory, exports.ECacheContext.WSAPI, function () {
+        return _this11.api.storeGetPurchasedItemsT(null, limit, offset);
+      }, CACHE_DATA_SEC));
     } catch (e) {
       return Promise.reject(e);
     }
@@ -1727,7 +1732,19 @@ var WSAPI = /*#__PURE__*/function () {
     } catch (e) {
       return Promise.reject(e);
     }
-  };
+  }
+  /** Returns list of Jackpots that are active in the systen and matching to the filter definition.
+   * If filter is not provided, all active jackpots will be returned.
+   * Filter can be used to get jackpots related to specific game or specific jackpot template.
+   * You can call this method every second in order to get up to date information about current value of the jackpot(s) and present them to the end-users
+   * Example usage:
+   * ```
+   * _smartico.api.jackpotGet({ related_game_id: 'wooko-slot' }).then((result) => {
+   *      console.log(result);
+   * });
+   * ```
+  */
+  ;
   _proto.jackpotGet = function jackpotGet(filter) {
     try {
       var _this36 = this;
@@ -1785,7 +1802,17 @@ var WSAPI = /*#__PURE__*/function () {
     } catch (e) {
       return Promise.reject(e);
     }
-  };
+  }
+  /** Opt-in currently logged in user to the jackpot with the specified jp_template_id.
+   * You may call jackpotGet method after doing optin to see that user is opted in to the jackpot.
+   * Example usage:
+   * ```
+   * _smartico.api.jackpotOptIn({ jp_template_id: 123 }).then((result) => {
+   *      console.log('Opted in to the jackpot');
+   * });
+   * ```
+  */
+  ;
   _proto.jackpotOptIn = function jackpotOptIn(filter) {
     try {
       var _this37 = this;
@@ -1800,7 +1827,17 @@ var WSAPI = /*#__PURE__*/function () {
     } catch (e) {
       return Promise.reject(e);
     }
-  };
+  }
+  /** Opt-out currently logged in user from the jackpot with the specified jp_template_id.
+   * You may call jackpotGet method after doing optout to see that user is not opted in to the jackpot.
+   * Example usage:
+   * ```
+   * _smartico.api.jackpotOptOut({ jp_template_id: 123 }).then((result) => {
+   *      console.log('Opted out from the jackpot');
+   * });
+   * ```
+  */
+  ;
   _proto.jackpotOptOut = function jackpotOptOut(filter) {
     try {
       var _this38 = this;
@@ -2399,17 +2436,9 @@ var SmarticoAPI = /*#__PURE__*/function () {
       return Promise.reject(e);
     }
   };
-  _proto.storeGetPurchasedItemsT = function storeGetPurchasedItemsT(user_ext_id, from, to) {
-    if (from === void 0) {
-      from = 0;
-    }
-    if (to === void 0) {
-      to = 20;
-    }
+  _proto.storeGetPurchasedItemsT = function storeGetPurchasedItemsT(user_ext_id, limit, offset) {
     try {
       var _this26 = this;
-      var limit = to - from > 20 ? 20 : to - from;
-      var offset = from;
       return Promise.resolve(_this26.storeGetPurchasedItems(user_ext_id, limit, offset)).then(function (_this26$storeGetPurch) {
         return StoreItemPurchasedTransform(_this26$storeGetPurch.items);
       });