@smartico/public-api 0.0.252 → 0.0.253

package/docs/README.md

@@ -10,6 +10,8 @@
 - [MiniGamePrizeTypeName](enums/MiniGamePrizeTypeName.md)
 - [SAWSpinErrorCode](enums/SAWSpinErrorCode.md)
 - [AchievementAvailabilityStatus](enums/AchievementAvailabilityStatus.md)
+- [RaffleDrawInstanceState](enums/RaffleDrawInstanceState.md)
+- [RaffleDrawTypeExecution](enums/RaffleDrawTypeExecution.md)
 - [BuyStoreItemErrorCode](enums/BuyStoreItemErrorCode.md)
 - [TournamentRegistrationError](enums/TournamentRegistrationError.md)
 - [TournamentRegistrationStatusName](enums/TournamentRegistrationStatusName.md)
@@ -17,6 +19,9 @@
 ## Interfaces
 
 - [AchRelatedGame](interfaces/AchRelatedGame.md)
+- [GetJackpotWinnersRequest](interfaces/GetJackpotWinnersRequest.md)
+- [GetJackpotWinnersResponse](interfaces/GetJackpotWinnersResponse.md)
+- [JackpotWinnerHistory](interfaces/JackpotWinnerHistory.md)
 - [GetJackpotsPotsRequest](interfaces/GetJackpotsPotsRequest.md)
 - [GetJackpotsPotsResponse](interfaces/GetJackpotsPotsResponse.md)
 - [GetJackpotsRequest](interfaces/GetJackpotsRequest.md)
@@ -76,6 +81,13 @@
 - [TBonus](interfaces/TBonus.md)
 - [TClaimBonusResult](interfaces/TClaimBonusResult.md)
 - [TSawHistory](interfaces/TSawHistory.md)
+- [TRaffle](interfaces/TRaffle.md)
+- [TRaffleTicket](interfaces/TRaffleTicket.md)
+- [TRafflePrize](interfaces/TRafflePrize.md)
+- [TRafflePrizeWinner](interfaces/TRafflePrizeWinner.md)
+- [TRaffleDraw](interfaces/TRaffleDraw.md)
+- [TRaffleDrawRun](interfaces/TRaffleDrawRun.md)
+- [TransformedRaffleClaimPrizeResponse](interfaces/TransformedRaffleClaimPrizeResponse.md)
 
 ## General API
 
@@ -86,3 +98,131 @@
 ### TournamentRegistrationTypeName
 
 Ƭ **TournamentRegistrationTypeName**: ``"AUTO"`` \| ``"OPT_IN"`` \| ``"BUY_IN_POINTS"`` \| ``"MANUAL_APPROVAL"`` \| ``"REQUIRES_QUALIFICATION"`` \| ``"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

@@ -957,6 +957,38 @@ _smartico.api.jackpotOptOut({ jp_template_id: 123 }).then((result) => {
 
 ___
 
+### getJackpotWinners
+
+▸ **getJackpotWinners**(`«destructured»`): `Promise`\<[`JackpotWinnerHistory`](../interfaces/JackpotWinnerHistory.md)[]\>
+
+Returns the winners of the jackpot with the specified jp_template_id.
+
+**Example**:
+```
+_smartico.api.getJackpotWinners({
+     jp_template_id: 123,
+}).then((result) => {
+     console.log(result);
+});
+```
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `limit?` | `number` |
+| › `offset?` | `number` |
+| › `jp_template_id?` | `number` |
+
+#### Returns
+
+`Promise`\<[`JackpotWinnerHistory`](../interfaces/JackpotWinnerHistory.md)[]\>
+
+___
+
 ### getRelatedItemsForGame
 
 ▸ **getRelatedItemsForGame**(`related_game_id`): `Promise`\<`GetRelatedAchTourResponse`\>
@@ -992,56 +1024,114 @@ ___
 
 ### getRaffles
 
-▸ **getRaffles**(): `Promise`\<[`GetRafflesResponse`](../interfaces/GetRafflesResponse.md)\>
+▸ **getRaffles**(`«destructured»?`): `Promise`\<[`TRaffle`](../interfaces/TRaffle.md)[]\>
+
+Returns the list of Raffles available for user
+The returned list of Raffles is cached for 30 seconds. But you can pass the onUpdate callback as a parameter. Note that each time you call getRaffles with a new onUpdate callback, the old one will be overwritten by the new one.
+The onUpdate callback will be called on claiming prize.  Updated Raffles will be passed to onUpdate callback.
+
+**Example**:
+```
+_smartico.api.getRaffles().then((result) => {
+     console.log(result);
+});
+```
+
+**Visitor mode: not supported**
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `«destructured»` | `Object` |
+| › `onUpdate?` | (`data`: [`TRaffle`](../interfaces/TRaffle.md)[]) => `void` |
 
 #### Returns
 
-`Promise`\<[`GetRafflesResponse`](../interfaces/GetRafflesResponse.md)\>
+`Promise`\<[`TRaffle`](../interfaces/TRaffle.md)[]\>
 
 ___
 
-### getDrawRun
+### getRaffleDrawRun
+
+▸ **getRaffleDrawRun**(`props`): `Promise`\<[`TRaffleDraw`](../interfaces/TRaffleDraw.md)\>
 
-▸ **getDrawRun**(`payload`): `Promise`\<[`GetDrawRunResponse`](../interfaces/GetDrawRunResponse.md)\>
+Returns draw run for provided raffle_id and run_id
+
+**Example**:
+```
+_smartico.api.getRaffleDrawRun({raffle_id:156, run_id: 145}).then((result) => {
+     console.log(result);
+});
+```
+
+**Visitor mode: not supported**
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `payload` | [`GetDrawRunRequest`](../interfaces/GetDrawRunRequest.md) |
+| `props` | `Object` |
+| `props.raffle_id` | `number` |
+| `props.run_id` | `number` |
 
 #### Returns
 
-`Promise`\<[`GetDrawRunResponse`](../interfaces/GetDrawRunResponse.md)\>
+`Promise`\<[`TRaffleDraw`](../interfaces/TRaffleDraw.md)\>
 
 ___
 
 ### getRaffleDrawRunsHistory
 
-▸ **getRaffleDrawRunsHistory**(`payload`): `Promise`\<[`GetRaffleDrawRunsHistoryResponse`](../interfaces/GetRaffleDrawRunsHistoryResponse.md)\>
+▸ **getRaffleDrawRunsHistory**(`props`): `Promise`\<[`TRaffleDrawRun`](../interfaces/TRaffleDrawRun.md)[]\>
+
+Returns history of draw runs for the provided raffle_id and draw_id, if the draw_id is not provided will return history of all the draws for the provided raffle_id
+
+**Example**:
+```
+_smartico.api.getRaffleDrawRunHistory({raffle_id:156, draw_id: 432}).then((result) => {
+     console.log(result);
+});
+```
+
+**Visitor mode: not supported**
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `payload` | [`GetRaffleDrawRunsHistoryRequest`](../interfaces/GetRaffleDrawRunsHistoryRequest.md) |
+| `props` | `Object` |
+| `props.raffle_id` | `number` |
+| `props.draw_id?` | `number` |
 
 #### Returns
 
-`Promise`\<[`GetRaffleDrawRunsHistoryResponse`](../interfaces/GetRaffleDrawRunsHistoryResponse.md)\>
+`Promise`\<[`TRaffleDrawRun`](../interfaces/TRaffleDrawRun.md)[]\>
 
 ___
 
 ### claimRafflePrize
 
-▸ **claimRafflePrize**(`payload`): `Promise`\<[`RaffleClaimPrizeResponse`](../interfaces/RaffleClaimPrizeResponse.md)\>
+▸ **claimRafflePrize**(`props`): `Promise`\<[`TransformedRaffleClaimPrizeResponse`](../interfaces/TransformedRaffleClaimPrizeResponse.md)\>
+
+Returns error code, and error Message after calling the function, error message 0 - means that the request was successful
+
+**Example**:
+```
+_smartico.api.claimRafflePrize({won_id:251}).then((result) => {
+     console.log(result);
+});
+```
+
+**Visitor mode: not supported**
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `payload` | [`RaffleClaimPrizeRequest`](../interfaces/RaffleClaimPrizeRequest.md) |
+| `props` | `Object` |
+| `props.won_id` | `number` |
 
 #### Returns
 
-`Promise`\<[`RaffleClaimPrizeResponse`](../interfaces/RaffleClaimPrizeResponse.md)\>
+`Promise`\<[`TransformedRaffleClaimPrizeResponse`](../interfaces/TransformedRaffleClaimPrizeResponse.md)\>

package/docs/enums/RaffleDrawInstanceState.md

@@ -0,0 +1,25 @@
+# Enumeration: RaffleDrawInstanceState
+
+## Enumeration Members
+
+### Open
+
+• **Open** = ``1``
+
+Draw is open for the tickets collection
+
+___
+
+### WinnerSelection
+
+• **WinnerSelection** = ``2``
+
+Winner selection is in progress
+
+___
+
+### Executed
+
+• **Executed** = ``3``
+
+Draw is executed and the winners are selected

package/docs/enums/RaffleDrawTypeExecution.md

@@ -0,0 +1,27 @@
+# Enumeration: RaffleDrawTypeExecution
+
+## Enumeration Members
+
+### ExecDate
+
+• **ExecDate** = ``0``
+
+Draw is executed only once
+
+___
+
+### Recurring
+
+• **Recurring** = ``1``
+
+Draw is executed on a recurring basis
+
+___
+
+### Grand
+
+• **Grand** = ``2``
+
+Draw is executed once and is marked as grand.
+This means it is a special or significant draw,
+often with larger prizes or more importance.

package/docs/interfaces/GetJackpotWinnersRequest.md

@@ -0,0 +1,91 @@
+# Interface: GetJackpotWinnersRequest
+
+## Hierarchy
+
+- `ProtocolRequest`
+
+  ↳ **`GetJackpotWinnersRequest`**
+
+## Properties
+
+### cid
+
+• **cid**: `number`
+
+#### Inherited from
+
+ProtocolRequest.cid
+
+___
+
+### ts
+
+• `Optional` **ts**: `number`
+
+#### Inherited from
+
+ProtocolRequest.ts
+
+___
+
+### uuid
+
+• `Optional` **uuid**: `string`
+
+#### Inherited from
+
+ProtocolRequest.uuid
+
+___
+
+### api\_key
+
+• **api\_key**: `string`
+
+#### Inherited from
+
+ProtocolRequest.api\_key
+
+___
+
+### brand\_key
+
+• **brand\_key**: `string`
+
+#### Inherited from
+
+ProtocolRequest.brand\_key
+
+___
+
+### ext\_user\_id
+
+• **ext\_user\_id**: `string`
+
+#### Inherited from
+
+ProtocolRequest.ext\_user\_id
+
+___
+
+### jp\_template\_id
+
+• **jp\_template\_id**: `number`
+
+The ID of the jackpot template
+
+___
+
+### limit
+
+• **limit**: `number`
+
+The number of winners to return
+
+___
+
+### offset
+
+• **offset**: `number`
+
+The offset of the winners to return

package/docs/interfaces/GetJackpotWinnersResponse.md

@@ -0,0 +1,73 @@
+# Interface: GetJackpotWinnersResponse
+
+## Hierarchy
+
+- `ProtocolResponse`
+
+  ↳ **`GetJackpotWinnersResponse`**
+
+## 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
+
+___
+
+### winners
+
+• **winners**: [`JackpotWinnerHistory`](JackpotWinnerHistory.md)[]
+
+The list of jackpot winners
+
+___
+
+### has\_more
+
+• **has\_more**: `boolean`
+
+Whether there are more winners to fetch

package/docs/interfaces/JackpotWinnerHistory.md

@@ -0,0 +1,25 @@
+# Interface: JackpotWinnerHistory
+
+## Properties
+
+### jp\_pot\_id
+
+• **jp\_pot\_id**: `number`
+
+Id of the jackpot pot
+
+___
+
+### win\_date\_ts
+
+• **win\_date\_ts**: `number`
+
+Date of winning in milliseconds
+
+___
+
+### winner
+
+• **winner**: [`JackPotWinner`](JackPotWinner.md)
+
+Info about jackpot winner

package/docs/interfaces/RaffleClaimPrizeResponse.md

@@ -40,9 +40,9 @@ ___
 
 ### errCode
 
-• `Optional` **errCode**: `number`
+• **errCode**: `number`
 
-#### Inherited from
+#### Overrides
 
 ProtocolResponse.errCode
 
@@ -52,6 +52,6 @@ ___
 
 • `Optional` **errMsg**: `string`
 
-#### Inherited from
+#### Overrides
 
 ProtocolResponse.errMsg

package/docs/interfaces/RaffleDraw.md

@@ -29,7 +29,7 @@ ___
 
 ### current\_state
 
-• **current\_state**: `RaffleDrawInstanceState`
+• **current\_state**: [`RaffleDrawInstanceState`](../enums/RaffleDrawInstanceState.md)
 
 State of current instance of Draw
 
@@ -45,7 +45,7 @@ ___
 
 ### execution\_type
 
-• **execution\_type**: `RaffleDrawTypeExecution`
+• **execution\_type**: [`RaffleDrawTypeExecution`](../enums/RaffleDrawTypeExecution.md)
 
 Type of the draw execution, indicating how and when the draw is executed.
 - ExecDate: Draw is executed only once at a specific date and time.

package/docs/interfaces/TRaffle.md

@@ -0,0 +1,101 @@
+# Interface: TRaffle
+
+## Properties
+
+### id
+
+• **id**: `number`
+
+ID of the Raffle template
+
+___
+
+### 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
+
+___
+
+### 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
+
+___
+
+### start\_date
+
+• **start\_date**: `number`
+
+Date of start
+
+___
+
+### end\_date
+
+• **end\_date**: `number`
+
+Date of end
+
+___
+
+### max\_tickets\_count
+
+• **max\_tickets\_count**: `number`
+
+Maximum numer of tickets that can be given to all users for the whole period of raffle
+
+___
+
+### current\_tickets\_count
+
+• **current\_tickets\_count**: `number`
+
+Number of tickets that are already given to all users for this raffle
+
+___
+
+### draws
+
+• **draws**: [`TRaffleDraw`](TRaffleDraw.md)[]
+
+List of draws that are available for this raffle.
+For example, if the raffle is containg one hourly draw, one daily draw and one draw on fixed date like 01/01/2022,
+Then the list will always return 3 draws, no matter if the draws are already executed or they are in the future.