@smartico/public-api 0.0.363 → 0.0.365

package/docs/api/interfaces/TRafflePrize.md

@@ -4,48 +4,48 @@
 
 ### id
 
-• **id**: `string`
+> **id**: `string`
 
 The unique identifier for the prize definition
 
-___
+***
 
 ### name
 
-• **name**: `string`
+> **name**: `string`
 
 Name of the prize
 
-___
+***
 
 ### description
 
-• **description**: `string`
+> **description**: `string`
 
 Description of the prize
 
-___
+***
 
 ### image\_url
 
-• **image\_url**: `string`
+> **image\_url**: `string`
 
 URL of the image that represents the prize, 256x256px
 
-___
+***
 
 ### 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:
@@ -64,96 +64,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 withing 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 limitted 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**: [`TRafflePrizeWinner`](TRafflePrizeWinner.md)[]
+> **winners**: [`TRafflePrizeWinner`](TRafflePrizeWinner.md)[]

package/docs/api/interfaces/TRafflePrizeWinner.md

@@ -4,47 +4,47 @@
 
 ### id
 
-• **id**: `number`
+> **id**: `number`
 
 Id of the winner definition, for the repetative winners (e.g. same winner won two prizes), this number will be the same for all winner that are repeating
 (internal name: schedule_id)
 
-___
+***
 
-### username
+### username?
 
-• `Optional` **username**: `string`
+> `optional` **username?**: `string`
 
 Winner user name
 
-___
+***
 
-### avatar\_url
+### avatar\_url?
 
-• `Optional` **avatar\_url**: `string`
+> `optional` **avatar\_url?**: `string`
 
 URL of the image of user avatar
 
-___
+***
 
 ### ticket
 
-• **ticket**: [`TRaffleTicket`](TRaffleTicket.md)
+> **ticket**: [`TRaffleTicket`](TRaffleTicket.md)
 
 Ticket information (number string and integer)
 
-___
+***
 
 ### raf\_won\_id
 
-• **raf\_won\_id**: `number`
+> **raf\_won\_id**: `number`
 
 Unique ID of winning
 
-___
+***
 
 ### claimed\_date
 
-• **claimed\_date**: `number`
+> **claimed\_date**: `number`
 
 Date when the prize was claimed

package/docs/api/interfaces/TRaffleTicket.md

@@ -4,14 +4,14 @@
 
 ### ticekt\_id
 
-• **ticekt\_id**: `number`
+> **ticekt\_id**: `number`
 
 Int presentation of the ticket
 
-___
+***
 
 ### ticket\_id\_string
 
-• **ticket\_id\_string**: `string`
+> **ticket\_id\_string**: `string`
 
 String presentation of the ticket

package/docs/api/interfaces/TSawHistory.md

@@ -4,62 +4,62 @@
 
 ### template
 
-• **template**: [`SAWTemplate`](SAWTemplate.md)
+> **template**: [`SAWTemplate`](SAWTemplate.md)
 
 The initial information about mini-game
 
-___
+***
 
 ### saw\_template\_id
 
-• **saw\_template\_id**: `number`
+> **saw\_template\_id**: `number`
 
 ID of the mini-game template
 
-___
+***
 
 ### saw\_prize\_id
 
-• **saw\_prize\_id**: `number`
+> **saw\_prize\_id**: `number`
 
 The saw_prize_id that user won, details of the prize can be found in the mini-game definition
 
-___
+***
 
 ### prize\_amount
 
-• **prize\_amount**: `number`
+> **prize\_amount**: `number`
 
 Amount of prizes in stock
 
-___
+***
 
 ### client\_request\_id
 
-• **client\_request\_id**: `string`
+> **client\_request\_id**: `string`
 
 Request ID that client is sending to show history
 
-___
+***
 
 ### is\_claimed
 
-• **is\_claimed**: `boolean`
+> **is\_claimed**: `boolean`
 
 Flag indicating to show whether prize in the mini-game claimed or not
 
-___
+***
 
 ### create\_date\_ts
 
-• **create\_date\_ts**: `number`
+> **create\_date\_ts**: `number`
 
 Win prize date in milliseconds
 
-___
+***
 
 ### acknowledge\_date\_ts
 
-• **acknowledge\_date\_ts**: `number`
+> **acknowledge\_date\_ts**: `number`
 
 Claimed prize date in milliseconds

package/docs/api/interfaces/TSegmentCheckResult.md

@@ -4,10 +4,10 @@
 
 ### segment\_id
 
-• **segment\_id**: `number`
+> **segment\_id**: `number`
 
-___
+***
 
 ### is\_matching
 
-• **is\_matching**: `boolean`
+> **is\_matching**: `boolean`

package/docs/api/interfaces/TSetAvatarResult.md

@@ -0,0 +1,19 @@
+# Interface: TSetAvatarResult
+
+TSetAvatarResult describes the response of call to _smartico.api.setAvatar() method
+
+## Properties
+
+### err\_code
+
+> **err\_code**: `number`
+
+Error code that represents outcome of the set avatar request. Successful if err_code is 0
+
+***
+
+### err\_message?
+
+> `optional` **err\_message?**: `string`
+
+Optional error message

package/docs/api/interfaces/TStoreCategory.md

@@ -6,22 +6,22 @@ TStoreCategory describes the store category item. Each store item can be assigne
 
 ### id
 
-• **id**: `number`
+> **id**: `number`
 
 ID of the store category
 
-___
+***
 
 ### name
 
-• **name**: `string`
+> **name**: `string`
 
 Name of the store category
 
-___
+***
 
 ### order
 
-• **order**: `number`
+> **order**: `number`
 
 Order of the store category among other categories. Default value is 1