@smartico/public-api 0.0.136 → 0.0.138

package/docs/interfaces/JackpotPublicMeta.md

@@ -0,0 +1,57 @@
+# Interface: JackpotPublicMeta
+
+## Properties
+
+### name
+
+• **name**: `string`
+
+name of the jackpot
+
+___
+
+### description
+
+• **description**: `string`
+
+description/rules of the jackpot
+
+___
+
+### image\_url
+
+• **image\_url**: `string`
+
+image url of the jackpot
+
+___
+
+### winner\_template
+
+• **winner\_template**: [`JackpotHtmlTemplate`](JackpotHtmlTemplate.md)
+
+HTML template for the winner of the jackpt
+
+___
+
+### not\_winner\_template
+
+• **not\_winner\_template**: [`JackpotHtmlTemplate`](JackpotHtmlTemplate.md)
+
+HTML template for the not winner of the jackpot
+
+___
+
+### placeholder1
+
+• **placeholder1**: `string`
+
+custom value of placeholder1 defined by operator and can be used in the HTML templates
+
+___
+
+### placeholder2
+
+• **placeholder2**: `string`
+
+custom value of placeholder2 defined by operator and can be used in the HTML templates

package/docs/interfaces/JackpotWinPush.md

@@ -0,0 +1,49 @@
+# Interface: JackpotWinPush
+
+## Hierarchy
+
+- `ProtocolMessage`
+
+  ↳ **`JackpotWinPush`**
+
+## Properties
+
+### cid
+
+• **cid**: `number`
+
+#### Inherited from
+
+ProtocolMessage.cid
+
+___
+
+### ts
+
+• `Optional` **ts**: `number`
+
+#### Inherited from
+
+ProtocolMessage.ts
+
+___
+
+### uuid
+
+• `Optional` **uuid**: `string`
+
+#### Inherited from
+
+ProtocolMessage.uuid
+
+___
+
+### jackpot
+
+• **jackpot**: [`JackpotDetails`](JackpotDetails.md)
+
+___
+
+### winners
+
+• **winners**: [`JackPotWinner`](JackPotWinner.md)[]

package/docs/interfaces/JackpotsOptinRequest.md

@@ -0,0 +1,43 @@
+# Interface: JackpotsOptinRequest
+
+## Hierarchy
+
+- `ProtocolMessage`
+
+  ↳ **`JackpotsOptinRequest`**
+
+## Properties
+
+### cid
+
+• **cid**: `number`
+
+#### Inherited from
+
+ProtocolMessage.cid
+
+___
+
+### ts
+
+• `Optional` **ts**: `number`
+
+#### Inherited from
+
+ProtocolMessage.ts
+
+___
+
+### uuid
+
+• `Optional` **uuid**: `string`
+
+#### Inherited from
+
+ProtocolMessage.uuid
+
+___
+
+### jp\_template\_id
+
+• **jp\_template\_id**: `number`

package/docs/interfaces/JackpotsOptinResponse.md

@@ -0,0 +1,57 @@
+# Interface: JackpotsOptinResponse
+
+## Hierarchy
+
+- `ProtocolResponse`
+
+  ↳ **`JackpotsOptinResponse`**
+
+## Properties
+
+### cid
+
+• **cid**: `number`
+
+#### Inherited from
+
+ProtocolResponse.cid
+
+___
+
+### ts
+
+• `Optional` **ts**: `number`
+
+#### Inherited from
+
+ProtocolResponse.ts
+
+___
+
+### uuid
+
+• `Optional` **uuid**: `string`
+
+#### Inherited from
+
+ProtocolResponse.uuid
+
+___
+
+### errCode
+
+• `Optional` **errCode**: `number`
+
+#### Inherited from
+
+ProtocolResponse.errCode
+
+___
+
+### errMsg
+
+• `Optional` **errMsg**: `string`
+
+#### Inherited from
+
+ProtocolResponse.errMsg

package/docs/interfaces/JackpotsOptoutRequest.md

@@ -0,0 +1,43 @@
+# Interface: JackpotsOptoutRequest
+
+## Hierarchy
+
+- `ProtocolMessage`
+
+  ↳ **`JackpotsOptoutRequest`**
+
+## Properties
+
+### cid
+
+• **cid**: `number`
+
+#### Inherited from
+
+ProtocolMessage.cid
+
+___
+
+### ts
+
+• `Optional` **ts**: `number`
+
+#### Inherited from
+
+ProtocolMessage.ts
+
+___
+
+### uuid
+
+• `Optional` **uuid**: `string`
+
+#### Inherited from
+
+ProtocolMessage.uuid
+
+___
+
+### jp\_template\_id
+
+• **jp\_template\_id**: `number`

package/docs/interfaces/JackpotsOptoutResponse.md

@@ -0,0 +1,57 @@
+# Interface: JackpotsOptoutResponse
+
+## Hierarchy
+
+- `ProtocolResponse`
+
+  ↳ **`JackpotsOptoutResponse`**
+
+## Properties
+
+### cid
+
+• **cid**: `number`
+
+#### Inherited from
+
+ProtocolResponse.cid
+
+___
+
+### ts
+
+• `Optional` **ts**: `number`
+
+#### Inherited from
+
+ProtocolResponse.ts
+
+___
+
+### uuid
+
+• `Optional` **uuid**: `string`
+
+#### Inherited from
+
+ProtocolResponse.uuid
+
+___
+
+### errCode
+
+• `Optional` **errCode**: `number`
+
+#### Inherited from
+
+ProtocolResponse.errCode
+
+___
+
+### errMsg
+
+• `Optional` **errMsg**: `string`
+
+#### Inherited from
+
+ProtocolResponse.errMsg

package/docs/interfaces/LeaderBoardDetailsT.md

@@ -36,7 +36,7 @@ ___
 
 ### period\_type\_id
 
-• **period\_type\_id**: `LeaderBoardPeriodType`
+• **period\_type\_id**: [`LeaderBoardPeriodType`](../enums/LeaderBoardPeriodType.md)
 
 Leaderboard period type ID
 

package/docs/interfaces/TAchCategory.md

@@ -8,14 +8,20 @@ TAchCategory describes the badge category item. Each badge item can be assigned
 
 • **id**: `number`
 
+ID of the badge category
+
 ___
 
 ### name
 
 • **name**: `string`
 
+Name of the badge category
+
 ___
 
 ### order
 
 • **order**: `number`
+
+Order of the badge category among other categories. Default value is 1

package/docs/interfaces/TMiniGameTemplate.md

@@ -143,3 +143,5 @@ ___
 ### prizes
 
 • **prizes**: [`TMiniGamePrize`](TMiniGamePrize.md)[]
+
+List of prizes for mini-games

package/docs/interfaces/TMissionOrBadge.md

@@ -170,7 +170,7 @@ ___
 
 ### related\_games
 
-• `Optional` **related\_games**: [`AchRelatedGame`](AchRelatedGame.md)[]
+• `Optional` **related\_games**: [`AchRelatedGame`](AchRelatedGame-1.md)[]
 
 List of casino games (or other types of entities) related to the mission or badge
 
@@ -232,23 +232,22 @@ The date/timestamp indicating when the prize was claimed by the user
 
 ___
 
-### completed\_date
+### complete\_date
 
-• `Optional` **completed\_date**: `string`
+• `Optional` **complete\_date**: `string`
 
 Time in hours that took this player to complete mission
 
 ___
 
-### completed\_date_ts
+### complete\_date\_ts
 
-• `Optional` **completed\_date\_ts**: `number`
+• `Optional` **complete\_date\_ts**: `number`
 
 Time of mission/badge being completed, this property shows the epoch time in UTC
 
 ___
 
-
 ### completed\_today
 
 • `Optional` **completed\_today**: `boolean`
@@ -269,4 +268,4 @@ ___
 
 • `Optional` **completed\_this\_month**: `boolean`
 
-Flag for mission/badge indicating that mission/badge completed this month
+Flag for mission/badge indicating that mission/badge completed this month

package/docs/interfaces/TStoreCategory.md

@@ -8,14 +8,20 @@ TStoreCategory describes the store category item. Each store item can be assigne
 
 • **id**: `number`
 
+ID of the store category
+
 ___
 
 ### name
 
 • **name**: `string`
 
+Name of the store category
+
 ___
 
 ### order
 
 • **order**: `number`
+
+Order of the store category among other categories. Default value is 1

package/docs/interfaces/TTournament.md

@@ -54,6 +54,12 @@ ___
 
 ___
 
+### image2\_mobile
+
+• **image2\_mobile**: `string`
+
+___
+
 ### prize\_pool\_short
 
 • **prize\_pool\_short**: `string`

package/docs/interfaces/TTournamentDetailed.md

@@ -78,6 +78,16 @@ ___
 
 ___
 
+### image2\_mobile
+
+• **image2\_mobile**: `string`
+
+#### Inherited from
+
+[TTournament](TTournament.md).[image2_mobile](TTournament.md#image2_mobile)
+
+___
+
 ### prize\_pool\_short
 
 • **prize\_pool\_short**: `string`
@@ -365,7 +375,7 @@ ___
 
 ### related\_games
 
-• `Optional` **related\_games**: [`AchRelatedGame`](AchRelatedGame.md)[]
+• `Optional` **related\_games**: [`AchRelatedGame`](AchRelatedGame-1.md)[]
 
 List of casino games (or other types of entities) related to the tournament
 

package/package.json

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

package/src/Base/AchRelatedGame.ts

@@ -1,6 +1,8 @@
 interface AchRelatedGame {
+    /* ID of the game on Smartico side */
     ach_game_id: number;
-    ext_game_id: string;
+    /* ID of the game on operator side */
+    ext_game_id: string;    
     game_public_meta: {
         name: string;
         link: string;

package/src/Jackpots/JackpotDetails.ts

@@ -4,15 +4,31 @@ 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;
 }
 

package/src/Jackpots/JackpotPot.ts

@@ -1,8 +1,14 @@
 
 interface JackpotPot {
+    /** ID of the jackpot template */
     jp_template_id: number;
+    /** ID of the jackpot pot */
     jp_pot_id: number;
-    current_pot_amount: 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;
 }
 

package/src/Jackpots/JackpotPublicMeta.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;
 }
 

package/src/MiniGames/SAWTemplateUI.ts

@@ -43,8 +43,8 @@ export interface SAWTemplateUI {
 
 
     // prize drop specific
-    placeholder_1?: string;
-    placeholder_2?: string;
+    placeholder1?: string;
+    placeholder2?: string;
     prize_drop_template?: {
         id: string;
         content: string;

package/src/SmarticoAPI.ts

@@ -464,19 +464,18 @@ 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,
+            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;
-
+    public async storeGetPurchasedItemsT(user_ext_id: string, limit?: number, offset?: number): Promise<TStoreItem[]> {
         return StoreItemPurchasedTransform((await this.storeGetPurchasedItems(user_ext_id, limit, offset)).items);
     }
 

package/src/SmarticoLib/index.ts

@@ -410,8 +410,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;
@@ -514,6 +514,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/src/Store/GetStoreHistoryRequest.ts

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

package/src/Store/GetStoreHistoryResponse.ts

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

package/src/Tournaments/Tournament.ts

@@ -73,6 +73,7 @@ export const TournamentItemsTransform = (items: Tournament[]): TTournament[] =>
             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,