@smartico/public-api 0.0.364 → 0.0.365

package/docs/api/interfaces/TTournamentRegistrationResult.md

@@ -4,14 +4,14 @@
 
 ### err\_code
 
-• **err\_code**: [`TournamentRegistrationError`](../enums/TournamentRegistrationError.md)
+> **err\_code**: [`TournamentRegistrationError`](../enumerations/TournamentRegistrationError.md)
 
 Error code that represents outcome of the tournament registration request. Successful registration in case err_code is 0
 
-___
+***
 
 ### err\_message
 
-• **err\_message**: `string`
+> **err\_message**: `string`
 
 Optional error message

package/docs/api/interfaces/TUICustomSection.md

@@ -4,142 +4,142 @@
 
 ### id
 
-• **id**: `number`
+> **id**: `number`
 
 The ID of the custom section
 
-___
+***
 
-### body
+### body?
 
-• `Optional` **body**: `string`
+> `optional` **body?**: `string`
 
 The body of the custom section
 
-___
+***
 
-### menu\_img
+### menu\_img?
 
-• `Optional` **menu\_img**: `string`
+> `optional` **menu\_img?**: `string`
 
 The image of the custom section, 64x64px
 
-___
+***
 
-### menu\_name
+### menu\_name?
 
-• `Optional` **menu\_name**: `string`
+> `optional` **menu\_name?**: `string`
 
 The name of the custom section
 
-___
+***
 
-### custom\_skin\_images
+### custom\_skin\_images?
 
-• `Optional` **custom\_skin\_images**: `string`
+> `optional` **custom\_skin\_images?**: `string`
 
 Custom images for custom section
 
-___
+***
 
-### section\_type\_id
+### section\_type\_id?
 
-• `Optional` **section\_type\_id**: [`AchCustomSectionType`](../enums/AchCustomSectionType.md)
+> `optional` **section\_type\_id?**: [`AchCustomSectionType`](../enumerations/AchCustomSectionType.md)
 
 The particular type of custom section, can be Missions, Tournaments, Lootbox and etc
 
-___
+***
 
-### theme
+### theme?
 
-• `Optional` **theme**: [`AchCustomLayoutTheme`](../enums/AchCustomLayoutTheme.md)
+> `optional` **theme?**: [`AchCustomLayoutTheme`](../enumerations/AchCustomLayoutTheme.md)
 
 Theme of the custom section
 
-___
+***
 
-### generic\_custom\_css
+### generic\_custom\_css?
 
-• `Optional` **generic\_custom\_css**: `string`
+> `optional` **generic\_custom\_css?**: `string`
 
 Custom css for the custom section
 
-___
+***
 
-### mission\_tabs\_options
+### mission\_tabs\_options?
 
-• `Optional` **mission\_tabs\_options**: [`AchMissionsTabsOptions`](../enums/AchMissionsTabsOptions.md)
+> `optional` **mission\_tabs\_options?**: [`AchMissionsTabsOptions`](../enumerations/AchMissionsTabsOptions.md)
 
 Tabs that can be shown in custom section, e.g Overview, No Overview, All tabs
 
-___
+***
 
-### overview\_missions\_filter
+### overview\_missions\_filter?
 
-• `Optional` **overview\_missions\_filter**: [`AchOverviewMissionsFilter`](../enums/AchOverviewMissionsFilter.md)
+> `optional` **overview\_missions\_filter?**: [`AchOverviewMissionsFilter`](../enumerations/AchOverviewMissionsFilter.md)
 
 Filter that allow to show missions by criteria
 
-___
+***
 
-### overview\_missions\_count
+### overview\_missions\_count?
 
-• `Optional` **overview\_missions\_count**: `number`
+> `optional` **overview\_missions\_count?**: `number`
 
 Quantity of missions to be shown in overview
 
-___
+***
 
-### liquid\_entity\_data
+### liquid\_entity\_data?
 
-• `Optional` **liquid\_entity\_data**: [`LiquidEntityData`](../enums/LiquidEntityData.md)[]
+> `optional` **liquid\_entity\_data?**: [`LiquidEntityData`](../enumerations/LiquidEntityData.md)[]
 
 Data to be used for Liquid templates
 
-___
+***
 
-### ach\_tournament\_id
+### ach\_tournament\_id?
 
-• `Optional` **ach\_tournament\_id**: `number`
+> `optional` **ach\_tournament\_id?**: `number`
 
 Tournament ID to be used for Liquid templates
 
-___
+***
 
-### show\_raw\_data
+### show\_raw\_data?
 
-• `Optional` **show\_raw\_data**: `boolean`
+> `optional` **show\_raw\_data?**: `boolean`
 
 Indicates if the data should be shown as raw data (for Liquid templates)
 
-___
+***
 
-### liquid\_template
+### liquid\_template?
 
-• `Optional` **liquid\_template**: `number`
+> `optional` **liquid\_template?**: `number`
 
 Liquid template id to be used for Liquid templates
 
-___
+***
 
-### ach\_category\_ids
+### ach\_category\_ids?
 
-• `Optional` **ach\_category\_ids**: `number`[]
+> `optional` **ach\_category\_ids?**: `number`[]
 
 List of IDs of the categories where the badge item is assigned, information about categories can be retrieved with getAchCategories method
 
-___
+***
 
-### shop\_category\_ids
+### shop\_category\_ids?
 
-• `Optional` **shop\_category\_ids**: `number`[]
+> `optional` **shop\_category\_ids?**: `number`[]
 
 List of IDs of the categories where the store item is assigned, information about categories can be retrieved with getShopCategories method
 
-___
+***
 
-### raffle\_id
+### raffle\_id?
 
-• `Optional` **raffle\_id**: `number`
+> `optional` **raffle\_id?**: `number`
 
 ID of the raffle to be used for Liquid templates

package/docs/api/interfaces/TUserProfile.md

@@ -9,105 +9,105 @@ If you want to track the changes of the user profile, you can subscribe to the c
 
 ### core\_user\_language
 
-• **core\_user\_language**: `string`
+> **core\_user\_language**: `string`
 
 The language of the user
 
-___
+***
 
 ### ach\_points\_balance
 
-• **ach\_points\_balance**: `number`
+> **ach\_points\_balance**: `number`
 
 The current points balance that user can use in the Store, Mini-games, Tournaments, etc..
 
-___
+***
 
 ### ach\_points\_ever
 
-• **ach\_points\_ever**: `number`
+> **ach\_points\_ever**: `number`
 
 The amount of points that user collected in total
 
-___
+***
 
 ### ach\_gems\_balance
 
-• **ach\_gems\_balance**: `number`
+> **ach\_gems\_balance**: `number`
 
 The current gems balance
 
-___
+***
 
 ### ach\_diamonds\_balance
 
-• **ach\_diamonds\_balance**: `number`
+> **ach\_diamonds\_balance**: `number`
 
 The current diamonds balance
 
-___
+***
 
 ### core\_public\_tags
 
-• **core\_public\_tags**: `string`[]
+> **core\_public\_tags**: `string`[]
 
 The array of the public tags set on the user object.
 They can be treated as server-based cookies.
 You can set tags using following method _smartico.event('core_public_tags_update', { core_public_tags: ['A', 'B'] } );
 And then you can check for the tags
 
-___
+***
 
-### ach\_level\_current\_id
+### ach\_level\_current\_id?
 
-• `Optional` **ach\_level\_current\_id**: `number`
+> `optional` **ach\_level\_current\_id?**: `number`
 
 The ID of the current level of the user
 
-___
+***
 
-### core\_is\_test\_account
+### core\_is\_test\_account?
 
-• `Optional` **core\_is\_test\_account**: `boolean`
+> `optional` **core\_is\_test\_account?**: `boolean`
 
 The indicator if user is marked as test user
 
-___
+***
 
-### avatar\_url
+### avatar\_url?
 
-• `Optional` **avatar\_url**: `string`
+> `optional` **avatar\_url?**: `string`
 
 The URL to the user avatar
 
-___
+***
 
-### public\_username
+### public\_username?
 
-• `Optional` **public\_username**: `string`
+> `optional` **public\_username?**: `string`
 
 The username of current user
 
-___
+***
 
-### core\_inbox\_unread\_count
+### core\_inbox\_unread\_count?
 
-• `Optional` **core\_inbox\_unread\_count**: `number`
+> `optional` **core\_inbox\_unread\_count?**: `number`
 
 THe number of unread inbox messages
 
-___
+***
 
-### core\_recommended\_deposit\_amount
+### core\_recommended\_deposit\_amount?
 
-• `Optional` **core\_recommended\_deposit\_amount**: `number`
+> `optional` **core\_recommended\_deposit\_amount?**: `number`
 
 The recommended deposit amount for the user
 
-___
+***
 
-### core\_recommended\_casino\_bet\_amount
+### core\_recommended\_casino\_bet\_amount?
 
-• `Optional` **core\_recommended\_casino\_bet\_amount**: `number`
+> `optional` **core\_recommended\_casino\_bet\_amount?**: `number`
 
 The recommended casino bet amount for the user

package/docs/api/interfaces/Tournament.md

@@ -2,214 +2,220 @@
 
 ## Properties
 
-### tournamentId
+### tournamentId?
 
-• `Optional` **tournamentId**: `number`
+> `optional` **tournamentId?**: `number`
 
 ID of tournament template
 
-___
+***
 
-### tournamentInstanceId
+### tournamentInstanceId?
 
-• `Optional` **tournamentInstanceId**: `number`
+> `optional` **tournamentInstanceId?**: `number`
 
 ID of tournament instance. Generated every time when tournament based on specific template is scheduled for run
 
-___
+***
 
-### tournamentType
+### tournamentType?
 
-• `Optional` **tournamentType**: [`TournamentType`](../enums/TournamentType.md)
+> `optional` **tournamentType?**: [`TournamentType`](../enumerations/TournamentType.md)
 
 Type of the tournament. For now only SCHEDULED is support
 
-___
+***
 
-### publicMeta
+### publicMeta?
 
-• `Optional` **publicMeta**: [`TournamentPublicMeta`](TournamentPublicMeta.md)
+> `optional` **publicMeta?**: [`TournamentPublicMeta`](TournamentPublicMeta.md)
 
 Meta information about tournament that should be used to build UI
 
-___
+***
 
-### buyInAmount
+### buyInAmount?
 
-• `Optional` **buyInAmount**: `number`
+> `optional` **buyInAmount?**: `number`
 
 Cost of registration in the tournament in gamification points
 
-___
+***
 
-### prizePool
+### prizePool?
 
-• `Optional` **prizePool**: `number`
+> `optional` **prizePool?**: `number`
 
 Not in use
 
-___
+***
 
-### startTime
+### startTime?
 
-• `Optional` **startTime**: `string`
+> `optional` **startTime?**: `string`
 
 The time when tournament is going to start
 
-___
+***
 
-### endTime
+### endTime?
 
-• `Optional` **endTime**: `string`
+> `optional` **endTime?**: `string`
 
 The time when tournament is going to finish
 
-___
+***
 
-### startTimeTs
+### startTimeTs?
 
-• `Optional` **startTimeTs**: `number`
+> `optional` **startTimeTs?**: `number`
 
 The time when tournament is going to start, epoch
 
-___
+***
 
-### endTimeTs
+### endTimeTs?
 
-• `Optional` **endTimeTs**: `number`
+> `optional` **endTimeTs?**: `number`
 
 The time when tournament is going to finish, epoch
 
-___
+***
 
-### registrationCount
+### registrationCount?
 
-• `Optional` **registrationCount**: `number`
+> `optional` **registrationCount?**: `number`
 
 Number of users registered in the tournament
 
-___
+***
 
-### totalCount
+### totalCount?
 
-• `Optional` **totalCount**: `number`
+> `optional` **totalCount?**: `number`
 
 Not in use
 
-___
+***
 
-### registrationType
+### registrationType?
 
-• `Optional` **registrationType**: [`TournamentRegistrationType`](../enums/TournamentRegistrationType.md)
+> `optional` **registrationType?**: [`TournamentRegistrationType`](../enumerations/TournamentRegistrationType.md)
 
 Type of registration in the tournament
 
-___
+***
 
-### tournamentRegistrationStatus
+### tournamentRegistrationStatus?
 
-• `Optional` **tournamentRegistrationStatus**: [`TournamentRegistrationStatus`](../enums/TournamentRegistrationStatus.md)
+> `optional` **tournamentRegistrationStatus?**: [`TournamentRegistrationStatus`](../enumerations/TournamentRegistrationStatus.md)
 
 Status of registration in the tournament for current user
 
-___
+***
 
-### tournamentInstanceStatus
+### tournamentInstanceStatus?
 
-• `Optional` **tournamentInstanceStatus**: [`TournamentInstanceStatus`](../enums/TournamentInstanceStatus.md)
+> `optional` **tournamentInstanceStatus?**: [`TournamentInstanceStatus`](../enumerations/TournamentInstanceStatus.md)
 
 Status of tournament instance
 
-___
+***
 
-### isUserRegistered
+### isUserRegistered?
 
-• `Optional` **isUserRegistered**: `boolean`
+> `optional` **isUserRegistered?**: `boolean`
 
 flag indicating if current user is registered in the tournament
 
-___
+***
 
-### allowLateRegistration
+### allowLateRegistration?
 
-• `Optional` **allowLateRegistration**: `boolean`
+> `optional` **allowLateRegistration?**: `boolean`
 
 Indicator if tournament allows later registration, when tournament is already started
 
-___
+***
 
-### playersMinCount
+### playersMinCount?
 
-• `Optional` **playersMinCount**: `number`
+> `optional` **playersMinCount?**: `number`
 
 Minimum number of participant for this tournament. If tournament doesnt have enough registrations, it will not start
 
-___
+***
 
-### playersMaxCount
+### playersMaxCount?
 
-• `Optional` **playersMaxCount**: `number`
+> `optional` **playersMaxCount?**: `number`
 
 Maximum number of participant for this tournament. When reached, new users won't be able to register
 
-___
+***
 
-### durationMs
+### durationMs?
 
-• `Optional` **durationMs**: `number`
+> `optional` **durationMs?**: `number`
 
 Tournament duration in millisecnnds
 
-___
+***
 
-### prizeStructure
+### prizeStructure?
 
-• `Optional` **prizeStructure**: `Object`
+> `optional` **prizeStructure?**: `object`
 
 prizes structure
 
-#### Type declaration
+#### prizes
 
-| Name | Type |
-| :------ | :------ |
-| `prizes` | [`TournamentPrize`](TournamentPrize.md)[] |
+> **prizes**: [`TournamentPrize`](TournamentPrize.md)[]
 
-___
+***
 
-### tournamentPlayer
+### tournamentPlayer?
 
-• `Optional` **tournamentPlayer**: [`TournamentPlayer`](TournamentPlayer.md)
+> `optional` **tournamentPlayer?**: [`TournamentPlayer`](TournamentPlayer.md)
 
 Information about current user
 
-___
+***
 
-### related\_games
+### related\_games?
 
-• `Optional` **related\_games**: [`AchRelatedGame`](AchRelatedGame.md)[]
+> `optional` **related\_games?**: [`AchRelatedGame`](AchRelatedGame.md)[]
 
 List of casino games (or other types of entities) related to the tournament
 
-___
+***
 
-### minScoreToWin
+### minScoreToWin?
 
-• `Optional` **minScoreToWin**: `number`
+> `optional` **minScoreToWin?**: `number`
 
 The minimum amount of score points that the user should get in order to be qualified for the prize
 
-___
+***
 
-### hideLeaderboardsMinScores
+### hideLeaderboardsMinScores?
 
-• `Optional` **hideLeaderboardsMinScores**: `boolean`
+> `optional` **hideLeaderboardsMinScores?**: `boolean`
 
 When enabled, users who don't meet the minimum qualifying score will be hidden from the Leaderboard.
 
-___
+***
 
-### totalScores
+### totalScores?
 
-• `Optional` **totalScores**: `number`
+> `optional` **totalScores?**: `number`
 
 Total scores across all participants in the tournament
+
+***
+
+### isClanBased?
+
+> `optional` **isClanBased?**: `boolean`
+
+Indicates if the tournament is clan-based