@smartico/public-api 0.0.364 → 0.0.365

package/docs/api/interfaces/TRaffle.md

@@ -4,106 +4,106 @@
 
 ### id
 
-• **id**: `number`
+> **id**: `number`
 
 ID of the Raffle template
 
-___
+***
 
 ### name
 
-• **name**: `string`
+> **name**: `string`
 
 Name of the raffle
 
-___
+***
 
 ### description
 
-• **description**: `string`
+> **description**: `string`
 
 Description of the raffle
 
-___
+***
 
 ### custom\_section\_id
 
-• **custom\_section\_id**: `number`
+> **custom\_section\_id**: `number`
 
 ID of the custom section that is linked to the raffle in the Gamification widget
 
-___
+***
 
 ### image\_url
 
-• **image\_url**: `string`
+> **image\_url**: `string`
 
 URL of the image that represents the raffle, 890x193px
 
-___
+***
 
 ### image\_url\_mobile
 
-• **image\_url\_mobile**: `string`
+> **image\_url\_mobile**: `string`
 
 URL of the mobile image that represents the raffle, 300x142px
 
-___
+***
 
 ### custom\_data
 
-• **custom\_data**: `string`
+> **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`
+> **start\_date**: `number`
 
 Date of start
 
-___
+***
 
 ### end\_date
 
-• **end\_date**: `number`
+> **end\_date**: `number`
 
 Date of end
 
-___
+***
 
 ### max\_tickets\_count
 
-• **max\_tickets\_count**: `number`
+> **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`
+> **current\_tickets\_count**: `number`
 
 Number of tickets that are already given to all users for this raffle
 
-___
+***
 
 ### draws
 
-• **draws**: [`TRaffleDraw`](TRaffleDraw.md)[]
+> **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.
 
-___
+***
 
 ### ticket\_cap\_visualization
 
-• **ticket\_cap\_visualization**: [`RaffleTicketCapVisualization`](../enums/RaffleTicketCapVisualization.md)
+> **ticket\_cap\_visualization**: [`RaffleTicketCapVisualization`](../enumerations/RaffleTicketCapVisualization.md)
 
 Ticket cap visualization

package/docs/api/interfaces/TRaffleDraw.md

@@ -4,162 +4,162 @@
 
 ### id
 
-• **id**: `number`
+> **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)
 
-___
+***
 
 ### 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, 365x175px
 
-___
+***
 
 ### image\_url\_mobile
 
-• **image\_url\_mobile**: `string`
+> **image\_url\_mobile**: `string`
 
 URL of the moible image that represents the draw, 300x145px
 
-___
+***
 
 ### icon\_url
 
-• **icon\_url**: `string`
+> **icon\_url**: `string`
 
 URL of the icon that represents the draw
 
-**`Remarks`**
+#### Remarks
 
 Square icon target **256×256 px**
 
-___
+***
 
 ### 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
 
-**`Remarks`**
+#### Remarks
 
 Desktop draw list strip: **900×85 px**.
 
-___
+***
 
 ### 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
 
-**`Remarks`**
+#### Remarks
 
 Mobile draw list background: **1328×240 px**.
 
-___
+***
 
 ### is\_grand
 
-• **is\_grand**: `boolean`
+> **is\_grand**: `boolean`
 
 Show if the draw is grand and is marked as special
 
-___
+***
 
 ### prizes
 
-• **prizes**: [`TRafflePrize`](TRafflePrize.md)[]
+> **prizes**: [`TRafflePrize`](TRafflePrize.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.
 - ExecDate: Draw is executed only once at a specific date and time.
 - 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
@@ -169,73 +169,73 @@ Field is indicating if same ticket can win multiple prizes in the same draw
  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**: [`TRaffleTicket`](TRaffleTicket.md)[]
+> **my\_last\_tickets**: [`TRaffleTicket`](TRaffleTicket.md)[]
 
-___
+***
 
 ### 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/TRaffleDrawRun.md

@@ -4,142 +4,142 @@
 
 ### id
 
-• **id**: `number`
+> **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
 
-___
+***
 
 ### 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
 
-**`Remarks`**
+#### Remarks
 
-Same as [image_url](TRaffleDraw.md#image_url): **365×175 px** desktop promo.
+Same as [TRaffleDraw.image\_url](TRaffleDraw.md#image_url): **365×175 px** desktop promo.
 
-___
+***
 
 ### image\_url\_mobile
 
-• **image\_url\_mobile**: `string`
+> **image\_url\_mobile**: `string`
 
 URL of the moible image that represents the draw
 
-**`Remarks`**
+#### Remarks
 
-Same as [image_url_mobile](TRaffleDraw.md#image_url_mobile): **300×145 px** mobile promo.
+Same as [TRaffleDraw.image\_url\_mobile](TRaffleDraw.md#image_url_mobile): **300×145 px** mobile promo.
 
-___
+***
 
 ### icon\_url
 
-• **icon\_url**: `string`
+> **icon\_url**: `string`
 
 URL of the icon that represents the draw
 
-**`Remarks`**
+#### Remarks
 
-Same as [icon_url](TRaffleDraw.md#icon_url): **256×256 px** square.
+Same as [TRaffleDraw.icon\_url](TRaffleDraw.md#icon_url): **256×256 px** square.
 
-___
+***
 
 ### 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
 
-**`Remarks`**
+#### Remarks
 
-Same as [background_image_url](TRaffleDraw.md#background_image_url): **900×85 px**.
+Same as [TRaffleDraw.background\_image\_url](TRaffleDraw.md#background_image_url): **900×85 px**.
 
-___
+***
 
 ### 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
 
-**`Remarks`**
+#### Remarks
 
-Same as [background_image_url_mobile](TRaffleDraw.md#background_image_url_mobile): **1328×240 px**.
+Same as [TRaffleDraw.background\_image\_url\_mobile](TRaffleDraw.md#background_image_url_mobile): **1328×240 px**.
 
-___
+***
 
 ### is\_grand
 
-• **is\_grand**: `boolean`
+> **is\_grand**: `boolean`
 
 Show if the draw is grand and is marked as special
 
-___
+***
 
 ### 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/TRaffleOptinResponse.md

@@ -4,14 +4,14 @@
 
 ### err\_code
 
-• **err\_code**: `number`
+> **err\_code**: `number`
 
 Error code that represents outcome of the opt-in attempt. Opt-in succeed in case err_code is 0
 
-___
+***
 
-### err\_message
+### err\_message?
 
-• `Optional` **err\_message**: `string`
+> `optional` **err\_message?**: `string`
 
 Optional error message