@smartico/public-api 0.0.364 → 0.0.366

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 (317) hide show
  1. package/dist/Base/ClassId.d.ts +8 -0
  2. package/dist/Clans/Clan.d.ts +17 -0
  3. package/dist/Clans/GetClanInfoRequest.d.ts +5 -0
  4. package/dist/Clans/GetClanInfoResponse.d.ts +22 -0
  5. package/dist/Clans/GetClanListRequest.d.ts +4 -0
  6. package/dist/Clans/GetClanListResponse.d.ts +9 -0
  7. package/dist/Clans/JoinClanRequest.d.ts +5 -0
  8. package/dist/Clans/JoinClanResponse.d.ts +5 -0
  9. package/dist/Clans/index.d.ts +7 -0
  10. package/dist/SmarticoAPI.d.ts +8 -1
  11. package/dist/SmarticoLib/index.d.ts +196 -0
  12. package/dist/Tournaments/GetClanTournamentPlayersRequest.d.ts +6 -0
  13. package/dist/Tournaments/GetClanTournamentPlayersResponse.d.ts +40 -0
  14. package/dist/Tournaments/GetTournamentInfoResponse.d.ts +11 -0
  15. package/dist/Tournaments/Tournament.d.ts +2 -0
  16. package/dist/Tournaments/TournamentClan.d.ts +27 -0
  17. package/dist/Tournaments/index.d.ts +3 -0
  18. package/dist/WSAPI/WSAPI.d.ts +34 -1
  19. package/dist/WSAPI/WSAPITypes.d.ts +144 -0
  20. package/dist/index.d.ts +1 -0
  21. package/dist/index.js +561 -290
  22. package/dist/index.js.map +1 -1
  23. package/dist/index.modern.mjs +193 -2
  24. package/dist/index.modern.mjs.map +1 -1
  25. package/docs/api/README.md +99 -330
  26. package/docs/api/classes/SAWUtils.md +25 -11
  27. package/docs/api/classes/WSAPI.md +737 -379
  28. package/docs/api/enumerations/AchCustomLayoutTheme.md +25 -0
  29. package/docs/api/enumerations/AchCustomSectionType.md +79 -0
  30. package/docs/api/{enums → enumerations}/AchMissionsTabsOptions.md +5 -5
  31. package/docs/api/{enums → enumerations}/AchOverviewMissionsFilter.md +9 -9
  32. package/docs/api/{enums → enumerations}/AchievementAvailabilityStatus.md +29 -29
  33. package/docs/api/enumerations/AchievementStatus.md +49 -0
  34. package/docs/api/{enums → enumerations}/AchievementTaskType.md +3 -3
  35. package/docs/api/{enums → enumerations}/AchievementType.md +3 -3
  36. package/docs/api/enumerations/ActivityTypeLimited.md +115 -0
  37. package/docs/api/{enums → enumerations}/AttemptPeriodType.md +7 -7
  38. package/docs/api/{enums → enumerations}/BadgesTimeLimitStates.md +11 -11
  39. package/docs/api/{enums → enumerations}/BonusStatus-1.md +11 -11
  40. package/docs/api/enumerations/BonusStatus.md +37 -0
  41. package/docs/api/{enums → enumerations}/BuyStoreItemErrorCode.md +21 -21
  42. package/docs/api/{enums → enumerations}/GPRoundStatus.md +9 -9
  43. package/docs/api/{enums → enumerations}/GamePickMarketType.md +3 -3
  44. package/docs/api/{enums → enumerations}/GamePickResolutionType.md +7 -7
  45. package/docs/api/{enums → enumerations}/GamePickScoreType.md +3 -3
  46. package/docs/api/enumerations/GamePickSportType.md +375 -0
  47. package/docs/api/{enums → enumerations}/GameRoundOrderType.md +7 -7
  48. package/docs/api/{enums → enumerations}/InboxCategories.md +5 -5
  49. package/docs/api/enumerations/InboxMessageType.md +55 -0
  50. package/docs/api/{enums → enumerations}/InboxReadStatus.md +3 -3
  51. package/docs/api/{enums → enumerations}/JackPotTemparature.md +7 -7
  52. package/docs/api/{enums → enumerations}/JackpotContributionType.md +3 -3
  53. package/docs/api/{enums → enumerations}/JackpotType.md +3 -3
  54. package/docs/api/{enums → enumerations}/LeaderBoardPeriodType.md +5 -5
  55. package/docs/api/enumerations/LiquidEntityData.md +73 -0
  56. package/docs/api/enumerations/MiniGamePrizeTypeName.md +67 -0
  57. package/docs/api/{enums → enumerations}/OpenLinksType.md +3 -3
  58. package/docs/api/enumerations/PointChangeSourceType.md +109 -0
  59. package/docs/api/enumerations/PrizeModifiers.md +49 -0
  60. package/docs/api/enumerations/QuizAnswersValueType.md +121 -0
  61. package/docs/api/{enums → enumerations}/RaffleDrawInstanceState.md +5 -5
  62. package/docs/api/{enums → enumerations}/RaffleDrawTypeExecution.md +5 -5
  63. package/docs/api/{enums → enumerations}/RaffleTicketCapVisualization.md +5 -5
  64. package/docs/api/{enums → enumerations}/SAWAcknowledgeType.md +7 -7
  65. package/docs/api/enumerations/SAWAcknowledgeTypeName.md +25 -0
  66. package/docs/api/{enums → enumerations}/SAWAskForUsername.md +3 -3
  67. package/docs/api/enumerations/SAWBuyInType.md +31 -0
  68. package/docs/api/enumerations/SAWBuyInTypeName.md +37 -0
  69. package/docs/api/{enums → enumerations}/SAWExposeUserSpinId.md +3 -3
  70. package/docs/api/{enums → enumerations}/SAWExposeUserSpinIdName.md +3 -3
  71. package/docs/api/enumerations/SAWGPMarketType.md +157 -0
  72. package/docs/api/{enums → enumerations}/SAWGameDifficultyType.md +5 -5
  73. package/docs/api/{enums → enumerations}/SAWGameDifficultyTypeName.md +5 -5
  74. package/docs/api/{enums → enumerations}/SAWGameLayout.md +3 -3
  75. package/docs/api/{enums → enumerations}/SAWGameLayoutName.md +3 -3
  76. package/docs/api/enumerations/SAWGameType.md +73 -0
  77. package/docs/api/enumerations/SAWGameTypeName.md +79 -0
  78. package/docs/api/enumerations/SAWPrizeType.md +61 -0
  79. package/docs/api/{enums → enumerations}/SAWSpinErrorCode.md +19 -19
  80. package/docs/api/{enums → enumerations}/SAWWheelLayout.md +7 -7
  81. package/docs/api/enumerations/SAWWinSoundType.md +31 -0
  82. package/docs/api/{enums → enumerations}/ScheduledMissionType.md +5 -5
  83. package/docs/api/{enums → enumerations}/StoreItemPurchaseType.md +5 -5
  84. package/docs/api/enumerations/StoreItemType.md +37 -0
  85. package/docs/api/enumerations/StoreItemTypeName.md +43 -0
  86. package/docs/api/enumerations/TournamentInstanceStatus.md +43 -0
  87. package/docs/api/enumerations/TournamentRegistrationError.md +55 -0
  88. package/docs/api/enumerations/TournamentRegistrationStatus.md +43 -0
  89. package/docs/api/enumerations/TournamentRegistrationStatusName.md +49 -0
  90. package/docs/api/enumerations/TournamentRegistrationType.md +43 -0
  91. package/docs/api/{enums → enumerations}/TournamentType.md +5 -5
  92. package/docs/api/{enums → enumerations}/UserBalanceType.md +5 -5
  93. package/docs/api/functions/AchCategoryTransform.md +13 -0
  94. package/docs/api/functions/BonusItemsTransform.md +13 -0
  95. package/docs/api/functions/InboxMessageBodyTransform.md +13 -0
  96. package/docs/api/functions/SAWHistoryTransform.md +13 -0
  97. package/docs/api/functions/SAWTemplatesTransform.md +13 -0
  98. package/docs/api/functions/StoreCategoryTransform.md +13 -0
  99. package/docs/api/functions/StoreItemTransform.md +13 -0
  100. package/docs/api/functions/StoreItemTypeNamed.md +13 -0
  101. package/docs/api/functions/TournamentInstanceStatusName.md +13 -0
  102. package/docs/api/functions/TournamentItemsTransform.md +13 -0
  103. package/docs/api/functions/UICustomSectionTransform.md +13 -0
  104. package/docs/api/functions/UserAchievementTransform.md +13 -0
  105. package/docs/api/functions/enrichUserAchievementsWithBadgeState.md +13 -0
  106. package/docs/api/functions/tournamentInfoItemTransform.md +13 -0
  107. package/docs/api/interfaces/AchCategory.md +5 -5
  108. package/docs/api/interfaces/AchCategoryPublicMeta.md +5 -5
  109. package/docs/api/interfaces/AchRelatedGame-1.md +50 -15
  110. package/docs/api/interfaces/AchRelatedGame.md +35 -16
  111. package/docs/api/interfaces/AchievementPublicMeta.md +65 -65
  112. package/docs/api/interfaces/AchievementTaskPublicMeta.md +16 -16
  113. package/docs/api/interfaces/AffectsProgress.md +7 -7
  114. package/docs/api/interfaces/Bonus.md +37 -37
  115. package/docs/api/interfaces/BonusMetaMap-1.md +2 -2
  116. package/docs/api/interfaces/BonusMetaMap.md +2 -2
  117. package/docs/api/interfaces/BonusTemplateMetaMap-1.md +8 -8
  118. package/docs/api/interfaces/BonusTemplateMetaMap.md +8 -8
  119. package/docs/api/interfaces/Clan.md +53 -0
  120. package/docs/api/interfaces/ClanLeaderboardEntry.md +31 -0
  121. package/docs/api/interfaces/ClanPrizeStructureEntry.md +45 -0
  122. package/docs/api/interfaces/ClanPrizeTier.md +43 -0
  123. package/docs/api/interfaces/ClanPublicMeta.md +19 -0
  124. package/docs/api/interfaces/GamePickBoardUser.md +17 -17
  125. package/docs/api/interfaces/GamePickEvent.md +40 -38
  126. package/docs/api/interfaces/GamePickEventMeta.md +79 -59
  127. package/docs/api/interfaces/GamePickGameInfo.md +5 -5
  128. package/docs/api/interfaces/GamePickRequestParams.md +10 -12
  129. package/docs/api/interfaces/GamePickRound.md +96 -98
  130. package/docs/api/interfaces/GamePickRoundBase.md +58 -61
  131. package/docs/api/interfaces/GamePickRoundBoard.md +88 -90
  132. package/docs/api/interfaces/GamePickRoundPublicMeta.md +26 -26
  133. package/docs/api/interfaces/GamePickRoundRequestParams.md +15 -17
  134. package/docs/api/interfaces/GamePickUserInfo.md +34 -34
  135. package/docs/api/interfaces/GamesApiResponse.md +11 -11
  136. package/docs/api/interfaces/GetCustomSectionsResponse.md +23 -25
  137. package/docs/api/interfaces/GetDrawRunRequest.md +21 -23
  138. package/docs/api/interfaces/GetDrawRunResponse.md +21 -23
  139. package/docs/api/interfaces/GetJackpotEligibleGamesRequest.md +13 -15
  140. package/docs/api/interfaces/GetJackpotEligibleGamesResponse.md +21 -23
  141. package/docs/api/interfaces/GetJackpotWinnersRequest.md +26 -28
  142. package/docs/api/interfaces/GetJackpotWinnersResponse.md +23 -25
  143. package/docs/api/interfaces/GetJackpotsPotsRequest.md +13 -15
  144. package/docs/api/interfaces/GetJackpotsPotsResponse.md +21 -23
  145. package/docs/api/interfaces/GetJackpotsRequest.md +17 -19
  146. package/docs/api/interfaces/GetJackpotsResponse.md +21 -23
  147. package/docs/api/interfaces/GetRaffleDrawRunsHistoryRequest.md +16 -18
  148. package/docs/api/interfaces/GetRaffleDrawRunsHistoryResponse.md +21 -23
  149. package/docs/api/interfaces/GetRafflesRequest.md +14 -16
  150. package/docs/api/interfaces/GetRafflesResponse.md +21 -23
  151. package/docs/api/interfaces/GetRelatedAchTourResponse.md +24 -26
  152. package/docs/api/interfaces/GetTournamentInfoResponse.md +68 -38
  153. package/docs/api/interfaces/InboxMarkMessageAction.md +3 -3
  154. package/docs/api/interfaces/InboxMessage.md +18 -18
  155. package/docs/api/interfaces/InboxMessageBody.md +37 -29
  156. package/docs/api/interfaces/JackPotWinner.md +11 -11
  157. package/docs/api/interfaces/JackpotDetails.md +23 -23
  158. package/docs/api/interfaces/JackpotEligibleGame.md +19 -19
  159. package/docs/api/interfaces/JackpotHtmlTemplate.md +3 -3
  160. package/docs/api/interfaces/JackpotPot.md +11 -11
  161. package/docs/api/interfaces/JackpotPublicMeta.md +15 -15
  162. package/docs/api/interfaces/JackpotWinPush.md +15 -17
  163. package/docs/api/interfaces/JackpotWinnerHistory.md +5 -5
  164. package/docs/api/interfaces/JackpotsOptinRequest.md +13 -15
  165. package/docs/api/interfaces/JackpotsOptinResponse.md +19 -21
  166. package/docs/api/interfaces/JackpotsOptoutRequest.md +13 -15
  167. package/docs/api/interfaces/JackpotsOptoutResponse.md +19 -21
  168. package/docs/api/interfaces/LeaderBoardDetailsT.md +16 -16
  169. package/docs/api/interfaces/LeaderBoardUserT.md +9 -9
  170. package/docs/api/interfaces/LeaderBoardsRewardsT.md +3 -3
  171. package/docs/api/interfaces/Level.md +15 -15
  172. package/docs/api/interfaces/LevelPublicMeta.md +31 -24
  173. package/docs/api/interfaces/QuizEventMeta.md +34 -14
  174. package/docs/api/interfaces/Raffle.md +13 -13
  175. package/docs/api/interfaces/RaffleClaimPrizeRequest.md +13 -15
  176. package/docs/api/interfaces/RaffleClaimPrizeResponse.md +18 -20
  177. package/docs/api/interfaces/RaffleDraw.md +44 -44
  178. package/docs/api/interfaces/RaffleDrawPublicMeta.md +15 -15
  179. package/docs/api/interfaces/RaffleDrawRun.md +15 -15
  180. package/docs/api/interfaces/RaffleOptinRequest.md +17 -19
  181. package/docs/api/interfaces/RaffleOptinResponse.md +19 -21
  182. package/docs/api/interfaces/RafflePrize.md +31 -31
  183. package/docs/api/interfaces/RafflePrizePublicMeta.md +7 -7
  184. package/docs/api/interfaces/RafflePrizeWinner.md +15 -15
  185. package/docs/api/interfaces/RafflePublicMeta.md +16 -16
  186. package/docs/api/interfaces/RaffleTicket.md +3 -3
  187. package/docs/api/interfaces/SAWAcknowledgeSpinPushRequest.md +24 -26
  188. package/docs/api/interfaces/SAWDoAknowledgeRequest.md +13 -15
  189. package/docs/api/interfaces/SAWDoAknowledgeResponse.md +13 -15
  190. package/docs/api/interfaces/SAWDoSpinRequest.md +24 -26
  191. package/docs/api/interfaces/SAWDoSpinResponse.md +33 -35
  192. package/docs/api/interfaces/SAWEventSawPush.md +17 -19
  193. package/docs/api/interfaces/SAWGetTemplatesRequest.md +26 -28
  194. package/docs/api/interfaces/SAWGetTemplatesResponse.md +21 -23
  195. package/docs/api/interfaces/SAWPrize.md +52 -52
  196. package/docs/api/interfaces/SAWPrizeDropAknowledgeRequest.md +17 -19
  197. package/docs/api/interfaces/SAWPrizeDropAknowledgeResponse.md +13 -15
  198. package/docs/api/interfaces/SAWPrizeDropWinPush.md +21 -23
  199. package/docs/api/interfaces/SAWPrizeUI.md +78 -78
  200. package/docs/api/interfaces/SAWPrizesHistory.md +15 -15
  201. package/docs/api/interfaces/SAWSpinsCountPush.md +15 -17
  202. package/docs/api/interfaces/SAWTemplate.md +70 -63
  203. package/docs/api/interfaces/SAWTemplateUI.md +155 -150
  204. package/docs/api/interfaces/SAWWinningHistoryRequest.md +21 -23
  205. package/docs/api/interfaces/SAWWinningHistoryResponse.md +23 -25
  206. package/docs/api/interfaces/StoreCategory.md +5 -5
  207. package/docs/api/interfaces/StoreCategoryPublicMeta.md +5 -5
  208. package/docs/api/interfaces/StoreItem.md +19 -19
  209. package/docs/api/interfaces/StoreItemPublicMeta.md +51 -51
  210. package/docs/api/interfaces/TAchCategory.md +5 -5
  211. package/docs/api/interfaces/TActivityLog.md +16 -16
  212. package/docs/api/interfaces/TAvatarCustomized.md +27 -0
  213. package/docs/api/interfaces/TAvatarDefinition.md +101 -0
  214. package/docs/api/interfaces/TAvatarPrompt.md +44 -0
  215. package/docs/api/interfaces/TBonus.md +22 -22
  216. package/docs/api/interfaces/TBuyStoreItemResult.md +3 -3
  217. package/docs/api/interfaces/TClaimBonusResult.md +6 -6
  218. package/docs/api/interfaces/TClan.md +79 -0
  219. package/docs/api/interfaces/TClanInfo.md +111 -0
  220. package/docs/api/interfaces/TClanJoinResult.md +15 -0
  221. package/docs/api/interfaces/TClanTournamentPlayers.md +71 -0
  222. package/docs/api/interfaces/TClans.md +27 -0
  223. package/docs/api/interfaces/TGetJackpotEligibleGamesResponse.md +1 -1
  224. package/docs/api/interfaces/TGetTranslations.md +3 -3
  225. package/docs/api/interfaces/TInboxMessage.md +13 -13
  226. package/docs/api/interfaces/TInboxMessageBody.md +28 -16
  227. package/docs/api/interfaces/TLevel.md +21 -23
  228. package/docs/api/interfaces/TLevelCurrent.md +32 -34
  229. package/docs/api/interfaces/TMiniGamePlayBatchResult.md +12 -12
  230. package/docs/api/interfaces/TMiniGamePlayResult.md +5 -5
  231. package/docs/api/interfaces/TMiniGamePrize.md +83 -83
  232. package/docs/api/interfaces/TMiniGameTemplate.md +81 -81
  233. package/docs/api/interfaces/TMissionClaimRewardResult.md +3 -3
  234. package/docs/api/interfaces/TMissionOptInResult.md +3 -3
  235. package/docs/api/interfaces/TMissionOrBadge.md +110 -110
  236. package/docs/api/interfaces/TMissionOrBadgeTask.md +15 -15
  237. package/docs/api/interfaces/TRaffle.md +25 -25
  238. package/docs/api/interfaces/TRaffleDraw.md +61 -61
  239. package/docs/api/interfaces/TRaffleDrawRun.md +39 -39
  240. package/docs/api/interfaces/TRaffleOptinResponse.md +4 -4
  241. package/docs/api/interfaces/TRafflePrize.md +35 -35
  242. package/docs/api/interfaces/TRafflePrizeWinner.md +13 -13
  243. package/docs/api/interfaces/TRaffleTicket.md +3 -3
  244. package/docs/api/interfaces/TSawHistory.md +15 -15
  245. package/docs/api/interfaces/TSegmentCheckResult.md +3 -3
  246. package/docs/api/interfaces/TSetAvatarResult.md +19 -0
  247. package/docs/api/interfaces/TStoreCategory.md +5 -5
  248. package/docs/api/interfaces/TStoreItem.md +77 -77
  249. package/docs/api/interfaces/TTournament.md +165 -97
  250. package/docs/api/interfaces/TTournamentDetailed.md +378 -140
  251. package/docs/api/interfaces/TTournamentRegistrationResult.md +3 -3
  252. package/docs/api/interfaces/TUICustomSection.md +52 -52
  253. package/docs/api/interfaces/TUserProfile.md +32 -32
  254. package/docs/api/interfaces/Tournament.md +87 -81
  255. package/docs/api/interfaces/TournamentPlayer.md +18 -18
  256. package/docs/api/interfaces/TournamentPrize.md +17 -17
  257. package/docs/api/interfaces/TournamentPublicMeta.md +47 -47
  258. package/docs/api/interfaces/TransformedRaffleClaimPrizeResponse.md +4 -4
  259. package/docs/api/interfaces/UICustomSection.md +50 -50
  260. package/docs/api/interfaces/UserAchievement.md +101 -101
  261. package/docs/api/interfaces/UserAchievementTask.md +38 -38
  262. package/docs/api/interfaces/UserLevelExtraCountersT.md +5 -5
  263. package/docs/api/type-aliases/TournamentRegistrationTypeName.md +3 -0
  264. package/docs/api/variables/AllRoundsGameBoardID.md +5 -0
  265. package/docs/api/variables/PrizeModifiersKeysNames.md +37 -0
  266. package/docs/api/variables/SAWWinSoundFiles.md +21 -0
  267. package/package.json +1 -1
  268. package/src/Base/ClassId.ts +12 -0
  269. package/src/Clans/Clan.ts +18 -0
  270. package/src/Clans/GetClanInfoRequest.ts +6 -0
  271. package/src/Clans/GetClanInfoResponse.ts +24 -0
  272. package/src/Clans/GetClanListRequest.ts +5 -0
  273. package/src/Clans/GetClanListResponse.ts +10 -0
  274. package/src/Clans/JoinClanRequest.ts +6 -0
  275. package/src/Clans/JoinClanResponse.ts +6 -0
  276. package/src/Clans/index.ts +7 -0
  277. package/src/Raffle/GetRafflesResponse.ts +1 -1
  278. package/src/SmarticoAPI.ts +95 -0
  279. package/src/SmarticoLib/index.ts +163 -0
  280. package/src/Tournaments/GetClanTournamentPlayersRequest.ts +7 -0
  281. package/src/Tournaments/GetClanTournamentPlayersResponse.ts +58 -0
  282. package/src/Tournaments/GetTournamentInfoResponse.ts +52 -0
  283. package/src/Tournaments/Tournament.ts +2 -0
  284. package/src/Tournaments/TournamentClan.ts +30 -0
  285. package/src/Tournaments/index.ts +3 -0
  286. package/src/WSAPI/WSAPI.ts +61 -2
  287. package/src/WSAPI/WSAPITypes.ts +131 -0
  288. package/src/index.ts +2 -1
  289. package/tsconfig.json +5 -3
  290. package/docs/api/.nojekyll +0 -1
  291. package/docs/api/enums/AchCustomLayoutTheme.md +0 -25
  292. package/docs/api/enums/AchCustomSectionType.md +0 -79
  293. package/docs/api/enums/AchievementStatus.md +0 -49
  294. package/docs/api/enums/ActivityTypeLimited.md +0 -115
  295. package/docs/api/enums/BonusStatus.md +0 -37
  296. package/docs/api/enums/GamePickSportType.md +0 -375
  297. package/docs/api/enums/InboxMessageType.md +0 -55
  298. package/docs/api/enums/LiquidEntityData.md +0 -73
  299. package/docs/api/enums/MiniGamePrizeTypeName.md +0 -67
  300. package/docs/api/enums/PointChangeSourceType.md +0 -109
  301. package/docs/api/enums/PrizeModifiers.md +0 -49
  302. package/docs/api/enums/QuizAnswersValueType.md +0 -121
  303. package/docs/api/enums/SAWAcknowledgeTypeName.md +0 -25
  304. package/docs/api/enums/SAWBuyInType.md +0 -31
  305. package/docs/api/enums/SAWBuyInTypeName.md +0 -37
  306. package/docs/api/enums/SAWGPMarketType.md +0 -157
  307. package/docs/api/enums/SAWGameType.md +0 -73
  308. package/docs/api/enums/SAWGameTypeName.md +0 -79
  309. package/docs/api/enums/SAWPrizeType.md +0 -61
  310. package/docs/api/enums/SAWWinSoundType.md +0 -31
  311. package/docs/api/enums/StoreItemType.md +0 -37
  312. package/docs/api/enums/StoreItemTypeName.md +0 -43
  313. package/docs/api/enums/TournamentInstanceStatus.md +0 -43
  314. package/docs/api/enums/TournamentRegistrationError.md +0 -55
  315. package/docs/api/enums/TournamentRegistrationStatus.md +0 -43
  316. package/docs/api/enums/TournamentRegistrationStatusName.md +0 -49
  317. package/docs/api/enums/TournamentRegistrationType.md +0 -43
package/docs/api/interfaces/GamePickRequestParams.md CHANGED
@@ -2,40 +2,38 @@
2
2
 
3
3
  GamePickRequestParams describes the base parameters required for GamePick API calls
4
4
 
5
- ## Hierarchy
5
+ ## Extended by
6
6
 
7
- - **`GamePickRequestParams`**
8
-
9
- ↳ [`GamePickRoundRequestParams`](GamePickRoundRequestParams.md)
7
+ - [`GamePickRoundRequestParams`](GamePickRoundRequestParams.md)
10
8
 
11
9
  ## Properties
12
10
 
13
11
  ### saw\_template\_id
14
12
 
15
- • **saw\_template\_id**: `number`
13
+ > **saw\_template\_id**: `number`
16
14
 
17
15
  ID of the MatchX or Quiz game template
18
16
 
19
- ___
17
+ ***
20
18
 
21
19
  ### ext\_user\_id
22
20
 
23
- • **ext\_user\_id**: `string`
21
+ > **ext\_user\_id**: `string`
24
22
 
25
23
  External user ID
26
24
 
27
- ___
25
+ ***
28
26
 
29
27
  ### smartico\_ext\_user\_id
30
28
 
31
- • **smartico\_ext\_user\_id**: `string`
29
+ > **smartico\_ext\_user\_id**: `string`
32
30
 
33
31
  Smartico external user ID used for platform API calls
34
32
 
35
- ___
33
+ ***
36
34
 
37
- ### lang
35
+ ### lang?
38
36
 
39
- • `Optional` **lang**: `string`
37
+ > `optional` **lang?**: `string`
40
38
 
41
39
  Language code for translations (e.g. 'EN', 'DE')
package/docs/api/interfaces/GamePickRound.md CHANGED
@@ -2,384 +2,382 @@
2
2
 
3
3
  GamePickRound describes a round with its events and the current user's prediction data
4
4
 
5
- ## Hierarchy
5
+ ## Extends
6
6
 
7
7
  - [`GamePickRoundBase`](GamePickRoundBase.md)
8
8
 
9
- ↳ **`GamePickRound`**
10
-
11
9
  ## Properties
12
10
 
13
11
  ### round\_id
14
12
 
15
- • **round\_id**: `number`
13
+ > **round\_id**: `number`
16
14
 
17
15
  Unique round identifier
18
16
 
19
17
  #### Inherited from
20
18
 
21
- [GamePickRoundBase](GamePickRoundBase.md).[round_id](GamePickRoundBase.md#round_id)
19
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`round_id`](GamePickRoundBase.md#round_id)
22
20
 
23
- ___
21
+ ***
24
22
 
25
23
  ### round\_row\_id
26
24
 
27
- • **round\_row\_id**: `number`
25
+ > **round\_row\_id**: `number`
28
26
 
29
27
  Sequential row ID used for ordering rounds
30
28
 
31
29
  #### Inherited from
32
30
 
33
- [GamePickRoundBase](GamePickRoundBase.md).[round_row_id](GamePickRoundBase.md#round_row_id)
31
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`round_row_id`](GamePickRoundBase.md#round_row_id)
34
32
 
35
- ___
33
+ ***
36
34
 
37
35
  ### round\_name
38
36
 
39
- • **round\_name**: `string`
37
+ > **round\_name**: `string`
40
38
 
41
39
  Localized display name of the round
42
40
 
43
41
  #### Inherited from
44
42
 
45
- [GamePickRoundBase](GamePickRoundBase.md).[round_name](GamePickRoundBase.md#round_name)
43
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`round_name`](GamePickRoundBase.md#round_name)
46
44
 
47
- ___
45
+ ***
48
46
 
49
47
  ### round\_description
50
48
 
51
- • **round\_description**: `string`
49
+ > **round\_description**: `string`
52
50
 
53
51
  Localized description of the round
54
52
 
55
53
  #### Inherited from
56
54
 
57
- [GamePickRoundBase](GamePickRoundBase.md).[round_description](GamePickRoundBase.md#round_description)
55
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`round_description`](GamePickRoundBase.md#round_description)
58
56
 
59
- ___
57
+ ***
60
58
 
61
59
  ### final\_screen\_cta\_button\_title
62
60
 
63
- • **final\_screen\_cta\_button\_title**: `string`
61
+ > **final\_screen\_cta\_button\_title**: `string`
64
62
 
65
63
  Label for the CTA button on the final/results screen
66
64
 
67
65
  #### Inherited from
68
66
 
69
- [GamePickRoundBase](GamePickRoundBase.md).[final_screen_cta_button_title](GamePickRoundBase.md#final_screen_cta_button_title)
67
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`final_screen_cta_button_title`](GamePickRoundBase.md#final_screen_cta_button_title)
70
68
 
71
- ___
69
+ ***
72
70
 
73
71
  ### final\_screen\_message
74
72
 
75
- • **final\_screen\_message**: `string`
73
+ > **final\_screen\_message**: `string`
76
74
 
77
75
  Message displayed on the final/results screen
78
76
 
79
77
  #### Inherited from
80
78
 
81
- [GamePickRoundBase](GamePickRoundBase.md).[final_screen_message](GamePickRoundBase.md#final_screen_message)
79
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`final_screen_message`](GamePickRoundBase.md#final_screen_message)
82
80
 
83
- ___
81
+ ***
84
82
 
85
83
  ### final\_screen\_image\_desktop
86
84
 
87
- • **final\_screen\_image\_desktop**: `string`
85
+ > **final\_screen\_image\_desktop**: `string`
88
86
 
89
87
  URL of the final screen image (desktop)
90
88
 
91
89
  #### Inherited from
92
90
 
93
- [GamePickRoundBase](GamePickRoundBase.md).[final_screen_image_desktop](GamePickRoundBase.md#final_screen_image_desktop)
91
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`final_screen_image_desktop`](GamePickRoundBase.md#final_screen_image_desktop)
94
92
 
95
- ___
93
+ ***
96
94
 
97
95
  ### final\_screen\_image\_mobile
98
96
 
99
- • **final\_screen\_image\_mobile**: `string`
97
+ > **final\_screen\_image\_mobile**: `string`
100
98
 
101
99
  URL of the final screen image (mobile)
102
100
 
103
101
  #### Inherited from
104
102
 
105
- [GamePickRoundBase](GamePickRoundBase.md).[final_screen_image_mobile](GamePickRoundBase.md#final_screen_image_mobile)
103
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`final_screen_image_mobile`](GamePickRoundBase.md#final_screen_image_mobile)
106
104
 
107
- ___
105
+ ***
108
106
 
109
107
  ### promo\_image
110
108
 
111
- • **promo\_image**: `string`
109
+ > **promo\_image**: `string`
112
110
 
113
111
  URL of the promotional image for the round
114
112
 
115
113
  #### Inherited from
116
114
 
117
- [GamePickRoundBase](GamePickRoundBase.md).[promo_image](GamePickRoundBase.md#promo_image)
115
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`promo_image`](GamePickRoundBase.md#promo_image)
118
116
 
119
- ___
117
+ ***
120
118
 
121
119
  ### promo\_text
122
120
 
123
- • **promo\_text**: `string`
121
+ > **promo\_text**: `string`
124
122
 
125
123
  Promotional text displayed with the round
126
124
 
127
125
  #### Inherited from
128
126
 
129
- [GamePickRoundBase](GamePickRoundBase.md).[promo_text](GamePickRoundBase.md#promo_text)
127
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`promo_text`](GamePickRoundBase.md#promo_text)
130
128
 
131
- ___
129
+ ***
132
130
 
133
131
  ### open\_date
134
132
 
135
- • **open\_date**: `number`
133
+ > **open\_date**: `number`
136
134
 
137
135
  Timestamp (ms) when the round opens for participation
138
136
 
139
137
  #### Inherited from
140
138
 
141
- [GamePickRoundBase](GamePickRoundBase.md).[open_date](GamePickRoundBase.md#open_date)
139
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`open_date`](GamePickRoundBase.md#open_date)
142
140
 
143
- ___
141
+ ***
144
142
 
145
143
  ### last\_bet\_date
146
144
 
147
- • **last\_bet\_date**: `number`
145
+ > **last\_bet\_date**: `number`
148
146
 
149
147
  Timestamp (ms) of the last moment bets are accepted
150
148
 
151
149
  #### Inherited from
152
150
 
153
- [GamePickRoundBase](GamePickRoundBase.md).[last_bet_date](GamePickRoundBase.md#last_bet_date)
151
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`last_bet_date`](GamePickRoundBase.md#last_bet_date)
154
152
 
155
- ___
153
+ ***
156
154
 
157
155
  ### resolution\_date
158
156
 
159
- • **resolution\_date**: `number`
157
+ > **resolution\_date**: `number`
160
158
 
161
159
  Timestamp (ms) when the round is expected to be resolved
162
160
 
163
161
  #### Inherited from
164
162
 
165
- [GamePickRoundBase](GamePickRoundBase.md).[resolution_date](GamePickRoundBase.md#resolution_date)
163
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`resolution_date`](GamePickRoundBase.md#resolution_date)
166
164
 
167
- ___
165
+ ***
168
166
 
169
167
  ### score\_full\_win
170
168
 
171
- • **score\_full\_win**: `number`
169
+ > **score\_full\_win**: `number`
172
170
 
173
171
  Points awarded for a fully correct prediction
174
172
 
175
173
  #### Inherited from
176
174
 
177
- [GamePickRoundBase](GamePickRoundBase.md).[score_full_win](GamePickRoundBase.md#score_full_win)
175
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`score_full_win`](GamePickRoundBase.md#score_full_win)
178
176
 
179
- ___
177
+ ***
180
178
 
181
179
  ### score\_part\_win
182
180
 
183
- • **score\_part\_win**: `number`
181
+ > **score\_part\_win**: `number`
184
182
 
185
183
  Points awarded for a partially correct prediction
186
184
 
187
185
  #### Inherited from
188
186
 
189
- [GamePickRoundBase](GamePickRoundBase.md).[score_part_win](GamePickRoundBase.md#score_part_win)
187
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`score_part_win`](GamePickRoundBase.md#score_part_win)
190
188
 
191
- ___
189
+ ***
192
190
 
193
191
  ### score\_lost
194
192
 
195
- • **score\_lost**: `number`
193
+ > **score\_lost**: `number`
196
194
 
197
195
  Points awarded (or deducted) for an incorrect prediction
198
196
 
199
197
  #### Inherited from
200
198
 
201
- [GamePickRoundBase](GamePickRoundBase.md).[score_lost](GamePickRoundBase.md#score_lost)
199
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`score_lost`](GamePickRoundBase.md#score_lost)
202
200
 
203
- ___
201
+ ***
204
202
 
205
203
  ### is\_active\_now
206
204
 
207
- • **is\_active\_now**: `boolean`
205
+ > **is\_active\_now**: `boolean`
208
206
 
209
207
  Whether the round is currently active for participation
210
208
 
211
209
  #### Inherited from
212
210
 
213
- [GamePickRoundBase](GamePickRoundBase.md).[is_active_now](GamePickRoundBase.md#is_active_now)
211
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`is_active_now`](GamePickRoundBase.md#is_active_now)
214
212
 
215
- ___
213
+ ***
216
214
 
217
215
  ### is\_resolved
218
216
 
219
- • **is\_resolved**: `boolean`
217
+ > **is\_resolved**: `boolean`
220
218
 
221
219
  Whether the round has been fully resolved and scored
222
220
 
223
221
  #### Inherited from
224
222
 
225
- [GamePickRoundBase](GamePickRoundBase.md).[is_resolved](GamePickRoundBase.md#is_resolved)
223
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`is_resolved`](GamePickRoundBase.md#is_resolved)
226
224
 
227
- ___
225
+ ***
228
226
 
229
227
  ### round\_status\_id
230
228
 
231
- • **round\_status\_id**: [`GPRoundStatus`](../enums/GPRoundStatus.md)
229
+ > **round\_status\_id**: [`GPRoundStatus`](../enumerations/GPRoundStatus.md)
232
230
 
233
231
  Current lifecycle status of the round
234
232
 
235
233
  #### Inherited from
236
234
 
237
- [GamePickRoundBase](GamePickRoundBase.md).[round_status_id](GamePickRoundBase.md#round_status_id)
235
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`round_status_id`](GamePickRoundBase.md#round_status_id)
238
236
 
239
- ___
237
+ ***
240
238
 
241
239
  ### events\_total
242
240
 
243
- • **events\_total**: `number`
241
+ > **events\_total**: `number`
244
242
 
245
243
  Total number of events in the round
246
244
 
247
245
  #### Inherited from
248
246
 
249
- [GamePickRoundBase](GamePickRoundBase.md).[events_total](GamePickRoundBase.md#events_total)
247
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`events_total`](GamePickRoundBase.md#events_total)
250
248
 
251
- ___
249
+ ***
252
250
 
253
251
  ### events\_resolved
254
252
 
255
- • **events\_resolved**: `number`
253
+ > **events\_resolved**: `number`
256
254
 
257
255
  Number of events that have been resolved
258
256
 
259
257
  #### Inherited from
260
258
 
261
- [GamePickRoundBase](GamePickRoundBase.md).[events_resolved](GamePickRoundBase.md#events_resolved)
259
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`events_resolved`](GamePickRoundBase.md#events_resolved)
262
260
 
263
- ___
261
+ ***
264
262
 
265
263
  ### score\_type\_id
266
264
 
267
- • **score\_type\_id**: [`GamePickScoreType`](../enums/GamePickScoreType.md)
265
+ > **score\_type\_id**: [`GamePickScoreType`](../enumerations/GamePickScoreType.md)
268
266
 
269
267
  Scoring method used for this round
270
268
 
271
269
  #### Inherited from
272
270
 
273
- [GamePickRoundBase](GamePickRoundBase.md).[score_type_id](GamePickRoundBase.md#score_type_id)
271
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`score_type_id`](GamePickRoundBase.md#score_type_id)
274
272
 
275
- ___
273
+ ***
276
274
 
277
275
  ### order\_events
278
276
 
279
- • **order\_events**: [`GameRoundOrderType`](../enums/GameRoundOrderType.md)
277
+ > **order\_events**: [`GameRoundOrderType`](../enumerations/GameRoundOrderType.md)
280
278
 
281
279
  How events are ordered for display
282
280
 
283
281
  #### Inherited from
284
282
 
285
- [GamePickRoundBase](GamePickRoundBase.md).[order_events](GamePickRoundBase.md#order_events)
283
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`order_events`](GamePickRoundBase.md#order_events)
286
284
 
287
- ___
285
+ ***
288
286
 
289
287
  ### board\_users\_count
290
288
 
291
- • **board\_users\_count**: `number`
289
+ > **board\_users\_count**: `number`
292
290
 
293
291
  Maximum number of users shown on the leaderboard
294
292
 
295
293
  #### Inherited from
296
294
 
297
- [GamePickRoundBase](GamePickRoundBase.md).[board_users_count](GamePickRoundBase.md#board_users_count)
295
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`board_users_count`](GamePickRoundBase.md#board_users_count)
298
296
 
299
- ___
297
+ ***
300
298
 
301
299
  ### hide\_users\_predictions
302
300
 
303
- • **hide\_users\_predictions**: `boolean`
301
+ > **hide\_users\_predictions**: `boolean`
304
302
 
305
303
  Whether other users' predictions are hidden until resolution
306
304
 
307
305
  #### Inherited from
308
306
 
309
- [GamePickRoundBase](GamePickRoundBase.md).[hide_users_predictions](GamePickRoundBase.md#hide_users_predictions)
307
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`hide_users_predictions`](GamePickRoundBase.md#hide_users_predictions)
310
308
 
311
- ___
309
+ ***
312
310
 
313
311
  ### public\_meta
314
312
 
315
- • **public\_meta**: [`GamePickRoundPublicMeta`](GamePickRoundPublicMeta.md)
313
+ > **public\_meta**: [`GamePickRoundPublicMeta`](GamePickRoundPublicMeta.md)
316
314
 
317
315
  Public metadata including translations and display settings from the BackOffice
318
316
 
319
317
  #### Inherited from
320
318
 
321
- [GamePickRoundBase](GamePickRoundBase.md).[public_meta](GamePickRoundBase.md#public_meta)
319
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`public_meta`](GamePickRoundBase.md#public_meta)
322
320
 
323
- ___
321
+ ***
324
322
 
325
323
  ### next\_round\_open\_date
326
324
 
327
- • **next\_round\_open\_date**: `number`
325
+ > **next\_round\_open\_date**: `number`
328
326
 
329
327
  Timestamp (ms) when the next round opens, if available
330
328
 
331
329
  #### Inherited from
332
330
 
333
- [GamePickRoundBase](GamePickRoundBase.md).[next_round_open_date](GamePickRoundBase.md#next_round_open_date)
331
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`next_round_open_date`](GamePickRoundBase.md#next_round_open_date)
334
332
 
335
- ___
333
+ ***
336
334
 
337
335
  ### show\_users\_preference
338
336
 
339
- • **show\_users\_preference**: `boolean`
337
+ > **show\_users\_preference**: `boolean`
340
338
 
341
339
  Whether to show aggregated user preference percentages for each outcome
342
340
 
343
341
  #### Inherited from
344
342
 
345
- [GamePickRoundBase](GamePickRoundBase.md).[show_users_preference](GamePickRoundBase.md#show_users_preference)
343
+ [`GamePickRoundBase`](GamePickRoundBase.md).[`show_users_preference`](GamePickRoundBase.md#show_users_preference)
346
344
 
347
- ___
345
+ ***
348
346
 
349
347
  ### events
350
348
 
351
- • **events**: [`GamePickEvent`](GamePickEvent.md)[]
349
+ > **events**: [`GamePickEvent`](GamePickEvent.md)[]
352
350
 
353
351
  List of events (matches/questions) in this round
354
352
 
355
- ___
353
+ ***
356
354
 
357
355
  ### user\_score
358
356
 
359
- • **user\_score**: `number`
357
+ > **user\_score**: `number`
360
358
 
361
359
  Current user's total score in this round
362
360
 
363
- ___
361
+ ***
364
362
 
365
363
  ### user\_placed\_bet
366
364
 
367
- • **user\_placed\_bet**: `boolean`
365
+ > **user\_placed\_bet**: `boolean`
368
366
 
369
367
  Whether the current user has submitted any predictions in this round
370
368
 
371
- ___
369
+ ***
372
370
 
373
- ### has\_open\_for\_bet\_events
371
+ ### has\_open\_for\_bet\_events?
374
372
 
375
- • `Optional` **has\_open\_for\_bet\_events**: `boolean`
373
+ > `optional` **has\_open\_for\_bet\_events?**: `boolean`
376
374
 
377
375
  Whether there are events still open for betting
378
376
 
379
- ___
377
+ ***
380
378
 
381
- ### has\_not\_submitted\_changes
379
+ ### has\_not\_submitted\_changes?
382
380
 
383
- • `Optional` **has\_not\_submitted\_changes**: `boolean`
381
+ > `optional` **has\_not\_submitted\_changes?**: `boolean`
384
382
 
385
383
  Whether the user has unsaved changes to their predictions