@smartico/public-api 0.0.341 → 0.0.343

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (188) hide show
  1. package/README.md +1 -1
  2. package/docs/api/.nojekyll +1 -0
  3. package/docs/api/README.md +415 -0
  4. package/docs/api/interfaces/AchCategory.md +13 -0
  5. package/docs/api/interfaces/AchCategoryPublicMeta.md +13 -0
  6. package/docs/api/interfaces/AchievementPublicMeta.md +133 -0
  7. package/docs/api/interfaces/Bonus.md +79 -0
  8. package/docs/api/interfaces/GemsDiamondsLog.md +43 -0
  9. package/docs/api/interfaces/GetTournamentInfoResponse.md +95 -0
  10. package/docs/api/interfaces/InboxMessage.md +49 -0
  11. package/docs/api/interfaces/InboxMessageBody.md +73 -0
  12. package/docs/{interfaces → api/interfaces}/Level.md +1 -17
  13. package/docs/api/interfaces/LevelPublicMeta.md +60 -0
  14. package/docs/api/interfaces/PointsLog.md +43 -0
  15. package/docs/{interfaces → api/interfaces}/SAWPrizesHistory.md +0 -18
  16. package/docs/api/interfaces/StoreCategory.md +13 -0
  17. package/docs/api/interfaces/StoreCategoryPublicMeta.md +13 -0
  18. package/docs/api/interfaces/StoreItem.md +43 -0
  19. package/docs/{interfaces → api/interfaces}/TTournamentRegistrationResult.md +1 -1
  20. package/docs/{interfaces → api/interfaces}/TUICustomSection.md +8 -0
  21. package/docs/api/interfaces/Tournament.md +207 -0
  22. package/docs/{interfaces → api/interfaces}/TournamentPlayer.md +1 -21
  23. package/docs/{interfaces → api/interfaces}/TournamentPrize.md +1 -21
  24. package/docs/api/interfaces/UICustomSection.md +103 -0
  25. package/docs/api/interfaces/UserAchievement.md +205 -0
  26. package/docs/api/interfaces/UserAchievementTask.md +83 -0
  27. package/docs/native/ADDING_METHODS.md +4 -4
  28. package/docs/native/PROTOCOL.md +35 -28
  29. package/package.json +1 -1
  30. package/tsconfig.json +19 -2
  31. package/docs/enums/TournamentRegistrationError.md +0 -55
  32. package/docs/interfaces/AchCategory.md +0 -19
  33. package/docs/interfaces/AchCategoryPublicMeta.md +0 -19
  34. package/docs/interfaces/AchCustomSectionType.md +0 -21
  35. package/docs/interfaces/AchievementPublicMeta.md +0 -155
  36. package/docs/interfaces/Bonus.md +0 -107
  37. package/docs/interfaces/GetTournamentInfoResponse.md +0 -37
  38. package/docs/interfaces/InboxMessage.md +0 -51
  39. package/docs/interfaces/InboxMessageBody.md +0 -64
  40. package/docs/interfaces/LevelPublicMeta.md +0 -51
  41. package/docs/interfaces/StoreCategory.md +0 -19
  42. package/docs/interfaces/StoreCategoryPublicMeta.md +0 -19
  43. package/docs/interfaces/StoreItem.md +0 -59
  44. package/docs/interfaces/Tournament.md +0 -187
  45. package/docs/interfaces/UICustomSection.md +0 -123
  46. package/docs/interfaces/UserAchievement.md +0 -275
  47. package/docs/interfaces/UserAchievementTask.md +0 -67
  48. /package/docs/{classes → api/classes}/SAWUtils.md +0 -0
  49. /package/docs/{classes → api/classes}/WSAPI.md +0 -0
  50. /package/docs/{enums → api/enums}/AchCustomLayoutTheme.md +0 -0
  51. /package/docs/{enums → api/enums}/AchCustomSectionType.md +0 -0
  52. /package/docs/{enums → api/enums}/AchMissionsTabsOptions.md +0 -0
  53. /package/docs/{enums → api/enums}/AchOverviewMissionsFilter.md +0 -0
  54. /package/docs/{enums → api/enums}/AchievementAvailabilityStatus.md +0 -0
  55. /package/docs/{enums → api/enums}/AttemptPeriodType.md +0 -0
  56. /package/docs/{enums → api/enums}/BonusStatus-1.md +0 -0
  57. /package/docs/{enums → api/enums}/BonusStatus.md +0 -0
  58. /package/docs/{enums → api/enums}/BuyStoreItemErrorCode.md +0 -0
  59. /package/docs/{enums → api/enums}/InboxCategories.md +0 -0
  60. /package/docs/{enums → api/enums}/JackPotTemparature.md +0 -0
  61. /package/docs/{enums → api/enums}/JackpotContributionType.md +0 -0
  62. /package/docs/{enums → api/enums}/JackpotType.md +0 -0
  63. /package/docs/{enums → api/enums}/LeaderBoardPeriodType.md +0 -0
  64. /package/docs/{enums → api/enums}/LiquidEntityData.md +0 -0
  65. /package/docs/{enums → api/enums}/MiniGamePrizeTypeName.md +0 -0
  66. /package/docs/{enums → api/enums}/PointChangeSourceType.md +0 -0
  67. /package/docs/{enums → api/enums}/PrizeModifiers.md +0 -0
  68. /package/docs/{enums → api/enums}/RaffleDrawInstanceState.md +0 -0
  69. /package/docs/{enums → api/enums}/RaffleDrawTypeExecution.md +0 -0
  70. /package/docs/{enums → api/enums}/SAWAcknowledgeType.md +0 -0
  71. /package/docs/{enums → api/enums}/SAWAcknowledgeTypeName.md +0 -0
  72. /package/docs/{enums → api/enums}/SAWAskForUsername.md +0 -0
  73. /package/docs/{enums → api/enums}/SAWBuyInType.md +0 -0
  74. /package/docs/{enums → api/enums}/SAWBuyInTypeName.md +0 -0
  75. /package/docs/{enums → api/enums}/SAWExposeUserSpinId.md +0 -0
  76. /package/docs/{enums → api/enums}/SAWGameDifficultyType.md +0 -0
  77. /package/docs/{enums → api/enums}/SAWGameDifficultyTypeName.md +0 -0
  78. /package/docs/{enums → api/enums}/SAWGameLayout.md +0 -0
  79. /package/docs/{enums → api/enums}/SAWGameType.md +0 -0
  80. /package/docs/{enums → api/enums}/SAWGameTypeName.md +0 -0
  81. /package/docs/{enums → api/enums}/SAWPrizeType.md +0 -0
  82. /package/docs/{enums → api/enums}/SAWSpinErrorCode.md +0 -0
  83. /package/docs/{enums → api/enums}/SAWWheelLayout.md +0 -0
  84. /package/docs/{enums → api/enums}/SAWWinSoundType.md +0 -0
  85. /package/docs/{enums → api/enums}/TournamentRegistrationStatus.md +0 -0
  86. /package/docs/{enums → api/enums}/TournamentRegistrationStatusName.md +0 -0
  87. /package/docs/{enums → api/enums}/TournamentRegistrationType.md +0 -0
  88. /package/docs/{enums → api/enums}/UserBalanceType.md +0 -0
  89. /package/docs/{interfaces → api/interfaces}/AchRelatedGame-1.md +0 -0
  90. /package/docs/{interfaces → api/interfaces}/AchRelatedGame.md +0 -0
  91. /package/docs/{interfaces → api/interfaces}/BonusMetaMap.md +0 -0
  92. /package/docs/{interfaces → api/interfaces}/BonusTemplateMetaMap.md +0 -0
  93. /package/docs/{interfaces → api/interfaces}/GetDrawRunRequest.md +0 -0
  94. /package/docs/{interfaces → api/interfaces}/GetDrawRunResponse.md +0 -0
  95. /package/docs/{interfaces → api/interfaces}/GetJackpotEligibleGamesRequest.md +0 -0
  96. /package/docs/{interfaces → api/interfaces}/GetJackpotEligibleGamesResponse.md +0 -0
  97. /package/docs/{interfaces → api/interfaces}/GetJackpotWinnersRequest.md +0 -0
  98. /package/docs/{interfaces → api/interfaces}/GetJackpotWinnersResponse.md +0 -0
  99. /package/docs/{interfaces → api/interfaces}/GetJackpotsPotsRequest.md +0 -0
  100. /package/docs/{interfaces → api/interfaces}/GetJackpotsPotsResponse.md +0 -0
  101. /package/docs/{interfaces → api/interfaces}/GetJackpotsRequest.md +0 -0
  102. /package/docs/{interfaces → api/interfaces}/GetJackpotsResponse.md +0 -0
  103. /package/docs/{interfaces → api/interfaces}/GetRaffleDrawRunsHistoryRequest.md +0 -0
  104. /package/docs/{interfaces → api/interfaces}/GetRaffleDrawRunsHistoryResponse.md +0 -0
  105. /package/docs/{interfaces → api/interfaces}/GetRafflesRequest.md +0 -0
  106. /package/docs/{interfaces → api/interfaces}/GetRafflesResponse.md +0 -0
  107. /package/docs/{interfaces → api/interfaces}/InboxMarkMessageAction.md +0 -0
  108. /package/docs/{interfaces → api/interfaces}/JackPotWinner.md +0 -0
  109. /package/docs/{interfaces → api/interfaces}/JackpotDetails.md +0 -0
  110. /package/docs/{interfaces → api/interfaces}/JackpotEligibleGame.md +0 -0
  111. /package/docs/{interfaces → api/interfaces}/JackpotHtmlTemplate.md +0 -0
  112. /package/docs/{interfaces → api/interfaces}/JackpotPot.md +0 -0
  113. /package/docs/{interfaces → api/interfaces}/JackpotPublicMeta.md +0 -0
  114. /package/docs/{interfaces → api/interfaces}/JackpotWinPush.md +0 -0
  115. /package/docs/{interfaces → api/interfaces}/JackpotWinnerHistory.md +0 -0
  116. /package/docs/{interfaces → api/interfaces}/JackpotsOptinRequest.md +0 -0
  117. /package/docs/{interfaces → api/interfaces}/JackpotsOptinResponse.md +0 -0
  118. /package/docs/{interfaces → api/interfaces}/JackpotsOptoutRequest.md +0 -0
  119. /package/docs/{interfaces → api/interfaces}/JackpotsOptoutResponse.md +0 -0
  120. /package/docs/{interfaces → api/interfaces}/LeaderBoardDetailsT.md +0 -0
  121. /package/docs/{interfaces → api/interfaces}/LeaderBoardUserT.md +0 -0
  122. /package/docs/{interfaces → api/interfaces}/LeaderBoardsRewardsT.md +0 -0
  123. /package/docs/{interfaces → api/interfaces}/Raffle.md +0 -0
  124. /package/docs/{interfaces → api/interfaces}/RaffleClaimPrizeRequest.md +0 -0
  125. /package/docs/{interfaces → api/interfaces}/RaffleClaimPrizeResponse.md +0 -0
  126. /package/docs/{interfaces → api/interfaces}/RaffleDraw.md +0 -0
  127. /package/docs/{interfaces → api/interfaces}/RaffleDrawPublicMeta.md +0 -0
  128. /package/docs/{interfaces → api/interfaces}/RaffleDrawRun.md +0 -0
  129. /package/docs/{interfaces → api/interfaces}/RaffleOptinRequest.md +0 -0
  130. /package/docs/{interfaces → api/interfaces}/RaffleOptinResponse.md +0 -0
  131. /package/docs/{interfaces → api/interfaces}/RafflePrize.md +0 -0
  132. /package/docs/{interfaces → api/interfaces}/RafflePrizePublicMeta.md +0 -0
  133. /package/docs/{interfaces → api/interfaces}/RafflePrizeWinner.md +0 -0
  134. /package/docs/{interfaces → api/interfaces}/RafflePublicMeta.md +0 -0
  135. /package/docs/{interfaces → api/interfaces}/RaffleTicket.md +0 -0
  136. /package/docs/{interfaces → api/interfaces}/SAWAcknowledgeSpinPushRequest.md +0 -0
  137. /package/docs/{interfaces → api/interfaces}/SAWDoAknowledgeRequest.md +0 -0
  138. /package/docs/{interfaces → api/interfaces}/SAWDoAknowledgeResponse.md +0 -0
  139. /package/docs/{interfaces → api/interfaces}/SAWDoSpinRequest.md +0 -0
  140. /package/docs/{interfaces → api/interfaces}/SAWDoSpinResponse.md +0 -0
  141. /package/docs/{interfaces → api/interfaces}/SAWEventSawPush.md +0 -0
  142. /package/docs/{interfaces → api/interfaces}/SAWGetTemplatesRequest.md +0 -0
  143. /package/docs/{interfaces → api/interfaces}/SAWGetTemplatesResponse.md +0 -0
  144. /package/docs/{interfaces → api/interfaces}/SAWPrize.md +0 -0
  145. /package/docs/{interfaces → api/interfaces}/SAWPrizeDropAknowledgeRequest.md +0 -0
  146. /package/docs/{interfaces → api/interfaces}/SAWPrizeDropAknowledgeResponse.md +0 -0
  147. /package/docs/{interfaces → api/interfaces}/SAWPrizeDropWinPush.md +0 -0
  148. /package/docs/{interfaces → api/interfaces}/SAWPrizeUI.md +0 -0
  149. /package/docs/{interfaces → api/interfaces}/SAWSpinsCountPush.md +0 -0
  150. /package/docs/{interfaces → api/interfaces}/SAWTemplate.md +0 -0
  151. /package/docs/{interfaces → api/interfaces}/SAWTemplateUI.md +0 -0
  152. /package/docs/{interfaces → api/interfaces}/SAWWinningHistoryRequest.md +0 -0
  153. /package/docs/{interfaces → api/interfaces}/SAWWinningHistoryResponse.md +0 -0
  154. /package/docs/{interfaces → api/interfaces}/TAchCategory.md +0 -0
  155. /package/docs/{interfaces → api/interfaces}/TActivityLog.md +0 -0
  156. /package/docs/{interfaces → api/interfaces}/TBonus.md +0 -0
  157. /package/docs/{interfaces → api/interfaces}/TBuyStoreItemResult.md +0 -0
  158. /package/docs/{interfaces → api/interfaces}/TClaimBonusResult.md +0 -0
  159. /package/docs/{interfaces → api/interfaces}/TGetJackpotEligibleGamesResponse.md +0 -0
  160. /package/docs/{interfaces → api/interfaces}/TGetTranslations.md +0 -0
  161. /package/docs/{interfaces → api/interfaces}/TInboxMessage.md +0 -0
  162. /package/docs/{interfaces → api/interfaces}/TInboxMessageBody.md +0 -0
  163. /package/docs/{interfaces → api/interfaces}/TLevel.md +0 -0
  164. /package/docs/{interfaces → api/interfaces}/TLevelCurrent.md +0 -0
  165. /package/docs/{interfaces → api/interfaces}/TMiniGamePlayBatchResult.md +0 -0
  166. /package/docs/{interfaces → api/interfaces}/TMiniGamePlayResult.md +0 -0
  167. /package/docs/{interfaces → api/interfaces}/TMiniGamePrize.md +0 -0
  168. /package/docs/{interfaces → api/interfaces}/TMiniGameTemplate.md +0 -0
  169. /package/docs/{interfaces → api/interfaces}/TMissionClaimRewardResult.md +0 -0
  170. /package/docs/{interfaces → api/interfaces}/TMissionOptInResult.md +0 -0
  171. /package/docs/{interfaces → api/interfaces}/TMissionOrBadge.md +0 -0
  172. /package/docs/{interfaces → api/interfaces}/TMissionOrBadgeTask.md +0 -0
  173. /package/docs/{interfaces → api/interfaces}/TRaffle.md +0 -0
  174. /package/docs/{interfaces → api/interfaces}/TRaffleDraw.md +0 -0
  175. /package/docs/{interfaces → api/interfaces}/TRaffleDrawRun.md +0 -0
  176. /package/docs/{interfaces → api/interfaces}/TRaffleOptinResponse.md +0 -0
  177. /package/docs/{interfaces → api/interfaces}/TRafflePrize.md +0 -0
  178. /package/docs/{interfaces → api/interfaces}/TRafflePrizeWinner.md +0 -0
  179. /package/docs/{interfaces → api/interfaces}/TRaffleTicket.md +0 -0
  180. /package/docs/{interfaces → api/interfaces}/TSawHistory.md +0 -0
  181. /package/docs/{interfaces → api/interfaces}/TSegmentCheckResult.md +0 -0
  182. /package/docs/{interfaces → api/interfaces}/TStoreCategory.md +0 -0
  183. /package/docs/{interfaces → api/interfaces}/TStoreItem.md +0 -0
  184. /package/docs/{interfaces → api/interfaces}/TTournament.md +0 -0
  185. /package/docs/{interfaces → api/interfaces}/TTournamentDetailed.md +0 -0
  186. /package/docs/{interfaces → api/interfaces}/TUserProfile.md +0 -0
  187. /package/docs/{interfaces → api/interfaces}/TransformedRaffleClaimPrizeResponse.md +0 -0
  188. /package/docs/{interfaces → api/interfaces}/UserLevelExtraCountersT.md +0 -0
@@ -1,107 +0,0 @@
1
- # Interface: Bonus
2
-
3
- Bonus object returned by getBonuses API.
4
-
5
- ## Properties
6
-
7
- ### id
8
-
9
- • **id**: `number`
10
-
11
- Bonus ID
12
-
13
- ___
14
-
15
- ### redeemable
16
-
17
- • **redeemable**: `boolean`
18
-
19
- Whether the bonus can be redeemed
20
-
21
- ___
22
-
23
- ### createDate
24
-
25
- • **createDate**: `string`
26
-
27
- Creation date (ISO string)
28
-
29
- ___
30
-
31
- ### updateDate
32
-
33
- • **updateDate**: `string`
34
-
35
- Last update date (ISO string)
36
-
37
- ___
38
-
39
- ### redeemDate
40
-
41
- • **redeemDate**: `string`
42
-
43
- Redeem date (ISO string)
44
-
45
- ___
46
-
47
- ### engagementUid
48
-
49
- • **engagementUid**: `string`
50
-
51
- Engagement UID
52
-
53
- ___
54
-
55
- ### labelBonusTemplateId
56
-
57
- • **labelBonusTemplateId**: `number`
58
-
59
- Label bonus template ID
60
-
61
- ___
62
-
63
- ### sourceProductRefId
64
-
65
- • **sourceProductRefId**: `number`
66
-
67
- Source product reference ID
68
-
69
- ___
70
-
71
- ### sourceProductId
72
-
73
- • **sourceProductId**: `number`
74
-
75
- Source product ID
76
-
77
- ___
78
-
79
- ### userId
80
-
81
- • **userId**: `number`
82
-
83
- User ID
84
-
85
- ___
86
-
87
- ### bonusStatusId
88
-
89
- • **bonusStatusId**: `number`
90
-
91
- Bonus status ID
92
-
93
- ___
94
-
95
- ### labelBonusTemplateMetaMap
96
-
97
- • **labelBonusTemplateMetaMap**: [`BonusTemplateMetaMap`](BonusTemplateMetaMap.md)
98
-
99
- Label bonus template metadata
100
-
101
- ___
102
-
103
- ### bonusMetaMap
104
-
105
- • **bonusMetaMap**: [`BonusMetaMap`](BonusMetaMap.md)
106
-
107
- Bonus metadata
@@ -1,37 +0,0 @@
1
- # Interface: GetTournamentInfoResponse
2
-
3
- Response for getTournamentInstanceInfo (raw, non-transformed).
4
-
5
- ## Properties
6
-
7
- ### tournamentInfo
8
-
9
- • **tournamentInfo**: `object`
10
-
11
- Tournament information object
12
-
13
- | Property | Type | Description |
14
- |----------|------|-------------|
15
- | `labelId` | `number` | ID of label (not in use) |
16
- | `tournamentLobbyInfo` | [`Tournament`](Tournament.md) | Tournament details |
17
- | `players` | [`TournamentPlayer[]`](TournamentPlayer.md) | List of registered users |
18
-
19
- ___
20
-
21
- ### userPosition
22
-
23
- • **userPosition**: [`TournamentPlayer`](TournamentPlayer.md)
24
-
25
- Information about current user's position in the tournament
26
-
27
- ___
28
-
29
- ### prizeStructure
30
-
31
- • **prizeStructure**: `object`
32
-
33
- Prize structure (optional)
34
-
35
- | Property | Type | Description |
36
- |----------|------|-------------|
37
- | `prizes` | [`TournamentPrize[]`](TournamentPrize.md) | Array of prizes |
@@ -1,51 +0,0 @@
1
- # Interface: InboxMessage
2
-
3
- Inbox message object (raw, non-transformed).
4
-
5
- ## Properties
6
-
7
- ### createDate
8
-
9
- • **createDate**: `string`
10
-
11
- Message creation date (ISO string)
12
-
13
- ___
14
-
15
- ### body
16
-
17
- • **body**: `InboxMessageBody`
18
-
19
- Message body containing title, content, action, etc.
20
-
21
- ___
22
-
23
- ### engagement\_uid
24
-
25
- • **engagement\_uid**: `string`
26
-
27
- Unique message identifier (GUID)
28
-
29
- ___
30
-
31
- ### is\_read
32
-
33
- • **is\_read**: `boolean`
34
-
35
- Whether the message has been read
36
-
37
- ___
38
-
39
- ### is\_starred
40
-
41
- • **is\_starred**: `boolean`
42
-
43
- Whether the message is marked as favorite
44
-
45
- ___
46
-
47
- ### is\_deleted
48
-
49
- • **is\_deleted**: `boolean`
50
-
51
- Whether the message is deleted (optional)
@@ -1,64 +0,0 @@
1
- # Interface: InboxMessageBody
2
-
3
- Inbox message body content (raw, non-transformed).
4
-
5
- ## Properties
6
-
7
- ### action
8
-
9
- • **action**: `string`
10
-
11
- Action to perform when message is clicked (deeplink format)
12
-
13
- ___
14
-
15
- ### body
16
-
17
- • **body**: `string`
18
-
19
- Plain text message body
20
-
21
- ___
22
-
23
- ### type
24
-
25
- • **type**: `InboxMessageType`
26
-
27
- Message type (SystemMessage=1, LevelUp=2, Achievement=3, Badge=4, Offer=5, PointsEarned=6, PointsUsed=7, PersonalMessage=8)
28
-
29
- ___
30
-
31
- ### image
32
-
33
- • **image**: `string`
34
-
35
- Message image URL
36
-
37
- ___
38
-
39
- ### title
40
-
41
- • **title**: `string`
42
-
43
- Message title
44
-
45
- ___
46
-
47
- ### html\_body
48
-
49
- • **html\_body**: `string`
50
-
51
- Rich HTML body content
52
-
53
- ___
54
-
55
- ### additional\_buttons
56
-
57
- • **additional\_buttons**: `object[]`
58
-
59
- Additional CTA buttons array (optional)
60
-
61
- | Property | Type | Description |
62
- |----------|------|-------------|
63
- | `inbox_cta_text` | `string` | Button text |
64
- | `action` | `string` | Button action (deeplink) |
@@ -1,51 +0,0 @@
1
- # Interface: LevelPublicMeta
2
-
3
- Public metadata for a Level, used for UI display.
4
-
5
- ## Properties
6
-
7
- ### name
8
-
9
- • **name**: `string`
10
-
11
- Level name
12
-
13
- ___
14
-
15
- ### description
16
-
17
- • **description**: `string`
18
-
19
- Level description (HTML capable)
20
-
21
- ___
22
-
23
- ### image\_url
24
-
25
- • **image\_url**: `string`
26
-
27
- URL to level image
28
-
29
- ___
30
-
31
- ### visibility\_points
32
-
33
- • **visibility\_points**: `number`
34
-
35
- Points needed to see this level
36
-
37
- ___
38
-
39
- ### position
40
-
41
- • **position**: `object`
42
-
43
- X & Y coordinates on visual mission map. Contains `mx`, `my`, `dx`, `dy` properties.
44
-
45
- ___
46
-
47
- ### custom\_data
48
-
49
- • **custom\_data**: `string`
50
-
51
- Custom data as JSON string
@@ -1,19 +0,0 @@
1
- # Interface: StoreCategory
2
-
3
- Store category object (raw, non-transformed).
4
-
5
- ## Properties
6
-
7
- ### id
8
-
9
- • **id**: `number`
10
-
11
- Category ID
12
-
13
- ___
14
-
15
- ### publicMeta
16
-
17
- • **publicMeta**: `StoreCategoryPublicMeta`
18
-
19
- Public metadata containing name and order
@@ -1,19 +0,0 @@
1
- # Interface: StoreCategoryPublicMeta
2
-
3
- Store category public metadata.
4
-
5
- ## Properties
6
-
7
- ### name
8
-
9
- • **name**: `string`
10
-
11
- Category name (translated)
12
-
13
- ___
14
-
15
- ### order
16
-
17
- • **order**: `number`
18
-
19
- Sort order for UI display
@@ -1,59 +0,0 @@
1
- # Interface: StoreItem
2
-
3
- Store item object (raw, non-transformed).
4
-
5
- ## Properties
6
-
7
- ### id
8
-
9
- • **id**: `number`
10
-
11
- Item ID
12
-
13
- ___
14
-
15
- ### itemTypeId
16
-
17
- • **itemTypeId**: `number`
18
-
19
- Item type ID
20
-
21
- ___
22
-
23
- ### itemPublicMeta
24
-
25
- • **itemPublicMeta**: `StoreItemPublicMeta`
26
-
27
- Public metadata for UI display (name, description, price, image, etc.)
28
-
29
- ___
30
-
31
- ### categoryIds
32
-
33
- • **categoryIds**: `number[]`
34
-
35
- Array of category IDs this item belongs to
36
-
37
- ___
38
-
39
- ### canBuy
40
-
41
- • **canBuy**: `boolean`
42
-
43
- Whether the user can currently buy this item
44
-
45
- ___
46
-
47
- ### shopPool
48
-
49
- • **shopPool**: `number`
50
-
51
- Available stock in the shop pool
52
-
53
- ___
54
-
55
- ### activeTillDate
56
-
57
- • **activeTillDate**: `number`
58
-
59
- Timestamp when the item expires (optional)
@@ -1,187 +0,0 @@
1
- # Interface: Tournament
2
-
3
- Tournament object (raw, non-transformed).
4
-
5
- ## Properties
6
-
7
- ### tournamentId
8
-
9
- • **tournamentId**: `number`
10
-
11
- ID of tournament template
12
-
13
- ___
14
-
15
- ### tournamentInstanceId
16
-
17
- • **tournamentInstanceId**: `number`
18
-
19
- ID of tournament instance. Generated every time when tournament based on specific template is scheduled for run
20
-
21
- ___
22
-
23
- ### tournamentType
24
-
25
- • **tournamentType**: `number`
26
-
27
- Type of the tournament
28
-
29
- ___
30
-
31
- ### publicMeta
32
-
33
- • **publicMeta**: `TournamentPublicMeta`
34
-
35
- Meta information about tournament that should be used to build UI
36
-
37
- ___
38
-
39
- ### buyInAmount
40
-
41
- • **buyInAmount**: `number`
42
-
43
- Cost of registration in the tournament in gamification points
44
-
45
- ___
46
-
47
- ### startTime
48
-
49
- • **startTime**: `string`
50
-
51
- The time when tournament is going to start (ISO string)
52
-
53
- ___
54
-
55
- ### endTime
56
-
57
- • **endTime**: `string`
58
-
59
- The time when tournament is going to finish (ISO string)
60
-
61
- ___
62
-
63
- ### startTimeTs
64
-
65
- • **startTimeTs**: `number`
66
-
67
- The time when tournament is going to start (Unix timestamp)
68
-
69
- ___
70
-
71
- ### endTimeTs
72
-
73
- • **endTimeTs**: `number`
74
-
75
- The time when tournament is going to finish (Unix timestamp)
76
-
77
- ___
78
-
79
- ### registrationCount
80
-
81
- • **registrationCount**: `number`
82
-
83
- Number of users registered in the tournament
84
-
85
- ___
86
-
87
- ### registrationType
88
-
89
- • **registrationType**: `number`
90
-
91
- Type of registration in the tournament
92
-
93
- ___
94
-
95
- ### tournamentRegistrationStatus
96
-
97
- • **tournamentRegistrationStatus**: `number`
98
-
99
- Status of registration in the tournament for current user
100
-
101
- ___
102
-
103
- ### tournamentInstanceStatus
104
-
105
- • **tournamentInstanceStatus**: `number`
106
-
107
- Status of tournament instance
108
-
109
- ___
110
-
111
- ### isUserRegistered
112
-
113
- • **isUserRegistered**: `boolean`
114
-
115
- Flag indicating if current user is registered in the tournament
116
-
117
- ___
118
-
119
- ### allowLateRegistration
120
-
121
- • **allowLateRegistration**: `boolean`
122
-
123
- Indicator if tournament allows later registration when tournament is already started
124
-
125
- ___
126
-
127
- ### playersMinCount
128
-
129
- • **playersMinCount**: `number`
130
-
131
- Minimum number of participants for this tournament
132
-
133
- ___
134
-
135
- ### playersMaxCount
136
-
137
- • **playersMaxCount**: `number`
138
-
139
- Maximum number of participants for this tournament
140
-
141
- ___
142
-
143
- ### durationMs
144
-
145
- • **durationMs**: `number`
146
-
147
- Tournament duration in milliseconds
148
-
149
- ___
150
-
151
- ### prizeStructure
152
-
153
- • **prizeStructure**: `object`
154
-
155
- Prizes structure with array of TournamentPrize objects
156
-
157
- ___
158
-
159
- ### tournamentPlayer
160
-
161
- • **tournamentPlayer**: `TournamentPlayer`
162
-
163
- Information about current user in tournament
164
-
165
- ___
166
-
167
- ### related\_games
168
-
169
- • **related\_games**: `AchRelatedGame[]`
170
-
171
- List of casino games related to the tournament
172
-
173
- ___
174
-
175
- ### minScoreToWin
176
-
177
- • **minScoreToWin**: `number`
178
-
179
- Minimum score points required to qualify for a prize
180
-
181
- ___
182
-
183
- ### hideLeaderboardsMinScores
184
-
185
- • **hideLeaderboardsMinScores**: `boolean`
186
-
187
- When enabled, users who don't meet minimum qualifying score are hidden from Leaderboard
@@ -1,123 +0,0 @@
1
- # Interface: UICustomSection
2
-
3
- Custom UI section configuration.
4
-
5
- ## Properties
6
-
7
- ### body
8
-
9
- • **body**: `string`
10
-
11
- HTML body content for the section
12
-
13
- ___
14
-
15
- ### menu\_img
16
-
17
- • **menu\_img**: `string`
18
-
19
- Menu icon image URL
20
-
21
- ___
22
-
23
- ### menu\_name
24
-
25
- • **menu\_name**: `string`
26
-
27
- Menu display name (translated)
28
-
29
- ___
30
-
31
- ### custom\_skin\_images
32
-
33
- • **custom\_skin\_images**: `string`
34
-
35
- Custom skin images configuration
36
-
37
- ___
38
-
39
- ### section\_type\_id
40
-
41
- • **section\_type\_id**: [`AchCustomSectionType`](AchCustomSectionType.md)
42
-
43
- Section type identifier
44
-
45
- ___
46
-
47
- ### theme
48
-
49
- • **theme**: `string`
50
-
51
- Theme identifier (e.g., "valentines-light", "euro-2024", "generic")
52
-
53
- ___
54
-
55
- ### generic\_custom\_css
56
-
57
- • **generic\_custom\_css**: `string`
58
-
59
- Custom CSS for the section
60
-
61
- ___
62
-
63
- ### mission\_tabs\_options
64
-
65
- • **mission\_tabs\_options**: `number`
66
-
67
- Mission tabs display option (1=ONLY_OVERVIEW, 2=NO_OVERVIEW, 3=ALL)
68
-
69
- ___
70
-
71
- ### overview\_missions\_filter
72
-
73
- • **overview\_missions\_filter**: `number`
74
-
75
- Filter for overview missions display
76
-
77
- ___
78
-
79
- ### overview\_missions\_count
80
-
81
- • **overview\_missions\_count**: `number`
82
-
83
- Number of missions to show in overview
84
-
85
- ___
86
-
87
- ### liquid\_entity\_data
88
-
89
- • **liquid\_entity\_data**: `number[]`
90
-
91
- Entity data types for liquid templates
92
-
93
- ___
94
-
95
- ### ach\_tournament\_id
96
-
97
- • **ach\_tournament\_id**: `number`
98
-
99
- Associated tournament ID
100
-
101
- ___
102
-
103
- ### show\_raw\_data
104
-
105
- • **show\_raw\_data**: `boolean`
106
-
107
- Whether to show raw data
108
-
109
- ___
110
-
111
- ### liquid\_template
112
-
113
- • **liquid\_template**: `number`
114
-
115
- Liquid template ID
116
-
117
- ___
118
-
119
- ### ach\_category\_ids
120
-
121
- • **ach\_category\_ids**: `number[]`
122
-
123
- Associated achievement category IDs