@smartico/public-api 0.0.124 → 0.0.125

package/dist/SmarticoAPI.d.ts

@@ -5,7 +5,7 @@ import { SAWDoAknowledgeResponse, SAWDoSpinResponse } from './MiniGames';
 import { GetTranslationsResponse, PublicLabelSettings, ResponseIdentify, TranslationArea } from './Core';
 import { GetLabelInfoResponse } from './Core/GetLabelInfoResponse';
 import { GetInboxMessagesResponse, InboxMessageBody, MarkInboxMessageDeletedResponse, MarkInboxMessageReadResponse, MarkInboxMessageStarredResponse } from './Inbox';
-import { BuyStoreItemResponse, GetCategoriesStoreResponse, GetStoreItemsResponse } from './Store';
+import { BuyStoreItemResponse, GetCategoriesStoreResponse, GetStoreHistoryResponse, GetStoreItemsResponse } from './Store';
 import { AchClaimPrizeResponse, AchievementOptinResponse, GetAchCategoriesResponse, GetAchievementMapResponse } from './Missions';
 import { GetTournamentInfoResponse, GetTournamentsResponse, TournamentRegisterResponse } from './Tournaments';
 import { LeaderBoardDetails, LeaderBoardPeriodType } from "./Leaderboard";
@@ -69,6 +69,8 @@ declare class SmarticoAPI {
     storeGetItemsT(user_ext_id: string): Promise<TStoreItem[]>;
     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[]>;
     missionsGetItems(user_ext_id: string): Promise<GetAchievementMapResponse>;
     missionsGetItemsT(user_ext_id: string): Promise<TMissionOrBadge[]>;
     getUserGamificationInfo(user_ext_id: string): Promise<GetAchievementsUserInfoResponse>;

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;
+    limit?: number;
 }

package/dist/Store/GetStoreHistoryResponse.d.ts

@@ -1,6 +1,6 @@
-import { ProtocolMessage } from "../Base/ProtocolMessage";
-import { StorItemPruchased } from "./StorItemPruchased";
-export interface GetStoreHistoryResponse extends ProtocolMessage {
-    items: StorItemPruchased[];
+import { ProtocolResponse } from "../Base/ProtocolResponse";
+import { StoreItemPurchased } from "./StoreItemPurchased";
+export interface GetStoreHistoryResponse extends ProtocolResponse {
+    items: StoreItemPurchased[];
     hasMore: boolean;
 }

package/dist/Store/StoreItemPurchased.d.ts

@@ -0,0 +1,8 @@
+import { TStoreItem } from "../WSAPI/WSAPITypes";
+import { StoreItem } from "./StoreItem";
+interface StoreItemPurchased extends StoreItem {
+    purchase_ts: number;
+    purchase_points_amount: number;
+}
+export declare const StoreItemPurchasedTransform: (items: StoreItemPurchased[]) => TStoreItem[];
+export { StoreItemPurchased };

package/dist/Store/index.d.ts

@@ -8,3 +8,6 @@ export * from "./StoreCategoryPublicMeta";
 export * from "./StoreItem";
 export * from "./StoreItemPublicMeta";
 export * from "./StoreItemType";
+export * from './StoreItemPurchased';
+export * from './GetStoreHistoryRequest';
+export * from './GetStoreHistoryResponse';

package/dist/WSAPI/WSAPI.d.ts

@@ -7,34 +7,104 @@ export declare class WSAPI {
     private onUpdateCallback;
     /** @private */
     constructor(api: SmarticoAPI);
-    /** Returns information about current user */
+    /** Returns information about current user
+     * Example usage:
+     * ```
+     * _smartico.api.getUserProfile().then((result) => {
+     *  console.log(result);
+     * });
+     * ```
+     * */
     getUserProfile(): TUserProfile;
-    /** 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);
+     * });
+     * ```
+    */
     checkSegmentMatch(segment_id: number): Promise<boolean>;
-    /** 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);
+     * });
+     * ```
+    */
     checkSegmentListMatch(segment_ids: number[]): Promise<TSegmentCheckResult[]>;
-    /** Returns all the levels available the current user */
+    /** Returns all the levels available the current user
+     * Example usage:
+     * ```
+     * _smartico.api.getLevels().then((result) => {
+     *   console.log(result);
+     * });
+     * ```
+    */
     getLevels(): Promise<TLevel[]>;
     /** 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
+     */
     getMissions({ onUpdate }?: {
         onUpdate?: (data: TMissionOrBadge[]) => void;
     }): Promise<TMissionOrBadge[]>;
     /** Returns all the badges available the current user */
     getBadges(): Promise<TMissionOrBadge[]>;
-    /** 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);
+     * });
+     * ```
+    */
     getUserLevelExtraCounters(): Promise<UserLevelExtraCountersT>;
-    /** 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);
+     * });
+    */
     getStoreItems(): Promise<TStoreItem[]>;
-    /** 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);
+     * });
+    */
     buyStoreItem(item_id: number): Promise<TBuyStoreItemResult>;
     /** Returns store categories */
     getStoreCategories(): Promise<TStoreCategory[]>;
-    /** 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
+    */
+    storeGetPurchasedItems({ from, to, onUpdate }?: {
+        from?: number;
+        to?: number;
+        onUpdate?: (data: TStoreItem[]) => void;
+    }): Promise<TStoreItem[]>;
+    /** Returns missions & badges categories */
     getAchCategories(): Promise<TAchCategory[]>;
     /** Returns the list of mini-games available for user
      * The returned list of mini-games is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getMiniGames with a new onUpdate callback, the old one will be overwritten by the new one.

package/dist/WSAPI/WSAPITypes.d.ts

@@ -328,6 +328,10 @@ export interface TStoreItem {
     pool?: number;
     /** The T&C text for the store item */
     hint_text?: string;
+    /** Purchase time to show in purchase history screen */
+    purchase_ts?: number;
+    /** The amount of points you can purchase an item */
+    purchase_points_amount?: number;
 }
 /**
  * TAchCategory describes the badge category item. Each badge item can be assigned to 1 or more categories