@smartico/public-api 0.0.336 → 0.0.338

package/docs/interfaces/StoreItem.md

@@ -0,0 +1,59 @@
+# Interface: StoreItem
+
+Store item object (raw, non-transformed).
+
+## Properties
+
+### id
+
+• **id**: `number`
+
+Item ID
+
+___
+
+### itemTypeId
+
+• **itemTypeId**: `number`
+
+Item type ID
+
+___
+
+### itemPublicMeta
+
+• **itemPublicMeta**: `StoreItemPublicMeta`
+
+Public metadata for UI display (name, description, price, image, etc.)
+
+___
+
+### categoryIds
+
+• **categoryIds**: `number[]`
+
+Array of category IDs this item belongs to
+
+___
+
+### canBuy
+
+• **canBuy**: `boolean`
+
+Whether the user can currently buy this item
+
+___
+
+### shopPool
+
+• **shopPool**: `number`
+
+Available stock in the shop pool
+
+___
+
+### activeTillDate
+
+• **activeTillDate**: `number`
+
+Timestamp when the item expires (optional)

package/docs/interfaces/TStoreItem.md

@@ -38,7 +38,7 @@ ___
 
 ### type
 
-• **type**: ``"bonus"`` \| ``"tangible"`` \| ``"minigamespin"`` \| ``"changelevel"`` \| ``"prizedrop"`` \| ``"raffleticket"`` \| ``"unknown"``
+• **type**: ``"unknown"`` \| ``"bonus"`` \| ``"tangible"`` \| ``"minigamespin"`` \| ``"changelevel"`` \| ``"prizedrop"`` \| ``"raffleticket"``
 
 Type of the store item. Can be 'bonus' or 'tangible' or different others.
 
@@ -214,3 +214,27 @@ ___
 • `Optional` **custom\_ribbon\_image**: `string`
 
 The custom ribbon image of the discounted price.
+
+___
+
+### custom\_section\_id
+
+• `Optional` **custom\_section\_id**: `number`
+
+The ID of the custom section where the store item is assigned
+
+___
+
+### only\_in\_custom\_section
+
+• `Optional` **only\_in\_custom\_section**: `boolean`
+
+The indicator if the store item is visible only in the custom section and should be hidden from the main overview of store items
+
+___
+
+### custom\_section\_type\_id
+
+• `Optional` **custom\_section\_type\_id**: `number`
+
+ID of specific Custom Section type

package/docs/interfaces/TUICustomSection.md

@@ -127,3 +127,11 @@ ___
 • `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
+
+• `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

package/docs/interfaces/Tournament.md

@@ -0,0 +1,187 @@
+# Interface: Tournament
+
+Tournament object (raw, non-transformed).
+
+## Properties
+
+### tournamentId
+
+• **tournamentId**: `number`
+
+ID of tournament template
+
+___
+
+### tournamentInstanceId
+
+• **tournamentInstanceId**: `number`
+
+ID of tournament instance. Generated every time when tournament based on specific template is scheduled for run
+
+___
+
+### tournamentType
+
+• **tournamentType**: `number`
+
+Type of the tournament
+
+___
+
+### publicMeta
+
+• **publicMeta**: `TournamentPublicMeta`
+
+Meta information about tournament that should be used to build UI
+
+___
+
+### buyInAmount
+
+• **buyInAmount**: `number`
+
+Cost of registration in the tournament in gamification points
+
+___
+
+### startTime
+
+• **startTime**: `string`
+
+The time when tournament is going to start (ISO string)
+
+___
+
+### endTime
+
+• **endTime**: `string`
+
+The time when tournament is going to finish (ISO string)
+
+___
+
+### startTimeTs
+
+• **startTimeTs**: `number`
+
+The time when tournament is going to start (Unix timestamp)
+
+___
+
+### endTimeTs
+
+• **endTimeTs**: `number`
+
+The time when tournament is going to finish (Unix timestamp)
+
+___
+
+### registrationCount
+
+• **registrationCount**: `number`
+
+Number of users registered in the tournament
+
+___
+
+### registrationType
+
+• **registrationType**: `number`
+
+Type of registration in the tournament
+
+___
+
+### tournamentRegistrationStatus
+
+• **tournamentRegistrationStatus**: `number`
+
+Status of registration in the tournament for current user
+
+___
+
+### tournamentInstanceStatus
+
+• **tournamentInstanceStatus**: `number`
+
+Status of tournament instance
+
+___
+
+### isUserRegistered
+
+• **isUserRegistered**: `boolean`
+
+Flag indicating if current user is registered in the tournament
+
+___
+
+### allowLateRegistration
+
+• **allowLateRegistration**: `boolean`
+
+Indicator if tournament allows later registration when tournament is already started
+
+___
+
+### playersMinCount
+
+• **playersMinCount**: `number`
+
+Minimum number of participants for this tournament
+
+___
+
+### playersMaxCount
+
+• **playersMaxCount**: `number`
+
+Maximum number of participants for this tournament
+
+___
+
+### durationMs
+
+• **durationMs**: `number`
+
+Tournament duration in milliseconds
+
+___
+
+### prizeStructure
+
+• **prizeStructure**: `object`
+
+Prizes structure with array of TournamentPrize objects
+
+___
+
+### tournamentPlayer
+
+• **tournamentPlayer**: `TournamentPlayer`
+
+Information about current user in tournament
+
+___
+
+### related\_games
+
+• **related\_games**: `AchRelatedGame[]`
+
+List of casino games related to the tournament
+
+___
+
+### minScoreToWin
+
+• **minScoreToWin**: `number`
+
+Minimum score points required to qualify for a prize
+
+___
+
+### hideLeaderboardsMinScores
+
+• **hideLeaderboardsMinScores**: `boolean`
+
+When enabled, users who don't meet minimum qualifying score are hidden from Leaderboard

package/docs/interfaces/TournamentPlayer.md

@@ -0,0 +1,75 @@
+# 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)

package/docs/interfaces/TournamentPrize.md

@@ -0,0 +1,75 @@
+# 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)
+
+___
+
+### points
+
+• **points**: `number`
+
+Points reward amount
+
+___
+
+### gems
+
+• **gems**: `number`
+
+Gems reward amount
+
+___
+
+### diamonds
+
+• **diamonds**: `number`
+
+Diamonds reward amount

package/docs/interfaces/UICustomSection.md

@@ -0,0 +1,123 @@
+# Interface: UICustomSection
+
+Custom UI section configuration.
+
+## Properties
+
+### body
+
+• **body**: `string`
+
+HTML body content for the section
+
+___
+
+### menu\_img
+
+• **menu\_img**: `string`
+
+Menu icon image URL
+
+___
+
+### menu\_name
+
+• **menu\_name**: `string`
+
+Menu display name (translated)
+
+___
+
+### custom\_skin\_images
+
+• **custom\_skin\_images**: `string`
+
+Custom skin images configuration
+
+___
+
+### section\_type\_id
+
+• **section\_type\_id**: [`AchCustomSectionType`](AchCustomSectionType.md)
+
+Section type identifier
+
+___
+
+### theme
+
+• **theme**: `string`
+
+Theme identifier (e.g., "valentines-light", "euro-2024", "generic")
+
+___
+
+### generic\_custom\_css
+
+• **generic\_custom\_css**: `string`
+
+Custom CSS for the section
+
+___
+
+### mission\_tabs\_options
+
+• **mission\_tabs\_options**: `number`
+
+Mission tabs display option (1=ONLY_OVERVIEW, 2=NO_OVERVIEW, 3=ALL)
+
+___
+
+### overview\_missions\_filter
+
+• **overview\_missions\_filter**: `number`
+
+Filter for overview missions display
+
+___
+
+### overview\_missions\_count
+
+• **overview\_missions\_count**: `number`
+
+Number of missions to show in overview
+
+___
+
+### liquid\_entity\_data
+
+• **liquid\_entity\_data**: `number[]`
+
+Entity data types for liquid templates
+
+___
+
+### ach\_tournament\_id
+
+• **ach\_tournament\_id**: `number`
+
+Associated tournament ID
+
+___
+
+### show\_raw\_data
+
+• **show\_raw\_data**: `boolean`
+
+Whether to show raw data
+
+___
+
+### liquid\_template
+
+• **liquid\_template**: `number`
+
+Liquid template ID
+
+___
+
+### ach\_category\_ids
+
+• **ach\_category\_ids**: `number[]`
+
+Associated achievement category IDs