@smartico/public-api 0.0.340 → 0.0.342

package/docs/api/interfaces/Tournament.md

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

package/docs/{interfaces → api/interfaces}/TournamentPlayer.md

@@ -1,75 +1,55 @@
 # Interface: TournamentPlayer
 
-Tournament player/participant object (raw, non-transformed).
-
 ## Properties
 
 ### userAltName
 
 • **userAltName**: `string`
 
-User's display name (public username)
-
 ___
 
 ### cleanExtUserId
 
 • **cleanExtUserId**: `string`
 
-Clean external user ID
-
 ___
 
 ### crmBrandId
 
 • **crmBrandId**: `number`
 
-CRM brand ID
-
 ___
 
 ### position
 
 • **position**: `number`
 
-User's position in the tournament leaderboard
-
 ___
 
 ### scores
 
 • **scores**: `number`
 
-User's score in the tournament
-
 ___
 
 ### isMe
 
 • **isMe**: `boolean`
 
-Whether this is the current user
-
 ___
 
 ### userId
 
 • **userId**: `number`
 
-Internal user ID
-
 ___
 
 ### avatar\_id
 
 • **avatar\_id**: `string`
 
-Avatar ID
-
 ___
 
 ### avatar\_url
 
-• **avatar\_url**: `string`
-
-Avatar URL (optional)
+• `Optional` **avatar\_url**: `string`

package/docs/{interfaces → api/interfaces}/TournamentPrize.md

@@ -1,54 +1,40 @@
 # Interface: TournamentPrize
 
-Tournament prize object (raw, non-transformed).
-
 ## Properties
 
 ### name
 
 • **name**: `string`
 
-Prize name
-
 ___
 
 ### description
 
 • **description**: `string`
 
-Prize description
-
 ___
 
 ### image\_url
 
 • **image\_url**: `string`
 
-Prize image URL
-
 ___
 
 ### place\_from
 
 • **place\_from**: `number`
 
-Starting place for this prize (e.g., 1 for 1st place)
-
 ___
 
 ### place\_to
 
 • **place\_to**: `number`
 
-Ending place for this prize (e.g., 3 for places 1-3)
-
 ___
 
 ### type
 
-• **type**: `number`
-
-Prize type (ActivityTypeLimited)
+• **type**: `ActivityTypeLimited`
 
 ___
 
@@ -56,20 +42,14 @@ ___
 
 • **points**: `number`
 
-Points reward amount
-
 ___
 
 ### gems
 
 • **gems**: `number`
 
-Gems reward amount
-
 ___
 
 ### diamonds
 
 • **diamonds**: `number`
-
-Diamonds reward amount

package/docs/api/interfaces/UICustomSection.md

@@ -0,0 +1,103 @@
+# Interface: UICustomSection
+
+## Properties
+
+### body
+
+• `Optional` **body**: `string`
+
+___
+
+### menu\_img
+
+• `Optional` **menu\_img**: `string`
+
+___
+
+### menu\_name
+
+• `Optional` **menu\_name**: `string`
+
+___
+
+### custom\_skin\_images
+
+• `Optional` **custom\_skin\_images**: `string`
+
+___
+
+### section\_type\_id
+
+• `Optional` **section\_type\_id**: [`AchCustomSectionType`](../enums/AchCustomSectionType.md)
+
+___
+
+### theme
+
+• `Optional` **theme**: [`AchCustomLayoutTheme`](../enums/AchCustomLayoutTheme.md)
+
+___
+
+### generic\_custom\_css
+
+• `Optional` **generic\_custom\_css**: `string`
+
+___
+
+### mission\_tabs\_options
+
+• `Optional` **mission\_tabs\_options**: [`AchMissionsTabsOptions`](../enums/AchMissionsTabsOptions.md)
+
+___
+
+### overview\_missions\_filter
+
+• `Optional` **overview\_missions\_filter**: [`AchOverviewMissionsFilter`](../enums/AchOverviewMissionsFilter.md)
+
+___
+
+### overview\_missions\_count
+
+• `Optional` **overview\_missions\_count**: `number`
+
+___
+
+### liquid\_entity\_data
+
+• `Optional` **liquid\_entity\_data**: [`LiquidEntityData`](../enums/LiquidEntityData.md)[]
+
+___
+
+### ach\_tournament\_id
+
+• `Optional` **ach\_tournament\_id**: `number`
+
+___
+
+### raffle\_id
+
+• `Optional` **raffle\_id**: `number`
+
+___
+
+### show\_raw\_data
+
+• `Optional` **show\_raw\_data**: `boolean`
+
+___
+
+### liquid\_template
+
+• `Optional` **liquid\_template**: `number`
+
+___
+
+### ach\_category\_ids
+
+• `Optional` **ach\_category\_ids**: `number`[]
+
+___
+
+### shop\_category\_ids
+
+• `Optional` **shop\_category\_ids**: `number`[]

package/docs/api/interfaces/UserAchievement.md

@@ -0,0 +1,205 @@
+# Interface: UserAchievement
+
+## Properties
+
+### ach\_id
+
+• `Optional` **ach\_id**: `number`
+
+___
+
+### ach\_type\_id
+
+• `Optional` **ach\_type\_id**: `AchievementType`
+
+___
+
+### ach\_public\_meta
+
+• `Optional` **ach\_public\_meta**: [`AchievementPublicMeta`](AchievementPublicMeta.md)
+
+___
+
+### isCompleted
+
+• `Optional` **isCompleted**: `boolean`
+
+___
+
+### isLocked
+
+• `Optional` **isLocked**: `boolean`
+
+___
+
+### requiresOptin
+
+• `Optional` **requiresOptin**: `boolean`
+
+___
+
+### isOptedIn
+
+• `Optional` **isOptedIn**: `boolean`
+
+___
+
+### start\_date
+
+• `Optional` **start\_date**: `string`
+
+___
+
+### start\_date\_ts
+
+• `Optional` **start\_date\_ts**: `number`
+
+___
+
+### time\_limit\_ms
+
+• `Optional` **time\_limit\_ms**: `number`
+
+___
+
+### progress
+
+• `Optional` **progress**: `number`
+
+___
+
+### complete\_date
+
+• `Optional` **complete\_date**: `string`
+
+___
+
+### complete\_date\_ts
+
+• `Optional` **complete\_date\_ts**: `number`
+
+___
+
+### unlock\_date
+
+• `Optional` **unlock\_date**: `string`
+
+___
+
+### milliseconds\_till\_available
+
+• `Optional` **milliseconds\_till\_available**: `number`
+
+___
+
+### completed\_tasks
+
+• `Optional` **completed\_tasks**: `number`
+
+___
+
+### achievementTasks
+
+• `Optional` **achievementTasks**: [`UserAchievementTask`](UserAchievementTask.md)[]
+
+___
+
+### next\_recurrence\_date\_ts
+
+• `Optional` **next\_recurrence\_date\_ts**: `number`
+
+___
+
+### ach\_status\_id
+
+• `Optional` **ach\_status\_id**: `AchievementStatus`
+
+___
+
+### scheduledMissionType
+
+• `Optional` **scheduledMissionType**: `ScheduledMissionType`
+
+___
+
+### related\_games
+
+• `Optional` **related\_games**: [`AchRelatedGame`](AchRelatedGame.md)[]
+
+___
+
+### active\_from\_ts
+
+• `Optional` **active\_from\_ts**: `number`
+
+___
+
+### active\_till\_ts
+
+• `Optional` **active\_till\_ts**: `number`
+
+___
+
+### ach\_categories
+
+• `Optional` **ach\_categories**: `number`[]
+
+___
+
+### recurring\_quantity
+
+• `Optional` **recurring\_quantity**: `number`
+
+___
+
+### completed\_count
+
+• `Optional` **completed\_count**: `number`
+
+___
+
+### ach\_completed\_id
+
+• `Optional` **ach\_completed\_id**: `number`
+
+___
+
+### requires\_prize\_claim
+
+• `Optional` **requires\_prize\_claim**: `boolean`
+
+___
+
+### prize\_claimed\_date\_ts
+
+• `Optional` **prize\_claimed\_date\_ts**: `number`
+
+___
+
+### completed\_today
+
+• `Optional` **completed\_today**: `boolean`
+
+___
+
+### completed\_this\_week
+
+• `Optional` **completed\_this\_week**: `boolean`
+
+___
+
+### completed\_this\_month
+
+• `Optional` **completed\_this\_month**: `boolean`
+
+___
+
+### custom\_section\_type\_id
+
+• `Optional` **custom\_section\_type\_id**: `number`
+
+___
+
+### badgeTimeLimitState
+
+• `Optional` **badgeTimeLimitState**: `BadgesTimeLimitStates`