@smartico/public-api 0.0.363 → 0.0.365

package/docs/api/interfaces/RaffleDraw.md

@@ -4,48 +4,48 @@
 
 ### draw\_id
 
-• **draw\_id**: `number`
+> **draw\_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`](RaffleDrawPublicMeta.md)
+> **public\_meta**: [`RaffleDrawPublicMeta`](RaffleDrawPublicMeta.md)
 
 Meta information of the Draw for the presentaiton in UI
 
-___
+***
 
 ### prizes
 
-• **prizes**: [`RafflePrize`](RafflePrize.md)[]
+> **prizes**: [`RafflePrize`](RafflePrize.md)[]
 
 Information about prizes in the draw
 
-___
+***
 
 ### current\_state
 
-• **current\_state**: [`RaffleDrawInstanceState`](../enums/RaffleDrawInstanceState.md)
+> **current\_state**: [`RaffleDrawInstanceState`](../enumerations/RaffleDrawInstanceState.md)
 
 State of current instance of Draw
 
-___
+***
 
 ### run\_id
 
-• **run\_id**: `number`
+> **run\_id**: `number`
 
 Field indicates the ID of the latest instance/run of draw
 
-___
+***
 
 ### execution\_type
 
-• **execution\_type**: [`RaffleDrawTypeExecution`](../enums/RaffleDrawTypeExecution.md)
+> **execution\_type**: [`RaffleDrawTypeExecution`](../enumerations/RaffleDrawTypeExecution.md)
 
 Type of the draw execution, indicating how and when the draw is executed.
 
@@ -53,46 +53,46 @@ Type of the draw execution, indicating how and when the draw is executed.
 - Recurring: Draw is executed on a recurring basis (e.g., daily, weekly).
 - Grand: Draw is executed once and is marked as grand, often with larger prizes or more importance.
 
-___
+***
 
 ### execution\_ts
 
-• **execution\_ts**: `number`
+> **execution\_ts**: `number`
 
 Date/time of the draw execution
 
-___
+***
 
-### previous\_run\_ts
+### previous\_run\_ts?
 
-• `Optional` **previous\_run\_ts**: `number`
+> `optional` **previous\_run\_ts?**: `number`
 
 Date of the previously executed draw (if there is such)
 
-___
+***
 
-### previous\_run\_id
+### previous\_run\_id?
 
-• `Optional` **previous\_run\_id**: `number`
+> `optional` **previous\_run\_id?**: `number`
 
 Unique ID of the previusly executed draw (if there is such)
 
-___
+***
 
 ### ticket\_start\_ts
 
-• **ticket\_start\_ts**: `number`
+> **ticket\_start\_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, ticket_start_date is 9:00, so all tickets that are collected after 9:00 will participate in the draw at 10:00
 (internally this value is calculated as next_execute_ts - ticket_start_date)
 
-___
+***
 
 ### allow\_multi\_prize\_per\_ticket
 
-• **allow\_multi\_prize\_per\_ticket**: `boolean`
+> **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
@@ -102,75 +102,75 @@ The distribution of the prizes is start from top (assuming on top are the most v
 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`
+> **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 ticket_start_date and current time (or till current_execution_ts is the instance is executed).
 
-___
+***
 
 ### my\_tickets\_count
 
-• **my\_tickets\_count**: `number`
+> **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)[]
+> **my\_last\_tickets**: [`RaffleTicket`](RaffleTicket.md)[]
 
 List of last 5 tickets are collected by current user for this instance of draw.
 
-___
+***
 
 ### user\_opted\_in
 
-• **user\_opted\_in**: `boolean`
+> **user\_opted\_in**: `boolean`
 
 If true, the user has opted-in to the raffle.
 
-___
+***
 
 ### requires\_optin
 
-• **requires\_optin**: `boolean`
+> **requires\_optin**: `boolean`
 
 If true, the user needs to opt-in to the raffle before they can participate.
 
-___
+***
 
 ### is\_active
 
-• **is\_active**: `boolean`
+> **is\_active**: `boolean`
 
 If true, the draw is active and can be participated in.
 
-___
+***
 
-### winners\_limit
+### winners\_limit?
 
-• `Optional` **winners\_limit**: `number`
+> `optional` **winners\_limit?**: `number`
 
 The number of winners to return
 
-___
+***
 
-### winners\_offset
+### winners\_offset?
 
-• `Optional` **winners\_offset**: `number`
+> `optional` **winners\_offset?**: `number`
 
 The offset of the winners to return
 
-___
+***
 
-### winners\_total
+### winners\_total?
 
-• `Optional` **winners\_total**: `number`
+> `optional` **winners\_total?**: `number`
 
 The total number of winners

package/docs/api/interfaces/RaffleDrawPublicMeta.md

@@ -4,62 +4,62 @@
 
 ### name
 
-• **name**: `string`
+> **name**: `string`
 
 Name of the draw, e.g. 'Daily draw'
 
-___
+***
 
 ### description
 
-• **description**: `string`
+> **description**: `string`
 
 Description of the draw
 
-___
+***
 
 ### image\_url
 
-• **image\_url**: `string`
+> **image\_url**: `string`
 
 URL of the image that represents the draw
 
-___
+***
 
 ### image\_url\_mobile
 
-• **image\_url\_mobile**: `string`
+> **image\_url\_mobile**: `string`
 
 URL of the moible image that represents the draw
 
-___
+***
 
 ### icon\_url
 
-• **icon\_url**: `string`
+> **icon\_url**: `string`
 
 URL of the icon that represents the draw
 
-___
+***
 
 ### background\_image\_url
 
-• **background\_image\_url**: `string`
+> **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`
+> **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`
+> **is\_grand**: `boolean`
 
 Show if the draw is grand and is marked as special

package/docs/api/interfaces/RaffleDrawRun.md

@@ -4,66 +4,66 @@
 
 ### draw\_id
 
-• **draw\_id**: `number`
+> **draw\_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)
 
-___
+***
 
 ### run\_id
 
-• **run\_id**: `number`
+> **run\_id**: `number`
 
 Field indicates the ID of the latest instance/run of draw
 
-___
+***
 
 ### public\_meta
 
-• **public\_meta**: [`RaffleDrawPublicMeta`](RaffleDrawPublicMeta.md)
+> **public\_meta**: [`RaffleDrawPublicMeta`](RaffleDrawPublicMeta.md)
 
 Meta information of the Draw for the presentaiton in UI
 
-___
+***
 
 ### execution\_ts
 
-• **execution\_ts**: `number`
+> **execution\_ts**: `number`
 
 Date/time of the draw execution
 
-___
+***
 
 ### actual\_execution\_ts
 
-• **actual\_execution\_ts**: `number`
+> **actual\_execution\_ts**: `number`
 
 Actual Date/time of the draw execution
 
-___
+***
 
 ### ticket\_start\_ts
 
-• **ticket\_start\_ts**: `number`
+> **ticket\_start\_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, ticket_start_date is 9:00, so all tickets that are collected after 9:00 will participate in the draw at 10:00
  (internally this value is calculated as next_execute_ts - ticket_start_date)
 
-___
+***
 
 ### is\_winner
 
-• **is\_winner**: `boolean`
+> **is\_winner**: `boolean`
 
 Shows if user has won a prize in a current run
 
-___
+***
 
 ### has\_unclaimed\_prize
 
-• **has\_unclaimed\_prize**: `boolean`
+> **has\_unclaimed\_prize**: `boolean`
 
 Shows if user has unclaimed prize

package/docs/api/interfaces/RaffleOptinRequest.md

@@ -1,55 +1,53 @@
 # Interface: RaffleOptinRequest
 
-## Hierarchy
+## Extends
 
 - `ProtocolMessage`
 
-  ↳ **`RaffleOptinRequest`**
-
 ## Properties
 
 ### cid
 
-• **cid**: `number`
+> **cid**: `number`
 
 #### Inherited from
 
-ProtocolMessage.cid
+`ProtocolMessage.cid`
 
-___
+***
 
-### ts
+### ts?
 
-• `Optional` **ts**: `number`
+> `optional` **ts?**: `number`
 
 #### Inherited from
 
-ProtocolMessage.ts
+`ProtocolMessage.ts`
 
-___
+***
 
-### uuid
+### uuid?
 
-• `Optional` **uuid**: `string`
+> `optional` **uuid?**: `string`
 
 #### Inherited from
 
-ProtocolMessage.uuid
+`ProtocolMessage.uuid`
 
-___
+***
 
 ### raffle\_id
 
-• **raffle\_id**: `number`
+> **raffle\_id**: `number`
 
-___
+***
 
 ### draw\_id
 
-• **draw\_id**: `number`
+> **draw\_id**: `number`
 
-___
+***
 
 ### raffle\_run\_id
 
-• **raffle\_run\_id**: `number`
+> **raffle\_run\_id**: `number`

package/docs/api/interfaces/RaffleOptinResponse.md

@@ -1,57 +1,55 @@
 # Interface: RaffleOptinResponse
 
-## Hierarchy
+## Extends
 
 - `ProtocolResponse`
 
-  ↳ **`RaffleOptinResponse`**
-
 ## Properties
 
 ### cid
 
-• **cid**: `number`
+> **cid**: `number`
 
 #### Inherited from
 
-ProtocolResponse.cid
+`ProtocolResponse.cid`
 
-___
+***
 
-### ts
+### ts?
 
-• `Optional` **ts**: `number`
+> `optional` **ts?**: `number`
 
 #### Inherited from
 
-ProtocolResponse.ts
+`ProtocolResponse.ts`
 
-___
+***
 
-### uuid
+### uuid?
 
-• `Optional` **uuid**: `string`
+> `optional` **uuid?**: `string`
 
 #### Inherited from
 
-ProtocolResponse.uuid
+`ProtocolResponse.uuid`
 
-___
+***
 
-### errCode
+### errCode?
 
-• `Optional` **errCode**: `number`
+> `optional` **errCode?**: `number`
 
 #### Inherited from
 
-ProtocolResponse.errCode
+`ProtocolResponse.errCode`
 
-___
+***
 
-### errMsg
+### errMsg?
 
-• `Optional` **errMsg**: `string`
+> `optional` **errMsg?**: `string`
 
 #### Inherited from
 
-ProtocolResponse.errMsg
+`ProtocolResponse.errMsg`

package/docs/api/interfaces/RafflePrize.md

@@ -6,32 +6,32 @@ Represents a prize in a draw.
 
 ### prize\_id
 
-• **prize\_id**: `string`
+> **prize\_id**: `string`
 
 The unique identifier for the prize definition
 
-___
+***
 
 ### public\_meta
 
-• **public\_meta**: [`RafflePrizePublicMeta`](RafflePrizePublicMeta.md)
+> **public\_meta**: [`RafflePrizePublicMeta`](RafflePrizePublicMeta.md)
 
 Meta information about the prize for presentation in the UI.
 
-___
+***
 
 ### prizes\_per\_run
 
-• **prizes\_per\_run**: `number`
+> **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`
+> **prizes\_per\_run\_actual**: `number`
 
 The actual number of prizes for the current instance.
 This value is taking into account follwing values:
@@ -52,96 +52,96 @@ For example:
 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`
+> **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
+### min\_required\_total\_tickets?
 
-• `Optional` **min\_required\_total\_tickets**: `number`
+> `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 ticket_start_date value of the draw and the current time.
 
-___
+***
 
-### add\_one\_prize\_per\_each\_x\_tickets
+### add\_one\_prize\_per\_each\_x\_tickets?
 
-• `Optional` **add\_one\_prize\_per\_each\_x\_tickets**: `number`
+> `optional` **add\_one\_prize\_per\_each\_x\_tickets?**: `number`
 
 One additional prize will be awarded for each X 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`
+> **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`
+> **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
+### cap\_prizes\_per\_run?
 
-• `Optional` **cap\_prizes\_per\_run**: `number`
+> `optional` **cap\_prizes\_per\_run?**: `number`
 
 The maximum number of prizes that can be given within one instance/run of draw.
 For example the prize is iPhone and add_one_prize_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 limited by 3
 
-___
+***
 
 ### priority
 
-• **priority**: `number`
+> **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
+### stock\_items\_per\_draw?
 
-• `Optional` **stock\_items\_per\_draw**: `number`
+> `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.
 
-___
+***
 
 ### should\_claim
 
-• **should\_claim**: `boolean`
+> **should\_claim**: `boolean`
 
 Shows if the prize has been claimed
 
-___
+***
 
 ### winners
 
-• **winners**: [`RafflePrizeWinner`](RafflePrizeWinner.md)[]
+> **winners**: [`RafflePrizeWinner`](RafflePrizeWinner.md)[]