@smartico/public-api 0.0.364 → 0.0.365

package/docs/api/interfaces/TMiniGamePrize.md

@@ -6,247 +6,247 @@ TMiniGamePrize describes the information of prize in the array of prizes in the
 
 ### id
 
-• **id**: `number`
+> **id**: `number`
 
 ID of the prize
 
-___
+***
 
 ### name
 
-• **name**: `string`
+> **name**: `string`
 
 The visual name of the prize
 
-___
+***
 
 ### prize\_type
 
-• **prize\_type**: [`MiniGamePrizeTypeName`](../enums/MiniGamePrizeTypeName.md)
+> **prize\_type**: [`MiniGamePrizeTypeName`](../enumerations/MiniGamePrizeTypeName.md)
 
 The type of the prize,  no-prize, points, bonus, manual, spin, jackpot
 
-___
+***
 
-### prize\_value
+### prize\_value?
 
-• `Optional` **prize\_value**: `number`
+> `optional` **prize\_value?**: `number`
 
 Numeric value of the prize in case it's 'points' or 'spin' type. For other types of prizes this value is not relevant. 
 For example for prize  '100 points' the prize_value will be 100. For '100 free spins' the prize_value will be 100.
 
-___
+***
 
-### font\_size
+### font\_size?
 
-• `Optional` **font\_size**: `number`
+> `optional` **font\_size?**: `number`
 
 Custom font size for the prize (desktop)
 
-___
+***
 
-### font\_size\_mobile
+### font\_size\_mobile?
 
-• `Optional` **font\_size\_mobile**: `number`
+> `optional` **font\_size\_mobile?**: `number`
 
 Custom font size for the prize (mobile)
 
-___
+***
 
-### icon
+### icon?
 
-• `Optional` **icon**: `string`
+> `optional` **icon?**: `string`
 
 The URL of the icon of the prize, aspect ratio 1:1
 
-___
+***
 
 ### position
 
-• **position**: `number`
+> **position**: `number`
 
 for scratch card defines position of prize in the list
 
-___
+***
 
 ### sectors
 
-• **sectors**: `number`[]
+> **sectors**: `number`[]
 
 List of sectors for the prize
 
-___
+***
 
 ### acknowledge\_type
 
-• **acknowledge\_type**: [`SAWAcknowledgeTypeName`](../enums/SAWAcknowledgeTypeName.md)
+> **acknowledge\_type**: [`SAWAcknowledgeTypeName`](../enumerations/SAWAcknowledgeTypeName.md)
 
 Type of acknowledge message for users
 
-___
+***
 
 ### aknowledge\_message
 
-• **aknowledge\_message**: `string`
+> **aknowledge\_message**: `string`
 
 Message that will be shown to user in modal pop-up
 
-___
+***
 
 ### acknowledge\_dp
 
-• **acknowledge\_dp**: `string`
+> **acknowledge\_dp**: `string`
 
 Deep link that will trigger some action in modal pop-up
 
-___
+***
 
 ### acknowledge\_action\_title
 
-• **acknowledge\_action\_title**: `string`
+> **acknowledge\_action\_title**: `string`
 
 The name of the action button in modal pop-up
 
-___
+***
 
-### acknowledge\_dp\_additional
+### acknowledge\_dp\_additional?
 
-• `Optional` **acknowledge\_dp\_additional**: `string`
+> `optional` **acknowledge\_dp\_additional?**: `string`
 
 Deep link that will trigger some action in modal pop-up (additional)
 
-___
+***
 
-### acknowledge\_action\_title\_additional
+### acknowledge\_action\_title\_additional?
 
-• `Optional` **acknowledge\_action\_title\_additional**: `string`
+> `optional` **acknowledge\_action\_title\_additional?**: `string`
 
 The name of the action button in modal pop-up (additional)
 
-___
+***
 
-### out\_of\_stock\_message
+### out\_of\_stock\_message?
 
-• `Optional` **out\_of\_stock\_message**: `string`
+> `optional` **out\_of\_stock\_message?**: `string`
 
 Message when the prize pool is empty for that specific prize
 
-___
+***
 
-### pool
+### pool?
 
-• `Optional` **pool**: `number`
+> `optional` **pool?**: `number`
 
 Number of items in stock
 
-___
+***
 
-### pool\_initial
+### pool\_initial?
 
-• `Optional` **pool\_initial**: `number`
+> `optional` **pool\_initial?**: `number`
 
 Initial number of items in stock
 
-___
+***
 
-### wins\_count
+### wins\_count?
 
-• `Optional` **wins\_count**: `number`
+> `optional` **wins\_count?**: `number`
 
 Number of wins in game
 
-___
+***
 
-### weekdays
+### weekdays?
 
-• `Optional` **weekdays**: `number`[]
+> `optional` **weekdays?**: `number`[]
 
 Number of days of week, when the prize can be available
 
-___
+***
 
-### active\_from\_ts
+### active\_from\_ts?
 
-• `Optional` **active\_from\_ts**: `number`
+> `optional` **active\_from\_ts?**: `number`
 
 Holds time from which prize will become available, for the prizes that are targeted to be available from specific time (UNIX timestamp)
 
-___
+***
 
-### active\_till\_ts
+### active\_till\_ts?
 
-• `Optional` **active\_till\_ts**: `number`
+> `optional` **active\_till\_ts?**: `number`
 
 Holds time till which prize will become available, for the prizes that are targeted to be available from specific time (UNIX timestamp)
 
-___
+***
 
-### relative\_period\_timezone
+### relative\_period\_timezone?
 
-• `Optional` **relative\_period\_timezone**: `number`
+> `optional` **relative\_period\_timezone?**: `number`
 
 Time zone to ensure each day aligns with your local midnight.
 
-___
+***
 
-### is\_surcharge
+### is\_surcharge?
 
-• `Optional` **is\_surcharge**: `boolean`
+> `optional` **is\_surcharge?**: `boolean`
 
 Flag indicating that the prize is surcharged (available all the time, despite pool numbers)
 
-___
+***
 
-### is\_deleted
+### is\_deleted?
 
-• `Optional` **is\_deleted**: `boolean`
+> `optional` **is\_deleted?**: `boolean`
 
 Flag indicating the state of the prize
 
-___
+***
 
-### custom\_data
+### custom\_data?
 
-• `Optional` **custom\_data**: `any`
+> `optional` **custom\_data?**: `any`
 
 The custom data of the mini-game defined by operator in the BackOffice. Can be a JSON object, string or number
 
-___
+***
 
-### prize\_modifiers
+### prize\_modifiers?
 
-• `Optional` **prize\_modifiers**: [`PrizeModifiers`](../enums/PrizeModifiers.md)[]
+> `optional` **prize\_modifiers?**: [`PrizeModifiers`](../enumerations/PrizeModifiers.md)[]
 
 Prize modifiers that will multiply by 2x, 5x or 10x the current total. This will not affect the final Prize Amount that will be awarded.
 
-___
+***
 
-### allow\_split\_decimal
+### allow\_split\_decimal?
 
-• `Optional` **allow\_split\_decimal**: `boolean`
+> `optional` **allow\_split\_decimal?**: `boolean`
 
 When enabled, you can split prize value by decimal values
 
-___
+***
 
-### hide\_prize\_from\_history
+### hide\_prize\_from\_history?
 
-• `Optional` **hide\_prize\_from\_history**: `boolean`
+> `optional` **hide\_prize\_from\_history?**: `boolean`
 
 When enabled, you can hide prize from prize history
 
-___
+***
 
-### requirements\_to\_get\_prize
+### requirements\_to\_get\_prize?
 
-• `Optional` **requirements\_to\_get\_prize**: `string`
+> `optional` **requirements\_to\_get\_prize?**: `string`
 
 Requirements to claim the prize  (lootbox specific)
 
-___
+***
 
-### max\_give\_period\_type\_id
+### max\_give\_period\_type\_id?
 
-• `Optional` **max\_give\_period\_type\_id**: [`AttemptPeriodType`](../enums/AttemptPeriodType.md)
+> `optional` **max\_give\_period\_type\_id?**: [`AttemptPeriodType`](../enumerations/AttemptPeriodType.md)
 
 The period type for the prize to be given: Time from last attempt, Calendar days UTC, Calendar days user time zone, Lifetime

package/docs/api/interfaces/TMiniGameTemplate.md

@@ -6,265 +6,265 @@ TMiniGameTemplate describes the information of mini-games available for the user
 
 ### id
 
-• **id**: `number`
+> **id**: `number`
 
 ID of the mini-game template
 
-___
+***
 
 ### name
 
-• **name**: `string`
+> **name**: `string`
 
 Name of the mini-game template, translated to the user language
 
-___
+***
 
 ### description
 
-• **description**: `string`
+> **description**: `string`
 
 Description of the mini-game template, translated to the user language
 
-___
+***
 
 ### thumbnail
 
-• **thumbnail**: `string`
+> **thumbnail**: `string`
 
 URL of the icon of the mini-game template, 256x256px
 
-___
+***
 
-### visibile\_when\_can\_spin
+### visibile\_when\_can\_spin?
 
-• `Optional` **visibile\_when\_can\_spin**: `boolean`
+> `optional` **visibile\_when\_can\_spin?**: `boolean`
 
 Indicates if the mini-game is visible when the user have attempts/points/gems/diamonds to play
 
-___
+***
 
 ### saw\_game\_type
 
-• **saw\_game\_type**: [`SAWGameTypeName`](../enums/SAWGameTypeName.md)
+> **saw\_game\_type**: [`SAWGameTypeName`](../enumerations/SAWGameTypeName.md)
 
 The type of the game, e.g. Spin the Wheel, Gift Box, Scratch card, MatchX etc
 
-___
+***
 
 ### saw\_buyin\_type
 
-• **saw\_buyin\_type**: [`SAWBuyInTypeName`](../enums/SAWBuyInTypeName.md)
+> **saw\_buyin\_type**: [`SAWBuyInTypeName`](../enumerations/SAWBuyInTypeName.md)
 
 How the user is charged for each game attempt e.g. Free, Points or Spin attempts
 
-___
+***
 
-### buyin\_cost\_points
+### buyin\_cost\_points?
 
-• `Optional` **buyin\_cost\_points**: `number`
+> `optional` **buyin\_cost\_points?**: `number`
 
 in case of charging type 'Points', what is the points amount will be deducted from user balance
 
-___
+***
 
-### buyin\_cost\_gems
+### buyin\_cost\_gems?
 
-• `Optional` **buyin\_cost\_gems**: `number`
+> `optional` **buyin\_cost\_gems?**: `number`
 
 in case of charging type 'Gems', what is the gems amount will be deducted from user balance
 
-___
+***
 
-### buyin\_cost\_diamonds
+### buyin\_cost\_diamonds?
 
-• `Optional` **buyin\_cost\_diamonds**: `number`
+> `optional` **buyin\_cost\_diamonds?**: `number`
 
 in case of charging type 'Diamonds', what is the diamonds amount will be deducted from user balance
 
-___
+***
 
-### spin\_count
+### spin\_count?
 
-• `Optional` **spin\_count**: `number`
+> `optional` **spin\_count?**: `number`
 
 in case of charging type 'Spin attempts', shows the current number of spin attempts that user has
 
-___
+***
 
 ### next\_available\_spin\_ts
 
-• **next\_available\_spin\_ts**: `number`
+> **next\_available\_spin\_ts**: `number`
 
 if the game is limit to the number of spins that user can do during period of time,
 this property shows the epoch time in UTC when the next attempt will be available.
 Note that you need to enable 'Show time to the next available spin' setting on mini-game template in the backoffice
 Important: this field will not be populated if “Max number of attempts a user can do” is set to value different from 1
 
-___
+***
 
 ### over\_limit\_message
 
-• **over\_limit\_message**: `string`
+> **over\_limit\_message**: `string`
 
 The message that should be shown to the user when he cannot play the game, server rejected attempt with error code SAWSpinErrorCode.SAW_FAILED_MAX_SPINS_REACHED
 
-___
+***
 
 ### no\_attempts\_message
 
-• **no\_attempts\_message**: `string`
+> **no\_attempts\_message**: `string`
 
 The message that should be shown to the user when he cannot play the game because he doesn't have spin attempts or points.
 
-___
+***
 
 ### jackpot\_current
 
-• **jackpot\_current**: `number`
+> **jackpot\_current**: `number`
 
 Current jackpont amount, if jackpot is enabled.
 
-___
+***
 
 ### jackpot\_add\_on\_attempt
 
-• **jackpot\_add\_on\_attempt**: `number`
+> **jackpot\_add\_on\_attempt**: `number`
 
 The amount that will be added to the jackpot every time when somebody plays the game. Note that the contribution amount is abstract, means that no money or points are deducted from the user balance.
 
-___
+***
 
 ### jackpot\_symbol
 
-• **jackpot\_symbol**: `string`
+> **jackpot\_symbol**: `string`
 
 The symbol of jackpot that is giving the sense to the 'amount' E.g. the symbol could be EUR and connected to the amount it can indicate that amount is monetary, e.g. '100 EUR'. Or the symbol can be 'Free spins' and connected to the amount it can indicate that amount is number of free spins, e.g. '100 Free spins'.
 
-___
+***
 
 ### promo\_image
 
-• **promo\_image**: `string`
+> **promo\_image**: `string`
 
 The promo image, 500x240px
 
-___
+***
 
 ### promo\_text
 
-• **promo\_text**: `string`
+> **promo\_text**: `string`
 
 The promo text
 
-___
+***
 
 ### custom\_data
 
-• **custom\_data**: `any`
+> **custom\_data**: `any`
 
 The custom data of the mini-game defined by operator in the BackOffice. Can be a JSON object, string or number
 
-___
+***
 
 ### prizes
 
-• **prizes**: [`TMiniGamePrize`](TMiniGamePrize.md)[]
+> **prizes**: [`TMiniGamePrize`](TMiniGamePrize.md)[]
 
 List of prizes for mini-games
 
-___
+***
 
-### expose\_game\_stat\_on\_api
+### expose\_game\_stat\_on\_api?
 
-• `Optional` **expose\_game\_stat\_on\_api**: `boolean`
+> `optional` **expose\_game\_stat\_on\_api?**: `boolean`
 
 When enabled, the number of items in the pool and number of won items will be exposed in the Retention API and in the UI Widgets
 
-___
+***
 
-### relative\_period\_timezone
+### relative\_period\_timezone?
 
-• `Optional` **relative\_period\_timezone**: `number`
+> `optional` **relative\_period\_timezone?**: `number`
 
 Time zone to ensure each day aligns with your local midnight.
 
-___
+***
 
-### activeFromDate
+### activeFromDate?
 
-• `Optional` **activeFromDate**: `number`
+> `optional` **activeFromDate?**: `number`
 
 Holds time from which template will become available, for the template that are targeted to be available from specific time (UNIX timestamp)
 
-___
+***
 
-### activeTillDate
+### activeTillDate?
 
-• `Optional` **activeTillDate**: `number`
+> `optional` **activeTillDate?**: `number`
 
 Holds time till which template will become available, for the templates that are targeted to be available from specific time (UNIX timestamp)
 
-___
+***
 
-### steps\_to\_finish\_game
+### steps\_to\_finish\_game?
 
-• `Optional` **steps\_to\_finish\_game**: `number`
+> `optional` **steps\_to\_finish\_game?**: `number`
 
 The amount of steps to complete the game and gather the prize
 
-___
+***
 
-### custom\_section\_id
+### custom\_section\_id?
 
-• `Optional` **custom\_section\_id**: `number`
+> `optional` **custom\_section\_id?**: `number`
 
 Hold the id of the custom section
 
-___
+***
 
 ### saw\_template\_ui\_definition
 
-• **saw\_template\_ui\_definition**: [`SAWTemplateUI`](SAWTemplateUI.md)
+> **saw\_template\_ui\_definition**: [`SAWTemplateUI`](SAWTemplateUI.md)
 
 The UI definition of the mini-game
 
-___
+***
 
-### game\_layout
+### game\_layout?
 
-• `Optional` **game\_layout**: [`SAWGameLayoutName`](../enums/SAWGameLayoutName.md)
+> `optional` **game\_layout?**: [`SAWGameLayoutName`](../enumerations/SAWGameLayoutName.md)
 
 The layout of the game
 
-___
+***
 
-### show\_prize\_history
+### show\_prize\_history?
 
-• `Optional` **show\_prize\_history**: `boolean`
+> `optional` **show\_prize\_history?**: `boolean`
 
 When enabled the prize history icon is visible on a certain template
 
-___
+***
 
-### max\_number\_of\_attempts
+### max\_number\_of\_attempts?
 
-• `Optional` **max\_number\_of\_attempts**: `number`
+> `optional` **max\_number\_of\_attempts?**: `number`
 
 The maximum number of attempts that user can do during period of time
 
-___
+***
 
-### max\_spins\_period\_ms
+### max\_spins\_period\_ms?
 
-• `Optional` **max\_spins\_period\_ms**: `number`
+> `optional` **max\_spins\_period\_ms?**: `number`
 
 The period of time in milliseconds during which the user can do the maximum number of attempts
 
-___
+***
 
-### expose\_user\_spin\_id
+### expose\_user\_spin\_id?
 
-• `Optional` **expose\_user\_spin\_id**: [`SAWExposeUserSpinIdName`](../enums/SAWExposeUserSpinIdName.md)
+> `optional` **expose\_user\_spin\_id?**: [`SAWExposeUserSpinIdName`](../enumerations/SAWExposeUserSpinIdName.md)
 
 The ID of the user spin id to expose on the game