@smartico/public-api 0.0.124 → 0.0.126

package/docs/classes/WSAPI.md

@@ -7,6 +7,12 @@
 ▸ **getUserProfile**(): [`TUserProfile`](../interfaces/TUserProfile.md)
 
 Returns information about current user
+Example usage:
+```
+_smartico.api.getUserProfile().then((result) => {
+ console.log(result);
+});
+```
 
 #### Returns
 
@@ -19,6 +25,12 @@ ___
 ▸ **checkSegmentMatch**(`segment_id`): `Promise`<`boolean`\>
 
 Check if user belongs to specific segments
+Example usage:
+```
+_smartico.api.checkSegmentMatch(1).then((result) => {
+  console.log(result);
+});
+```
 
 #### Parameters
 
@@ -37,6 +49,12 @@ ___
 ▸ **checkSegmentListMatch**(`segment_ids`): `Promise`<[`TSegmentCheckResult`](../interfaces/TSegmentCheckResult.md)[]\>
 
 Check if user belongs to specific list of segments
+Example usage:
+```
+_smartico.api.checkSegmentListMatch([1, 2, 3]).then((result) => {
+   console.log(result);
+});
+```
 
 #### Parameters
 
@@ -55,6 +73,12 @@ ___
 ▸ **getLevels**(): `Promise`<[`TLevel`](../interfaces/TLevel.md)[]\>
 
 Returns all the levels available the current user
+Example usage:
+```
+_smartico.api.getLevels().then((result) => {
+  console.log(result);
+});
+```
 
 #### Returns
 
@@ -66,6 +90,18 @@ ___
 
 ▸ **getMissions**(`params?`): `Promise`<[`TMissionOrBadge`](../interfaces/TMissionOrBadge.md)[]\>
 
+Returns all the missions available the current user.
+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);
+});
+```
+/**
+
 #### Parameters
 
 | Name | Type |
@@ -95,7 +131,15 @@ ___
 
 ▸ **getUserLevelExtraCounters**(): `Promise`<[`UserLevelExtraCountersT`](../interfaces/UserLevelExtraCountersT.md)\>
 
-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);
+});
+```
 
 #### Returns
 
@@ -108,6 +152,11 @@ ___
 ▸ **getStoreItems**(): `Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
 
 Returns all the store items available the current user
+Example usage:
+```
+_smartico.api.getStoreItems().then((result) => {
+     console.log(result);
+});
 
 #### Returns
 
@@ -119,7 +168,12 @@ ___
 
 ▸ **buyStoreItem**(`item_id`): `Promise`<[`TBuyStoreItemResult`](../interfaces/TBuyStoreItemResult.md)\>
 
-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);
+});
 
 #### Parameters
 
@@ -145,11 +199,30 @@ Returns store categories
 
 ___
 
+### storeGetPurchasedItems
+
+▸ **storeGetPurchasedItems**(`params?`): `Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `Object` |
+| `params.from?` | `number` |
+| `params.to?` | `number` |
+| `params.onUpdate?` | (`data`: [`TStoreItem`](../interfaces/TStoreItem.md)[]) => `void` |
+
+#### Returns
+
+`Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
+
+___
+
 ### getAchCategories
 
 ▸ **getAchCategories**(): `Promise`<[`TAchCategory`](../interfaces/TAchCategory.md)[]\>
 
-Returns ach categories
+Returns missions & badges categories
 
 #### Returns
 

package/docs/interfaces/TStoreItem.md

@@ -116,3 +116,19 @@ ___
 • `Optional` **hint\_text**: `string`
 
 The T&C text for the store item
+
+___
+
+### purchase\_ts
+
+• `Optional` **purchase\_ts**: `number`
+
+Purchase time to show in purchase history screen
+
+___
+
+### purchase\_points\_amount
+
+• `Optional` **purchase\_points\_amount**: `number`
+
+The amount of points you can purchase an item

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smartico/public-api",
-  "version": "0.0.124",
+  "version": "0.0.126",
   "description": "Smartico public API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/Jackpots/index.ts

@@ -0,0 +1,15 @@
+export * from './GetJackpotsPotsRequest';
+export * from './GetJackpotsPotsResponse';
+export * from './GetJackpotsRequest';
+export * from './GetJackpotsResponse';
+export * from './JackPotWinner';
+export * from './JackpotContributionType';
+export * from './JackpotDetails';
+export * from './JackpotPot';
+export * from './JackpotPublicMeta';
+export * from './JackpotType';
+export * from './JackpotWinPush';
+export * from './JackpotsOptinRequest';
+export * from './JackpotsOptinResponse';
+export * from './JackpotsOptoutRequest';
+export * from './JackpotsOptoutResponse';

package/src/SmarticoAPI.ts

@@ -11,7 +11,7 @@ import { CoreUtils, GetTranslationsRequest, GetTranslationsResponse, PublicLabel
 import { GetLabelInfoResponse } from './Core/GetLabelInfoResponse';
 import { GetLabelInfoRequest } from './Core/GetLabelInfoRequest';
 import { GetInboxMessagesRequest, GetInboxMessagesResponse, InboxMessageBody, InboxMessageBodyTransform, InboxMessagesTransform, MarkInboxMessageDeletedRequest, MarkInboxMessageDeletedResponse, MarkInboxMessageReadRequest, MarkInboxMessageReadResponse, MarkInboxMessageStarredRequest, MarkInboxMessageStarredResponse } from './Inbox';
-import { BuyStoreItemRequest, BuyStoreItemResponse, GetCategoriesStoreResponse, GetStoreItemsResponse, StoreCategoryTransform, StoreItemTransform } from './Store';
+import { BuyStoreItemRequest, BuyStoreItemResponse, GetCategoriesStoreResponse, GetStoreHistoryRequest, GetStoreHistoryResponse, GetStoreItemsResponse, StoreCategoryTransform, StoreItemPurchasedTransform, StoreItemTransform } from './Store';
 import { AchCategoryTransform, AchClaimPrizeRequest, AchClaimPrizeResponse, AchievementOptinRequest, AchievementOptinResponse, AchievementType, GetAchCategoriesResponse, GetAchievementMapRequest, GetAchievementMapResponse, UserAchievementTransform } from './Missions';
 import { GetTournamentInfoRequest, GetTournamentInfoResponse, GetTournamentsRequest, GetTournamentsResponse, TournamentItemsTransform, TournamentRegisterRequest, TournamentRegisterResponse, tournamentInfoItemTransform } from './Tournaments';
 import { GetLeaderBoardsRequest, GetLeaderBoardsResponse, LeaderBoardDetails, LeaderBoardPeriodType } from "./Leaderboard";
@@ -440,7 +440,22 @@ class SmarticoAPI {
 
     public async storeGetCategoriesT(user_ext_id: string): Promise<TStoreCategory[]> {
         return StoreCategoryTransform((await this.storeGetCategories(user_ext_id)).categories);
-    }        
+    }
+    
+    public async storeGetPurchasedItems(user_ext_id: string, limit: number = 20, offset: number = 0): Promise<GetStoreHistoryResponse> {
+        const message = this.buildMessage<GetStoreHistoryRequest, GetStoreHistoryResponse>(user_ext_id, ClassId.ACH_SHOP_ITEM_HISTORY_REQUEST, {
+            limit,
+            offset,
+        });
+        return await this.send<GetStoreHistoryResponse>(message, ClassId.ACH_SHOP_ITEM_HISTORY_RESPONSE);
+    }
+
+    public async storeGetPurchasedItemsT(user_ext_id: string, from: number = 0, to: number = 20): Promise<TStoreItem[]> {
+        const limit = (to - from) > 20 ? 20 : to - from;
+        const offset = from;
+
+        return StoreItemPurchasedTransform((await this.storeGetPurchasedItems(user_ext_id, limit, offset)).items);
+    }
 
     public async missionsGetItems(user_ext_id: string): Promise<GetAchievementMapResponse> {
 

package/src/Store/GetStoreHistoryRequest.ts

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

package/src/Store/GetStoreHistoryResponse.ts

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

package/src/Store/StoreItemPurchased.ts

@@ -0,0 +1,41 @@
+import { TStoreItem } from "../WSAPI/WSAPITypes";
+import { StoreItem } from "./StoreItem";
+import { StoreItemType } from "./StoreItemType";
+
+interface StoreItemPurchased extends StoreItem {
+    purchase_ts: number;
+    purchase_points_amount: number;
+}
+
+export const StoreItemPurchasedTransform = (items: StoreItemPurchased[]): TStoreItem[] => {    
+    return items.filter( r => r.id >= 1).map( r => {
+        const x: TStoreItem = 
+        {
+            id: r.id,
+            name: r.itemPublicMeta.name,
+            price: r.itemPublicMeta.price as any as number, // AA: strange why it's string
+            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] as 'bonus' | 'manual',
+
+            can_buy: r.canBuy,
+            category_ids: r.categoryIds ?? [],
+            pool: r.shopPool,
+            purchase_ts: r.purchase_ts,
+            purchase_points_amount: r.purchase_points_amount
+        }
+        return x;
+    });
+
+}
+
+export { StoreItemPurchased }

package/src/Store/index.ts

@@ -7,4 +7,7 @@ export * from "./StoreCategory";
 export * from "./StoreCategoryPublicMeta";
 export * from "./StoreItem";
 export * from "./StoreItemPublicMeta";
-export * from "./StoreItemType";
+export * from "./StoreItemType";
+export * from './StoreItemPurchased';
+export * from './GetStoreHistoryRequest';
+export * from './GetStoreHistoryResponse';

package/src/WSAPI/WSAPI.ts

@@ -22,6 +22,7 @@ enum onUpdateContextKey {
     LeaderBoards = 'leaderBoards',
     LevelExtraCounters = 'levelExtraCounters',
     Segments = 'segments',
+    StoreHistory = 'storeHistory'
 }
 
 
@@ -43,7 +44,14 @@ export class 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);
+     * });
+     * ```
+     * */
     public getUserProfile(): TUserProfile {
         if (this.api.tracker) {
             const o: TUserProfile = Object.assign({}, this.api.tracker.userPublicProps);
@@ -54,8 +62,14 @@ export class WSAPI {
         }
     }
 
-    /** 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);
+     * });
+     * ```
+    */
     public async checkSegmentMatch(segment_id: number): Promise<boolean> {
         const r = await this.api.coreCheckSegments(null, [segment_id]);
         if (r && r.find(s => s.segment_id === segment_id && s.is_matching)) {
@@ -65,19 +79,40 @@ export class WSAPI {
         }
     }
 
-    /** 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);
+     * });
+     * ```
+    */
     public async checkSegmentListMatch(segment_ids: number[]): Promise<TSegmentCheckResult[]> {
-        return await this.api.coreCheckSegments(null, segment_ids)
+        return await this.api.coreCheckSegments(null, Array.isArray(segment_ids) ? segment_ids : [segment_ids]);
     }    
 
-    /** 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);
+     * });
+     * ```
+    */
     public async getLevels(): Promise<TLevel[]> {
         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. */
+     * 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
      */
@@ -94,17 +129,40 @@ export class WSAPI {
         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);
+     * });
+     * ```
+    */
     public async getUserLevelExtraCounters(): Promise<UserLevelExtraCountersT> {
         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);
+     * });
+    */
+
     public async getStoreItems(): Promise<TStoreItem[]> {
         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);
+     * });
+    */
     public async buyStoreItem(item_id: number): Promise<TBuyStoreItemResult> {
         const r = await this.api.buyStoreItem(null, item_id);
 
@@ -121,7 +179,23 @@ export class WSAPI {
         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
+    */
+    public async storeGetPurchasedItems({ from, to, onUpdate }: { from?: number, to?: number, onUpdate?: (data: TStoreItem[]) => void } = {}): Promise<TStoreItem[]> { 
+        if (onUpdate) {
+            this.onUpdateCallback.set(onUpdateContextKey.StoreHistory, onUpdate);
+        }
+
+        return await this.api.storeGetPurchasedItemsT(null, from, to);
+    }
+
+    /** Returns missions & badges categories */
     public async getAchCategories(): Promise<TAchCategory[]> {
         return OCache.use(onUpdateContextKey.AchCategories, ECacheContext.WSAPI, () => this.api.achGetCategoriesT(null), CACHE_DATA_SEC);
     }

package/src/WSAPI/WSAPITypes.ts

@@ -377,6 +377,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;
 }
 
 /** 

package/src/index.ts

@@ -11,4 +11,5 @@ export * from './Missions';
 export * from './Store';
 export * from './Tournaments';
 export * from './Level';
-export * from './Quiz';
+export * from './Quiz';
+export * from './Jackpots';

package/src/Store/StorItemPruchased.ts

@@ -1,8 +0,0 @@
-import { StoreItem } from "./StoreItem";
-
-interface StorItemPruchased extends StoreItem {
-    purchase_ts: number;
-    purchase_points_amount: number;
-}
-
-export { StorItemPruchased }