@smartico/public-api 0.0.136 → 0.0.138

package/src/WSAPI/WSAPI.ts

@@ -6,7 +6,6 @@ import { SmarticoAPI } from "../SmarticoAPI";
 import { InboxMarkMessageAction, LeaderBoardDetailsT, TAchCategory, TBuyStoreItemResult, TGetTranslations, TInboxMessage, TInboxMessageBody, TLevel, TMiniGamePlayResult, TMiniGameTemplate, TMissionClaimRewardResult, TMissionOptInResult, TMissionOrBadge, TSegmentCheckResult, TStoreCategory, TStoreItem, TTournament, TTournamentDetailed, TTournamentRegistrationResult, TUserProfile, UserLevelExtraCountersT } from "./WSAPITypes";
 import { LeaderBoardPeriodType } from "../Leaderboard";
 import { JackpotDetails, JackpotPot, JackpotWinPush, JackpotsOptinResponse, JackpotsOptoutResponse } from "../Jackpots";
-import { AchRelatedGame } from "src/Base/AchRelatedGame";
  
 /** @hidden */
 const CACHE_DATA_SEC = 30;
@@ -51,7 +50,7 @@ export class WSAPI {
         on(ClassId.CLIENT_ENGAGEMENT_EVENT_NEW, () => this.updateInboxMessages());
         on(ClassId.LOGOUT_RESPONSE, () => OCache.clearContext(ECacheContext.WSAPI));
         on(ClassId.IDENTIFY_RESPONSE, () => OCache.clearContext(ECacheContext.WSAPI));
-        on(ClassId.JP_WIN_PUSH, (data: JackpotWinPush) => this.jackpotClearCache())
+        on(ClassId.JP_WIN_PUSH, (data: JackpotWinPush) => this.jackpotClearCache());
     }
 
     /** Returns information about current user
@@ -189,20 +188,22 @@ export class WSAPI {
         return OCache.use(onUpdateContextKey.StoreCategories, ECacheContext.WSAPI, () => this.api.storeGetCategoriesT(null), CACHE_DATA_SEC);
     }
 
-     /** 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
+     /** 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);
+     * });
+     * ```
     */
-    public async storeGetPurchasedItems({ from, to, onUpdate }: { from?: number, to?: number, onUpdate?: (data: TStoreItem[]) => void } = {}): Promise<TStoreItem[]> { 
+
+    public async getStorePurchasedItems({ limit, offset, onUpdate } : { limit?: number, offset?: number, onUpdate?: (data: TStoreItem[]) => void} = {}): Promise<TStoreItem[]> {
         if (onUpdate) {
             this.onUpdateCallback.set(onUpdateContextKey.StoreHistory, onUpdate);
         }
-
-        return await this.api.storeGetPurchasedItemsT(null, from, to);
+        return OCache.use(onUpdateContextKey.StoreHistory, ECacheContext.WSAPI, () => this.api.storeGetPurchasedItemsT(null, limit, offset), CACHE_DATA_SEC);
     }
 
     /** Returns missions & badges categories */
@@ -442,7 +443,17 @@ export class WSAPI {
         OCache.clear(ECacheContext.WSAPI, onUpdateContextKey.Pots);    
     }
 
-
+    /** 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);
+     * });
+     * ```
+    */
     public async jackpotGet(filter?: { related_game_id?: string, jp_template_id?: number }): Promise<JackpotDetails[]> {
 
         const signature: string = `${filter?.jp_template_id}:${filter?.related_game_id}`;
@@ -485,6 +496,15 @@ export class WSAPI {
 
     }
 
+    /** 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');
+     * });
+     * ```
+    */    
     public async jackpotOptIn(filter: { jp_template_id: number }): Promise<JackpotsOptinResponse> {
         
         if (!filter.jp_template_id) {
@@ -498,6 +518,15 @@ export class WSAPI {
         return result;
     }
 
+    /** 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');
+     * });
+     * ```
+    */       
     public async jackpotOptOut(filter: { jp_template_id: number }): Promise<JackpotsOptoutResponse> {
         
         if (!filter.jp_template_id) {

package/src/WSAPI/WSAPITypes.ts

@@ -190,6 +190,8 @@ export interface TTournament {
     image1: string;
     /* 2nd image URL representing the tournament */
     image2: string;
+    /* 2nd image URL representing the tournament for mobile */
+    image2_mobile: string;
     /* The message indicating the prize pool of the tournament */
     prize_pool_short: string;
     /* The message indicating the price to register in the tournament */

package/tsconfig.json

@@ -25,6 +25,9 @@
             "src/MiniGames/SAWSpinErrorCode.ts",
             "src/Tournaments/TournamentRegistrationError.ts",
             "src/Store/BuyStoreItemErrorCode.ts",
+            "src/Leaderboard/LeaderBoardPeriodType.ts",
+            "src/Base/AchRelatedGame.ts",
+            "src/Jackpots/index.ts",
         ],
         "out": "docs",
         "plugin": ["typedoc-plugin-markdown", "typedoc-plugin-merge-modules"],