@smartico/public-api 0.0.275 → 0.0.276

package/docs/README.md

@@ -2,10 +2,17 @@
 
 ## Enumerations
 
+- [AchCustomSectionType](enums/AchCustomSectionType.md)
+- [InboxCategories](enums/InboxCategories.md)
 - [JackpotContributionType](enums/JackpotContributionType.md)
+- [JackPotTemparature](enums/JackPotTemparature.md)
 - [JackpotType](enums/JackpotType.md)
 - [LeaderBoardPeriodType](enums/LeaderBoardPeriodType.md)
+- [PrizeModifiers](enums/PrizeModifiers.md)
+- [SAWAcknowledgeTypeName](enums/SAWAcknowledgeTypeName.md)
+- [SAWAskForUsername](enums/SAWAskForUsername.md)
 - [SAWBuyInTypeName](enums/SAWBuyInTypeName.md)
+- [SAWGameLayout](enums/SAWGameLayout.md)
 - [SAWGameTypeName](enums/SAWGameTypeName.md)
 - [MiniGamePrizeTypeName](enums/MiniGamePrizeTypeName.md)
 - [SAWSpinErrorCode](enums/SAWSpinErrorCode.md)
@@ -40,17 +47,21 @@
 - [JackpotsOptinResponse](interfaces/JackpotsOptinResponse.md)
 - [JackpotsOptoutRequest](interfaces/JackpotsOptoutRequest.md)
 - [JackpotsOptoutResponse](interfaces/JackpotsOptoutResponse.md)
+- [SAWTemplateUI](interfaces/SAWTemplateUI.md)
 - [GetDrawRunRequest](interfaces/GetDrawRunRequest.md)
 - [GetDrawRunResponse](interfaces/GetDrawRunResponse.md)
 - [GetRaffleDrawRunsHistoryRequest](interfaces/GetRaffleDrawRunsHistoryRequest.md)
 - [GetRaffleDrawRunsHistoryResponse](interfaces/GetRaffleDrawRunsHistoryResponse.md)
 - [GetRafflesRequest](interfaces/GetRafflesRequest.md)
 - [GetRafflesResponse](interfaces/GetRafflesResponse.md)
+- [RafflePublicMeta](interfaces/RafflePublicMeta.md)
 - [Raffle](interfaces/Raffle.md)
 - [RaffleClaimPrizeRequest](interfaces/RaffleClaimPrizeRequest.md)
 - [RaffleClaimPrizeResponse](interfaces/RaffleClaimPrizeResponse.md)
 - [RaffleDraw](interfaces/RaffleDraw.md)
+- [RaffleDrawPublicMeta](interfaces/RaffleDrawPublicMeta.md)
 - [RaffleDrawRun](interfaces/RaffleDrawRun.md)
+- [RafflePrizePublicMeta](interfaces/RafflePrizePublicMeta.md)
 - [RafflePrize](interfaces/RafflePrize.md)
 - [RafflePrizeWinner](interfaces/RafflePrizeWinner.md)
 - [RaffleTicket](interfaces/RaffleTicket.md)
@@ -102,131 +113,3 @@
 ### TournamentRegistrationTypeName
 
 Ƭ **TournamentRegistrationTypeName**: ``"AUTO"`` \| ``"OPT_IN"`` \| ``"BUY_IN_POINTS"`` \| ``"MANUAL_APPROVAL"`` \| ``"REQUIRES_QUALIFICATION"`` \| ``"BUY_IN_GEMS"`` \| ``"BUY_IN_DIAMONDS"`` \| ``"UNKNOWN"``
-
-## Functions
-
-### drawRunTransform
-
-▸ **drawRunTransform**(`res`): [`TRaffleDraw`](interfaces/TRaffleDraw.md)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `res` | [`GetDrawRunResponse`](interfaces/GetDrawRunResponse.md) |
-
-#### Returns
-
-[`TRaffleDraw`](interfaces/TRaffleDraw.md)
-
-___
-
-### drawRunHistoryTransform
-
-▸ **drawRunHistoryTransform**(`res`): [`TRaffleDrawRun`](interfaces/TRaffleDrawRun.md)[]
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `res` | [`GetRaffleDrawRunsHistoryResponse`](interfaces/GetRaffleDrawRunsHistoryResponse.md) |
-
-#### Returns
-
-[`TRaffleDrawRun`](interfaces/TRaffleDrawRun.md)[]
-
-___
-
-### ticketsTransform
-
-▸ **ticketsTransform**(`items`): [`TRaffleTicket`](interfaces/TRaffleTicket.md)[]
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `items` | [`RaffleTicket`](interfaces/RaffleTicket.md)[] |
-
-#### Returns
-
-[`TRaffleTicket`](interfaces/TRaffleTicket.md)[]
-
-___
-
-### winnersTransform
-
-▸ **winnersTransform**(`items`): [`TRafflePrizeWinner`](interfaces/TRafflePrizeWinner.md)[]
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `items` | [`RafflePrizeWinner`](interfaces/RafflePrizeWinner.md)[] |
-
-#### Returns
-
-[`TRafflePrizeWinner`](interfaces/TRafflePrizeWinner.md)[]
-
-___
-
-### prizeTransform
-
-▸ **prizeTransform**(`items`): [`TRafflePrize`](interfaces/TRafflePrize.md)[]
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `items` | [`RafflePrize`](interfaces/RafflePrize.md)[] |
-
-#### Returns
-
-[`TRafflePrize`](interfaces/TRafflePrize.md)[]
-
-___
-
-### drawTransform
-
-▸ **drawTransform**(`items`): [`TRaffleDraw`](interfaces/TRaffleDraw.md)[]
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `items` | [`RaffleDraw`](interfaces/RaffleDraw.md)[] |
-
-#### Returns
-
-[`TRaffleDraw`](interfaces/TRaffleDraw.md)[]
-
-___
-
-### raffleTransform
-
-▸ **raffleTransform**(`items`): [`TRaffle`](interfaces/TRaffle.md)[]
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `items` | [`Raffle`](interfaces/Raffle.md)[] |
-
-#### Returns
-
-[`TRaffle`](interfaces/TRaffle.md)[]
-
-___
-
-### raffleClaimPrizeResponseTransform
-
-▸ **raffleClaimPrizeResponseTransform**(`info`): [`TransformedRaffleClaimPrizeResponse`](interfaces/TransformedRaffleClaimPrizeResponse.md)
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `info` | [`RaffleClaimPrizeResponse`](interfaces/RaffleClaimPrizeResponse.md) |
-
-#### Returns
-
-[`TransformedRaffleClaimPrizeResponse`](interfaces/TransformedRaffleClaimPrizeResponse.md)

package/docs/classes/WSAPI.md

@@ -726,7 +726,7 @@ The "onUpdate" callback will be triggered when the user receives a new message.
 | `params.from?` | `number` |
 | `params.to?` | `number` |
 | `params.onlyFavorite?` | `boolean` |
-| `params.categoryId?` | `InboxCategories` |
+| `params.categoryId?` | [`InboxCategories`](../enums/InboxCategories.md) |
 | `params.onUpdate?` | (`data`: [`TInboxMessage`](../interfaces/TInboxMessage.md)[]) => `void` |
 
 #### Returns

package/docs/enums/AchCustomSectionType.md

@@ -0,0 +1,67 @@
+# Enumeration: AchCustomSectionType
+
+## Enumeration Members
+
+### HTML\_PAGE
+
+• **HTML\_PAGE** = ``1``
+
+___
+
+### MISSIONS\_CATEGORY
+
+• **MISSIONS\_CATEGORY** = ``2``
+
+___
+
+### TOURNAMENTS\_CATEGORY
+
+• **TOURNAMENTS\_CATEGORY** = ``3``
+
+___
+
+### LEVELS
+
+• **LEVELS** = ``4``
+
+___
+
+### MINI\_GAMES
+
+• **MINI\_GAMES** = ``5``
+
+___
+
+### MISSION\_CUSTOM\_LAYOUT
+
+• **MISSION\_CUSTOM\_LAYOUT** = ``6``
+
+___
+
+### MATCH\_X\_AND\_QUIZ
+
+• **MATCH\_X\_AND\_QUIZ** = ``7``
+
+___
+
+### REDIRECT\_LINK
+
+• **REDIRECT\_LINK** = ``9``
+
+___
+
+### LOOTBOX\_WEEKLY
+
+• **LOOTBOX\_WEEKLY** = ``10``
+
+___
+
+### LOOTBOX\_CALENDAR\_DAYS
+
+• **LOOTBOX\_CALENDAR\_DAYS** = ``11``
+
+___
+
+### TREASURE\_HUNT
+
+• **TREASURE\_HUNT** = ``12``

package/docs/enums/BuyStoreItemErrorCode.md

@@ -70,7 +70,7 @@ ___
 
 • **SHOP\_NO\_BALANCE\_GEMS** = ``11011``
 
-Not enough gems to purchase this item.
+User doesn't have enough gems on balance
 
 ___
 
@@ -78,4 +78,4 @@ ___
 
 • **SHOP\_NO\_BALANCE\_DIAMONDS** = ``11012``
 
-Not enough diamonds to purchase this item.
+User doesn't have enough diamonds on balance

package/docs/enums/InboxCategories.md

@@ -0,0 +1,19 @@
+# Enumeration: InboxCategories
+
+## Enumeration Members
+
+### General
+
+• **General** = ``0``
+
+___
+
+### Platform
+
+• **Platform** = ``1``
+
+___
+
+### Personal
+
+• **Personal** = ``2``

package/docs/enums/JackPotTemparature.md

@@ -0,0 +1,33 @@
+# Enumeration: JackPotTemparature
+
+## Enumeration Members
+
+### COLD
+
+• **COLD** = ``0``
+
+cold, seed amount < current pot < (min amount - seed amount)/2
+
+___
+
+### WARM
+
+• **WARM** = ``1``
+
+warm, (min amount - seed amount)/2 < current pot < min amount
+
+___
+
+### HOT
+
+• **HOT** = ``2``
+
+hot, current pot > min amount, entered explosion range
+
+___
+
+### BURNING
+
+• **BURNING** = ``3``
+
+burning, current pot > min amount + 0.5 * (max amount - min amount). E.g. mid of allowed explosion range

package/docs/enums/PrizeModifiers.md

@@ -0,0 +1,49 @@
+# Enumeration: PrizeModifiers
+
+## Enumeration Members
+
+### 2x
+
+• **2x** = ``1``
+
+___
+
+### 5x
+
+• **5x** = ``2``
+
+___
+
+### 10x
+
+• **10x** = ``3``
+
+___
+
+### /2
+
+• **/2** = ``4``
+
+___
+
+### /5
+
+• **/5** = ``5``
+
+___
+
+### /10
+
+• **/10** = ``6``
+
+___
+
+### 0x
+
+• **0x** = ``7``
+
+___
+
+### reset
+
+• **reset** = ``8``

package/docs/enums/SAWAcknowledgeTypeName.md

@@ -0,0 +1,25 @@
+# Enumeration: SAWAcknowledgeTypeName
+
+## Enumeration Members
+
+### Silent
+
+• **Silent** = ``"silent"``
+
+___
+
+### QuickMessage
+
+• **QuickMessage** = ``"quick-message"``
+
+___
+
+### FullMessage
+
+• **FullMessage** = ``"full-message"``
+
+___
+
+### ExplicityAcknowledge
+
+• **ExplicityAcknowledge** = ``"explicity-acknowledge"``

package/docs/enums/SAWAskForUsername.md

@@ -0,0 +1,13 @@
+# Enumeration: SAWAskForUsername
+
+## Enumeration Members
+
+### NOASK
+
+• **NOASK** = ``"no-ask"``
+
+___
+
+### ONSUMBIT
+
+• **ONSUMBIT** = ``"on-submit"``

package/docs/enums/SAWGameLayout.md

@@ -0,0 +1,13 @@
+# Enumeration: SAWGameLayout
+
+## Enumeration Members
+
+### Horizontal
+
+• **Horizontal** = ``1``
+
+___
+
+### VerticalMap
+
+• **VerticalMap** = ``2``

package/docs/enums/SAWSpinErrorCode.md

@@ -70,7 +70,7 @@ ___
 
 • **SAW\_NO\_BALANCE\_GEMS** = ``40011``
 
-Not enough gems to spin
+User doesn't have enough gems to play. In case buy in type for the game is 'gems' based
 
 ___
 
@@ -78,4 +78,4 @@ ___
 
 • **SAW\_NO\_BALANCE\_DIAMONDS** = ``40012``
 
-Not enough diamonds to spin
+User doesn't have enough diamonds to play. In case buy in type for the game is 'diamonds' based

package/docs/interfaces/JackpotPot.md

@@ -44,9 +44,6 @@ ___
 
 ### current\_pot\_temperature
 
-• **current\_pot\_temperature**: `JackPotTemparature`
+• **current\_pot\_temperature**: [`JackPotTemparature`](../enums/JackPotTemparature.md)
 
 current pot temperature
-0 - cold. seed amount < current pot < (min amount - seed amount)/2
-1 - warm. (min amount - seed amount)/2 < current pot < min amount
-2 - hot.  current pot > min amount

package/docs/interfaces/Raffle.md

@@ -12,7 +12,7 @@ ___
 
 ### public\_meta
 
-• **public\_meta**: `RafflePublicMeta`
+• **public\_meta**: [`RafflePublicMeta`](RafflePublicMeta.md)
 
 Meta information about raffle for the presentation on UI
 

package/docs/interfaces/RaffleDraw.md

@@ -13,7 +13,7 @@ ___
 
 ### public\_meta
 
-• **public\_meta**: `RaffleDrawPublicMeta`
+• **public\_meta**: [`RaffleDrawPublicMeta`](RaffleDrawPublicMeta.md)
 
 Meta information of the Draw for the presentaiton in UI
 

package/docs/interfaces/RaffleDrawPublicMeta.md

@@ -0,0 +1,65 @@
+# Interface: RaffleDrawPublicMeta
+
+## Properties
+
+### name
+
+• **name**: `string`
+
+Name of the draw, e.g. 'Daily draw'
+
+___
+
+### description
+
+• **description**: `string`
+
+Description of the draw
+
+___
+
+### image\_url
+
+• **image\_url**: `string`
+
+URL of the image that represents the draw
+
+___
+
+### image\_url\_mobile
+
+• **image\_url\_mobile**: `string`
+
+URL of the moible image that represents the draw
+
+___
+
+### icon\_url
+
+• **icon\_url**: `string`
+
+URL of the icon that represents the draw
+
+___
+
+### background\_image\_url
+
+• **background\_image\_url**: `string`
+
+URL of the background image that will be used in the draw list item
+
+___
+
+### background\_image\_url\_mobile
+
+• **background\_image\_url\_mobile**: `string`
+
+URL of the moible background image that will be used in the draw list item
+
+___
+
+### is\_grand
+
+• **is\_grand**: `boolean`
+
+Show if the draw is grand and is marked as special

package/docs/interfaces/RaffleDrawRun.md

@@ -21,7 +21,7 @@ ___
 
 ### public\_meta
 
-• **public\_meta**: `RaffleDrawPublicMeta`
+• **public\_meta**: [`RaffleDrawPublicMeta`](RaffleDrawPublicMeta.md)
 
 Meta information of the Draw for the presentaiton in UI
 

package/docs/interfaces/RafflePrize.md

@@ -14,7 +14,7 @@ ___
 
 ### public\_meta
 
-• **public\_meta**: `RafflePrizePublicMeta`
+• **public\_meta**: [`RafflePrizePublicMeta`](RafflePrizePublicMeta.md)
 
 Meta information about the prize for presentation in the UI.
 

package/docs/interfaces/RafflePrizePublicMeta.md

@@ -0,0 +1,25 @@
+# Interface: RafflePrizePublicMeta
+
+## Properties
+
+### name
+
+• **name**: `string`
+
+Name of the prize
+
+___
+
+### description
+
+• **description**: `string`
+
+Description of the prize
+
+___
+
+### image\_url
+
+• **image\_url**: `string`
+
+URL of the image that represents the prize

package/docs/interfaces/RafflePublicMeta.md

@@ -0,0 +1,59 @@
+# Interface: RafflePublicMeta
+
+## Properties
+
+### name
+
+• **name**: `string`
+
+Name of the raffle
+
+___
+
+### description
+
+• **description**: `string`
+
+Description of the raffle
+
+___
+
+### custom\_section\_id
+
+• **custom\_section\_id**: `number`
+
+ID of the custom section that is linked to the raffle in the Gamification widget
+
+___
+
+### image\_url
+
+• **image\_url**: `string`
+
+URL of the image that represents the raffle
+
+___
+
+### image\_url\_mobile
+
+• **image\_url\_mobile**: `string`
+
+URL of the mobile image that represents the raffle
+
+___
+
+### hint\_text
+
+• **hint\_text**: `string`
+
+Text for Terms and Conditions
+
+___
+
+### custom\_data
+
+• **custom\_data**: `string`
+
+Custom data as string or JSON string that can be used in API to build custom UI
+You can request from Smartico to define fields for your specific case that will be managed from Smartico BackOffice
+Read more here - https://help.smartico.ai/welcome/products/general-concepts/custom-fields-attributes