@smartico/public-api 0.0.136 → 0.0.138

package/docs/README.md

@@ -2,6 +2,9 @@
 
 ## Enumerations
 
+- [JackpotContributionType](enums/JackpotContributionType.md)
+- [JackpotType](enums/JackpotType.md)
+- [LeaderBoardPeriodType](enums/LeaderBoardPeriodType.md)
 - [SAWBuyInTypeName](enums/SAWBuyInTypeName.md)
 - [SAWGameTypeName](enums/SAWGameTypeName.md)
 - [MiniGamePrizeTypeName](enums/MiniGamePrizeTypeName.md)
@@ -12,6 +15,21 @@
 
 ## Interfaces
 
+- [AchRelatedGame](interfaces/AchRelatedGame.md)
+- [GetJackpotsPotsRequest](interfaces/GetJackpotsPotsRequest.md)
+- [GetJackpotsPotsResponse](interfaces/GetJackpotsPotsResponse.md)
+- [GetJackpotsRequest](interfaces/GetJackpotsRequest.md)
+- [GetJackpotsResponse](interfaces/GetJackpotsResponse.md)
+- [JackPotWinner](interfaces/JackPotWinner.md)
+- [JackpotDetails](interfaces/JackpotDetails.md)
+- [JackpotHtmlTemplate](interfaces/JackpotHtmlTemplate.md)
+- [JackpotPot](interfaces/JackpotPot.md)
+- [JackpotPublicMeta](interfaces/JackpotPublicMeta.md)
+- [JackpotWinPush](interfaces/JackpotWinPush.md)
+- [JackpotsOptinRequest](interfaces/JackpotsOptinRequest.md)
+- [JackpotsOptinResponse](interfaces/JackpotsOptinResponse.md)
+- [JackpotsOptoutRequest](interfaces/JackpotsOptoutRequest.md)
+- [JackpotsOptoutResponse](interfaces/JackpotsOptoutResponse.md)
 - [TMiniGamePrize](interfaces/TMiniGamePrize.md)
 - [TMiniGamePlayResult](interfaces/TMiniGamePlayResult.md)
 - [TMiniGameTemplate](interfaces/TMiniGameTemplate.md)
@@ -23,7 +41,7 @@
 - [TStoreItem](interfaces/TStoreItem.md)
 - [TAchCategory](interfaces/TAchCategory.md)
 - [TMissionOrBadge](interfaces/TMissionOrBadge.md)
-- [AchRelatedGame](interfaces/AchRelatedGame.md)
+- [AchRelatedGame](interfaces/AchRelatedGame-1.md)
 - [TMissionOrBadgeTask](interfaces/TMissionOrBadgeTask.md)
 - [TMissionOptInResult](interfaces/TMissionOptInResult.md)
 - [TMissionClaimRewardResult](interfaces/TMissionClaimRewardResult.md)

package/docs/classes/WSAPI.md

@@ -199,18 +199,19 @@ Returns store categories
 
 ___
 
-### storeGetPurchasedItems
+### getStorePurchasedItems
 
-▸ **storeGetPurchasedItems**(`params?`): `Promise`<[`TStoreItem`](../interfaces/TStoreItem.md)[]\>
+▸ **getStorePurchasedItems**(): `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 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);
+ });
+```
 
 #### Returns
 
@@ -369,7 +370,7 @@ For example, if the type is Weekly and getPreviousPeriod is true, a leaderboard
 
 | Name | Type |
 | :------ | :------ |
-| `periodType` | `LeaderBoardPeriodType` |
+| `periodType` | [`LeaderBoardPeriodType`](../enums/LeaderBoardPeriodType.md) |
 | `getPreviousPeriod?` | `boolean` |
 
 #### Returns
@@ -510,3 +511,84 @@ Requests translations for the given language. Returns the object including trans
 #### Returns
 
 `Promise`<[`TGetTranslations`](../interfaces/TGetTranslations.md)\>
+
+___
+
+### jackpotGet
+
+▸ **jackpotGet**(`filter?`): `Promise`<[`JackpotDetails`](../interfaces/JackpotDetails.md)[]\>
+
+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);
+});
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `filter?` | `Object` |
+| `filter.related_game_id?` | `string` |
+| `filter.jp_template_id?` | `number` |
+
+#### Returns
+
+`Promise`<[`JackpotDetails`](../interfaces/JackpotDetails.md)[]\>
+
+___
+
+### jackpotOptIn
+
+▸ **jackpotOptIn**(`filter`): `Promise`<[`JackpotsOptinResponse`](../interfaces/JackpotsOptinResponse.md)\>
+
+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');
+});
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `filter` | `Object` |
+| `filter.jp_template_id` | `number` |
+
+#### Returns
+
+`Promise`<[`JackpotsOptinResponse`](../interfaces/JackpotsOptinResponse.md)\>
+
+___
+
+### jackpotOptOut
+
+▸ **jackpotOptOut**(`filter`): `Promise`<[`JackpotsOptoutResponse`](../interfaces/JackpotsOptoutResponse.md)\>
+
+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');
+});
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `filter` | `Object` |
+| `filter.jp_template_id` | `number` |
+
+#### Returns
+
+`Promise`<[`JackpotsOptoutResponse`](../interfaces/JackpotsOptoutResponse.md)\>

package/docs/enums/JackpotContributionType.md

@@ -0,0 +1,13 @@
+# Enumeration: JackpotContributionType
+
+## Enumeration Members
+
+### Fixed
+
+• **Fixed** = ``1``
+
+___
+
+### Percentage
+
+• **Percentage** = ``2``

package/docs/enums/JackpotType.md

@@ -0,0 +1,7 @@
+# Enumeration: JackpotType
+
+## Enumeration Members
+
+### Main
+
+• **Main** = ``1``

package/docs/enums/LeaderBoardPeriodType.md

@@ -0,0 +1,19 @@
+# Enumeration: LeaderBoardPeriodType
+
+## Enumeration Members
+
+### DAILY
+
+• **DAILY** = ``1``
+
+___
+
+### WEEKLY
+
+• **WEEKLY** = ``2``
+
+___
+
+### MONTHLY
+
+• **MONTHLY** = ``3``

package/docs/enums/SAWGameTypeName.md

@@ -32,6 +32,12 @@ ___
 
 ___
 
+### Quiz
+
+• **Quiz** = ``"quiz"``
+
+___
+
 ### Unknown
 
 • **Unknown** = ``"unknown"``

package/docs/interfaces/AchRelatedGame-1.md

@@ -0,0 +1,28 @@
+# Interface: AchRelatedGame
+
+## Properties
+
+### ext\_game\_id
+
+• **ext\_game\_id**: `string`
+
+The ID of the related game
+
+___
+
+### game\_public\_meta
+
+• **game\_public\_meta**: `Object`
+
+Game public meta information
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `name` | `string` | The name of the game |
+| `link` | `string` | The URL to the game |
+| `image` | `string` | The URL to the image of the game |
+| `enabled` | `boolean` | The indicator if the game is enabled |
+| `game_categories` | `string`[] | The list of categories of the game |
+| `game_provider` | `string` | The name of the game provider |

package/docs/interfaces/AchRelatedGame.md

@@ -2,27 +2,29 @@
 
 ## Properties
 
+### ach\_game\_id
+
+• **ach\_game\_id**: `number`
+
+___
+
 ### ext\_game\_id
 
 • **ext\_game\_id**: `string`
 
-The ID of the related game
-
 ___
 
 ### game\_public\_meta
 
 • **game\_public\_meta**: `Object`
 
-Game public meta information
-
 #### Type declaration
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `name` | `string` | The name of the game |
-| `link` | `string` | The URL to the game |
-| `image` | `string` | The URL to the image of the game |
-| `enabled` | `boolean` | The indicator if the game is enabled |
-| `game_categories` | `string`[] | The list of categories of the game |
-| `game_provider` | `string` | The name of the game provider |
+| Name | Type |
+| :------ | :------ |
+| `name` | `string` |
+| `link` | `string` |
+| `image` | `string` |
+| `enabled` | `boolean` |
+| `game_categories?` | `string`[] |
+| `game_provider?` | `string` |

package/docs/interfaces/GetJackpotsPotsRequest.md

@@ -0,0 +1,43 @@
+# Interface: GetJackpotsPotsRequest
+
+## Hierarchy
+
+- `ProtocolMessage`
+
+  ↳ **`GetJackpotsPotsRequest`**
+
+## 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\_ids
+
+• **jp\_template\_ids**: `number`[]

package/docs/interfaces/GetJackpotsPotsResponse.md

@@ -0,0 +1,63 @@
+# Interface: GetJackpotsPotsResponse
+
+## Hierarchy
+
+- `ProtocolResponse`
+
+  ↳ **`GetJackpotsPotsResponse`**
+
+## 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
+
+___
+
+### items
+
+• **items**: [`JackpotPot`](JackpotPot.md)[]

package/docs/interfaces/GetJackpotsRequest.md

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

package/docs/interfaces/GetJackpotsResponse.md

@@ -0,0 +1,63 @@
+# Interface: GetJackpotsResponse
+
+## Hierarchy
+
+- `ProtocolResponse`
+
+  ↳ **`GetJackpotsResponse`**
+
+## 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
+
+___
+
+### items
+
+• **items**: [`JackpotDetails`](JackpotDetails.md)[]

package/docs/interfaces/JackPotWinner.md

@@ -0,0 +1,31 @@
+# Interface: JackPotWinner
+
+## Properties
+
+### is\_me
+
+• **is\_me**: `boolean`
+
+___
+
+### public\_username
+
+• **public\_username**: `string`
+
+___
+
+### winning\_amount\_jp\_currency
+
+• **winning\_amount\_jp\_currency**: `number`
+
+___
+
+### winning\_amount\_wallet\_currency
+
+• **winning\_amount\_wallet\_currency**: `number`
+
+___
+
+### winning\_position
+
+• **winning\_position**: `number`

package/docs/interfaces/JackpotDetails.md

@@ -0,0 +1,85 @@
+# Interface: JackpotDetails
+
+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
+
+## Properties
+
+### jp\_template\_id
+
+• **jp\_template\_id**: `number`
+
+ID of the jackpot template
+
+___
+
+### jp\_type\_id
+
+• **jp\_type\_id**: [`Main`](../enums/JackpotType.md#main)
+
+type of jackpot logic
+
+___
+
+### jp\_public\_meta
+
+• **jp\_public\_meta**: [`JackpotPublicMeta`](JackpotPublicMeta.md)
+
+UI information of jackpot, like name, description, etc.
+
+___
+
+### jp\_currency
+
+• **jp\_currency**: `string`
+
+base currency of the jackpot
+
+___
+
+### user\_currency
+
+• **user\_currency**: `string`
+
+wallet currency of currently logged in user
+
+___
+
+### related\_games
+
+• `Optional` **related\_games**: [`AchRelatedGame`](AchRelatedGame.md)[]
+
+list of related games that are eligible for the jackpot
+
+___
+
+### contribution\_type
+
+• **contribution\_type**: [`JackpotContributionType`](../enums/JackpotContributionType.md)
+
+type of the user contribution to the jackpot
+
+___
+
+### contribution\_value
+
+• **contribution\_value**: `number`
+
+value of the user contribution. Fixed amount or percentage of bet depending on the contribution type
+
+___
+
+### pot
+
+• **pot**: [`JackpotPot`](JackpotPot.md)
+
+information of current value of the jackpot
+
+___
+
+### is\_opted\_in
+
+• **is\_opted\_in**: `boolean`
+
+indication if the current user is opted in to the jackpot

package/docs/interfaces/JackpotHtmlTemplate.md

@@ -0,0 +1,13 @@
+# Interface: JackpotHtmlTemplate
+
+## Properties
+
+### id
+
+• **id**: `string`
+
+___
+
+### content
+
+• **content**: `string`

package/docs/interfaces/JackpotPot.md

@@ -0,0 +1,41 @@
+# Interface: JackpotPot
+
+## Properties
+
+### jp\_template\_id
+
+• **jp\_template\_id**: `number`
+
+ID of the jackpot template
+
+___
+
+### jp\_pot\_id
+
+• **jp\_pot\_id**: `number`
+
+ID of the jackpot pot
+
+___
+
+### current\_pot\_amount
+
+• **current\_pot\_amount**: `number`
+
+currency of the jackpot pot in the Jackput base currency
+
+___
+
+### current\_pot\_amount\_user\_currency
+
+• **current\_pot\_amount\_user\_currency**: `number`
+
+currency of the jackpot pot in the user wallet currency
+
+___
+
+### explode\_date\_ts
+
+• **explode\_date\_ts**: `number`
+
+the date/time when this pot exploded