@smartico/public-api 0.0.216 → 0.0.217

package/docs/README.md

@@ -31,6 +31,15 @@
 - [JackpotsOptinResponse](interfaces/JackpotsOptinResponse.md)
 - [JackpotsOptoutRequest](interfaces/JackpotsOptoutRequest.md)
 - [JackpotsOptoutResponse](interfaces/JackpotsOptoutResponse.md)
+- [GetDrawRunRequest](interfaces/GetDrawRunRequest.md)
+- [GetDrawRunResponse](interfaces/GetDrawRunResponse.md)
+- [GetRafflesRequest](interfaces/GetRafflesRequest.md)
+- [GetRafflesResponse](interfaces/GetRafflesResponse.md)
+- [Raffle](interfaces/Raffle.md)
+- [RaffleDraw](interfaces/RaffleDraw.md)
+- [RafflePrize](interfaces/RafflePrize.md)
+- [RafflePrizeWinner](interfaces/RafflePrizeWinner.md)
+- [RaffleTicket](interfaces/RaffleTicket.md)
 - [TMiniGamePrize](interfaces/TMiniGamePrize.md)
 - [TMiniGamePlayResult](interfaces/TMiniGamePlayResult.md)
 - [TMiniGamePlayBatchResult](interfaces/TMiniGamePlayBatchResult.md)

package/docs/classes/WSAPI.md

@@ -487,7 +487,7 @@ Sends the acknowledge request with specific client_request_id from minigame hist
 **Example**:
 ```
 _smartico.api.miniGameWinAcknowledgeRequest('2a189322-31bb-4119-b943-bx7868ff8dc3').then((result) => {
-    console.log(result);
+     console.log(result);
 });
 ```
 
@@ -986,3 +986,13 @@ _smartico.vapi('EN').getRelatedItemsForGame('gold-slot2').then((result) => {
 #### Returns
 
 `Promise`\<`GetRelatedAchTourResponse`\>
+
+___
+
+### getRaffles
+
+▸ **getRaffles**(): `Promise`\<[`GetRafflesResponse`](../interfaces/GetRafflesResponse.md)\>
+
+#### Returns
+
+`Promise`\<[`GetRafflesResponse`](../interfaces/GetRafflesResponse.md)\>

package/docs/interfaces/GetDrawRunRequest.md

@@ -0,0 +1,49 @@
+# Interface: GetDrawRunRequest
+
+## Hierarchy
+
+- `ProtocolMessage`
+
+  ↳ **`GetDrawRunRequest`**
+
+## Properties
+
+### cid
+
+• **cid**: `number`
+
+#### Inherited from
+
+ProtocolMessage.cid
+
+___
+
+### ts
+
+• `Optional` **ts**: `number`
+
+#### Inherited from
+
+ProtocolMessage.ts
+
+___
+
+### uuid
+
+• `Optional` **uuid**: `string`
+
+#### Inherited from
+
+ProtocolMessage.uuid
+
+___
+
+### raffle\_id
+
+• **raffle\_id**: `number`
+
+___
+
+### instance\_id
+
+• **instance\_id**: `number`

package/docs/interfaces/GetDrawRunResponse.md

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

package/docs/interfaces/GetRafflesRequest.md

@@ -0,0 +1,37 @@
+# Interface: GetRafflesRequest
+
+## Hierarchy
+
+- `ProtocolMessage`
+
+  ↳ **`GetRafflesRequest`**
+
+## Properties
+
+### cid
+
+• **cid**: `number`
+
+#### Inherited from
+
+ProtocolMessage.cid
+
+___
+
+### ts
+
+• `Optional` **ts**: `number`
+
+#### Inherited from
+
+ProtocolMessage.ts
+
+___
+
+### uuid
+
+• `Optional` **uuid**: `string`
+
+#### Inherited from
+
+ProtocolMessage.uuid

package/docs/interfaces/GetRafflesResponse.md

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

package/docs/interfaces/Raffle.md

@@ -0,0 +1,59 @@
+# Interface: Raffle
+
+## Properties
+
+### raffle\_id
+
+• **raffle\_id**: `number`
+
+ID of the Raffle template
+
+___
+
+### public\_meta
+
+• **public\_meta**: `RafflePublicMeta`
+
+Meta information about raffle for the presentation on UI
+
+___
+
+### start\_date\_ts
+
+• **start\_date\_ts**: `number`
+
+Date of start
+
+___
+
+### end\_date\_ts
+
+• **end\_date\_ts**: `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**: [`RaffleDraw`](RaffleDraw.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.

package/docs/interfaces/RaffleDraw.md

@@ -0,0 +1,124 @@
+# Interface: RaffleDraw
+
+## Properties
+
+### draw\_definition\_id
+
+• **draw\_definition\_id**: `number`
+
+Id of the Draw definition, for the repetative draws (e.g. daily), this number will be the same for all draws that are repeating daily
+(internal name: schedule_id)
+
+___
+
+### public\_meta
+
+• **public\_meta**: `RaffleDrawPublicMeta`
+
+Meta information of the Draw for the presentaiton in UI
+
+___
+
+### prizes
+
+• **prizes**: [`RafflePrize`](RafflePrize.md)[]
+
+Information about prizes in the draw
+
+___
+
+### current\_state
+
+• **current\_state**: `RaffleDrawInstanceState`
+
+State of current instance of Draw
+
+___
+
+### current\_instance\_id
+
+• `Optional` **current\_instance\_id**: `number`
+
+If current draw is in State Executed, this field will contain the ID of instance
+If current draw is in State Open or WinnerSelection, this field will be undefined
+
+___
+
+### current\_execution\_ts
+
+• `Optional` **current\_execution\_ts**: `number`
+
+Date/time of the draw execution if the draw is in the State Executed
+
+___
+
+### previous\_execution\_ts
+
+• `Optional` **previous\_execution\_ts**: `number`
+
+Date of the previously executed draw (if there is such)
+
+___
+
+### previous\_execution\_instance\_id
+
+• `Optional` **previous\_execution\_instance\_id**: `number`
+
+Unique ID of the previusly executed draw (if there is such)
+
+___
+
+### next\_execution\_ts
+
+• `Optional` **next\_execution\_ts**: `number`
+
+Date/time of the next draw (if there is such)
+
+___
+
+### tickets\_time\_back\_ts
+
+• `Optional` **tickets\_time\_back\_ts**: `number`
+
+Date/time starting from which the tickets will participate in the upcoming draw
+ This value need to be taken into account with next_execute_ts field value, for example
+ Next draw is at 10:00, tickets_time_back_ts is 9:00, so all tickets that are collected after 9:00 will participate in the draw at 10:00
+ If this value is not present, then all tickets that are collected ever for this raffle will participate in the next draw.
+ (internally this value is calculated as next_execute_ts - time_back_period_ms)
+
+___
+
+### allow\_multi\_prize\_per\_ticket
+
+• **allow\_multi\_prize\_per\_ticket**: `boolean`
+
+Field is indicating if same ticket can win multiple prizes in the same draw 
+ For example there are 3 types of prizes in the draw - iPhone, iPad, MacBook
+ If this field is true, then one ticket can win all 3 prizes (depending on the chances of course), 
+ if false, then one ticket can win only one prize. 
+ The distribution of the prizes is start from top (assuming on top are the most valuable prizes) to bottom (less valuable prizes)
+ If specific prize has multiple values, e.g. we have 3 iPhones, 
+ then the same ticket can win only one prize of a kind, but can win multiple prizes of different kind (if allow_multi_prize_per_ticket is true)
+
+___
+
+### total\_tickets\_count
+
+• **total\_tickets\_count**: `number`
+
+The number of tickets that are already given to all users for this instance of draw.
+In other words tickets that are collected between tickets_time_back_ts and current time (or till current_execution_ts is the instance is executed).
+
+___
+
+### my\_tickets\_count
+
+• **my\_tickets\_count**: `number`
+
+The number of tickets collected by current user for this instance of draw.
+
+___
+
+### my\_last\_tickets
+
+• **my\_last\_tickets**: [`RaffleTicket`](RaffleTicket.md)[]

package/docs/interfaces/RafflePrize.md

@@ -0,0 +1,137 @@
+# Interface: RafflePrize
+
+Represents a prize in a draw.
+
+## Properties
+
+### prize\_id
+
+• **prize\_id**: `string`
+
+The unique identifier for the prize definition
+
+___
+
+### public\_meta
+
+• **public\_meta**: `RafflePrizePublicMeta`
+
+Meta information about the prize for presentation in the UI.
+
+___
+
+### prizes\_per\_run
+
+• **prizes\_per\_run**: `number`
+
+The number of prizes available per run of the draw.
+E.g. if the draw is run daily, this is the number of prizes available each day, for example 3 iPhones.
+
+___
+
+### prizes\_per\_run\_actual
+
+• **prizes\_per\_run\_actual**: `number`
+
+The actual number of prizes for the current instance.
+This value is taking into account follwing values:
+ - min_required_total_tickets, 
+ - multiply_prizes_per_each_x_tickets
+ - stock_items_per_draw
+ - total_tickets_count (from Draw instance)
+ - cap_prizes_per_run
+For example:
+ - prizes_per_run = 1
+ - min_required_total_tickets = 1000
+ - multiply_prizes_per_each_x_tickets = 1000
+ - stock_items_per_draw = 5
+ - total_tickets_count = 7000
+ - cap_prizes_per_run = 6
+ prizes_per_run_actual will be 5, because
+ 7000 tickets are collected, so 7 iPhones are available, but the cap is 6 and the stock is 5.
+
+___
+
+### chances\_to\_win\_perc
+
+• **chances\_to\_win\_perc**: `number`
+
+The chances to win the prize by current player. 
+Calculated as the ratio of the number of tickets collected by the current player to the 
+total number of tickets collected by all players and multiplied by number of actual prizes of this kind.
+
+___
+
+### min\_required\_total\_tickets
+
+• `Optional` **min\_required\_total\_tickets**: `number`
+
+The minimum number of total tickets collected during draw period required to unlock the prize.
+If the number of tickets collected is less than this value, the prize is not available.
+Under total tickets we understand the number of tickets collected by all users.
+The 'draw period' is the time between the tickets_time_back_ts value of the draw and the current time.
+
+___
+
+### multiply\_prizes\_per\_each\_x\_tickets
+
+• `Optional` **multiply\_prizes\_per\_each\_x\_tickets**: `number`
+
+The number of additional prizes awarded for each multiple of a certain number of tickets.
+E.g. if the prize is 1 iPhone and the value is set to 1000, then for every 1000 tickets collected, an additional iPhone is awarded.
+If min_required_total_tickets is set to 1000, then next iPhone is awarded when 2000 tickets are collected, and so on.
+If min_required_total_tickets is not set, then the next iPhone will be awarded when 1000 tickets are collected.
+
+___
+
+### requires\_claim
+
+• **requires\_claim**: `boolean`
+
+Indicates whether the prize requires a claim action from the user.
+
+___
+
+### min\_required\_tickets\_for\_user
+
+• **min\_required\_tickets\_for\_user**: `number`
+
+The minimum number of tickets a user must have to be eligible for the prize.
+For example iPhone prize may require 10 tickets to be collected, only users with 10 or more tickets will be eligible for the prize.
+More tickets are better, as they increase the chances of winning.
+
+___
+
+### cap\_prizes\_per\_run
+
+• `Optional` **cap\_prizes\_per\_run**: `number`
+
+The maximum number of prizes that can be given withing one instance/run of draw.
+For example the prize is iPhone and multiply_prizes_per_each_x_tickets is set to 1000, 
+cap_prizes_per_run is set to 3, and the total number of tickets collected is 7000.
+In this case, the prizes_per_run_actual will be limitted by 3
+
+___
+
+### priority
+
+• **priority**: `number`
+
+The priority of the prize. The low number means higher priority (e.g. 1 is higher priority than 2).
+If there are multiple prizes available, the prize with the highest priority (lowest number) will be awarded first.
+
+___
+
+### stock\_items\_per\_draw
+
+• `Optional` **stock\_items\_per\_draw**: `number`
+
+Optional field that indicates total remaining number of the prize for all draws of the type.
+For example, the Daily draw has 1 iPhone daily, and the total number of iPhones is 10.
+the stock_items_per_draw will be decreasing by 1 each day (assuming there is enough tickets and it is won every day), and when it reaches 0, the prize is not available anymore.
+
+___
+
+### winners
+
+• **winners**: [`RafflePrizeWinner`](RafflePrizeWinner.md)[]

package/docs/interfaces/RafflePrizeWinner.md

@@ -0,0 +1,31 @@
+# Interface: RafflePrizeWinner
+
+## Properties
+
+### user\_id
+
+• **user\_id**: `number`
+
+___
+
+### public\_username
+
+• `Optional` **public\_username**: `string`
+
+___
+
+### avatar\_id
+
+• **avatar\_id**: `string`
+
+___
+
+### avatar\_url
+
+• `Optional` **avatar\_url**: `string`
+
+___
+
+### ticket
+
+• **ticket**: [`RaffleTicket`](RaffleTicket.md)

package/docs/interfaces/RaffleTicket.md

@@ -0,0 +1,13 @@
+# Interface: RaffleTicket
+
+## Properties
+
+### id
+
+• **id**: `number`
+
+___
+
+### s
+
+• **s**: `string`

package/package.json

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

package/src/Base/ClassId.ts

@@ -148,6 +148,19 @@ export enum ClassId {
 
 	JP_WIN_PUSH = 808,
 
+
+	RAF_GET_RAFFLES_REQUEST = 900,
+	RAF_GET_RAFFLES_RESPONSE = 901,
+	RAF_GET_DRAW_REQUEST = 904,
+	RAF_GET_DRAW_RESPONSE = 905,
+
+	/*
+	RAF_GET_TICKETS_REQUEST = 902,
+	RAF_GET_TICKETS_RESPONSE = 903,
+
+	RAF_CLAIM_PRIZE_REQUEST = 906,
+	*/
+
 	/*
         !Important, if adding new messages that are 'acting' on behalf of the client,
         you need to include them in the CLASS_ID_IGNORE_FOR_SIMULATION

package/src/MiniGames/SAWGetTemplatesResponse.ts

@@ -71,7 +71,7 @@ export const SAWTemplatesTransform = (items: SAWTemplate[]): TMiniGameTemplate[]
 					relative_period_timezone: p.relative_period_timezone,
 					is_surcharge: p.is_surcharge,
 					is_deleted: p.is_deleted,
-					custom_data: IntUtils.JsonOrText(r.saw_template_ui_definition.custom_data),
+					custom_data: IntUtils.JsonOrText(p.saw_prize_ui_definition?.custom_data),
 					prize_modifiers: p.saw_prize_ui_definition.prize_modifiers,
 					allow_split_decimal: p.saw_prize_ui_definition.allow_split_decimal,
 					hide_prize_from_history: p.saw_prize_ui_definition.hide_prize_from_history

package/src/Raffle/GetDrawRunRequest.ts

@@ -0,0 +1,6 @@
+import { ProtocolMessage } from '../Base/ProtocolMessage';
+
+export interface GetDrawRunRequest extends ProtocolMessage {
+    raffle_id: number;
+    run_id: number;
+}

package/src/Raffle/GetDrawRunResponse.ts

@@ -0,0 +1,6 @@
+import { ProtocolResponse } from '../Base/ProtocolResponse';
+import { RaffleDraw } from './RaffleDraw';
+
+export interface GetDrawRunResponse extends ProtocolResponse {
+	draw: RaffleDraw;
+}

package/src/Raffle/GetRafflesRequest.ts

@@ -0,0 +1,5 @@
+import { ProtocolMessage } from '../Base/ProtocolMessage';
+
+export interface GetRafflesRequest extends ProtocolMessage {
+    skip_public_meta?: boolean
+}

package/src/Raffle/GetRafflesResponse.ts

@@ -0,0 +1,6 @@
+import { ProtocolResponse } from '../Base/ProtocolResponse';
+import { Raffle } from './Raffle';
+
+export interface GetRafflesResponse extends ProtocolResponse {
+	items: Raffle[];
+}