@smartico/public-api 0.0.364 → 0.0.365

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 (316) 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 +560 -289
  22. package/dist/index.js.map +1 -1
  23. package/dist/index.modern.mjs +192 -1
  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/SmarticoAPI.ts +95 -0
  278. package/src/SmarticoLib/index.ts +163 -0
  279. package/src/Tournaments/GetClanTournamentPlayersRequest.ts +7 -0
  280. package/src/Tournaments/GetClanTournamentPlayersResponse.ts +58 -0
  281. package/src/Tournaments/GetTournamentInfoResponse.ts +52 -0
  282. package/src/Tournaments/Tournament.ts +2 -0
  283. package/src/Tournaments/TournamentClan.ts +30 -0
  284. package/src/Tournaments/index.ts +3 -0
  285. package/src/WSAPI/WSAPI.ts +61 -2
  286. package/src/WSAPI/WSAPITypes.ts +131 -0
  287. package/src/index.ts +2 -1
  288. package/tsconfig.json +5 -3
  289. package/docs/api/.nojekyll +0 -1
  290. package/docs/api/enums/AchCustomLayoutTheme.md +0 -25
  291. package/docs/api/enums/AchCustomSectionType.md +0 -79
  292. package/docs/api/enums/AchievementStatus.md +0 -49
  293. package/docs/api/enums/ActivityTypeLimited.md +0 -115
  294. package/docs/api/enums/BonusStatus.md +0 -37
  295. package/docs/api/enums/GamePickSportType.md +0 -375
  296. package/docs/api/enums/InboxMessageType.md +0 -55
  297. package/docs/api/enums/LiquidEntityData.md +0 -73
  298. package/docs/api/enums/MiniGamePrizeTypeName.md +0 -67
  299. package/docs/api/enums/PointChangeSourceType.md +0 -109
  300. package/docs/api/enums/PrizeModifiers.md +0 -49
  301. package/docs/api/enums/QuizAnswersValueType.md +0 -121
  302. package/docs/api/enums/SAWAcknowledgeTypeName.md +0 -25
  303. package/docs/api/enums/SAWBuyInType.md +0 -31
  304. package/docs/api/enums/SAWBuyInTypeName.md +0 -37
  305. package/docs/api/enums/SAWGPMarketType.md +0 -157
  306. package/docs/api/enums/SAWGameType.md +0 -73
  307. package/docs/api/enums/SAWGameTypeName.md +0 -79
  308. package/docs/api/enums/SAWPrizeType.md +0 -61
  309. package/docs/api/enums/SAWWinSoundType.md +0 -31
  310. package/docs/api/enums/StoreItemType.md +0 -37
  311. package/docs/api/enums/StoreItemTypeName.md +0 -43
  312. package/docs/api/enums/TournamentInstanceStatus.md +0 -43
  313. package/docs/api/enums/TournamentRegistrationError.md +0 -55
  314. package/docs/api/enums/TournamentRegistrationStatus.md +0 -43
  315. package/docs/api/enums/TournamentRegistrationStatusName.md +0 -49
  316. package/docs/api/enums/TournamentRegistrationType.md +0 -43
@@ -4,38 +4,38 @@
4
4
 
5
5
  ### public\_username
6
6
 
7
- • **public\_username**: `string`
7
+ > **public\_username**: `string`
8
8
 
9
9
  The username of the participant
10
10
 
11
- ___
11
+ ***
12
12
 
13
13
  ### avatar\_url
14
14
 
15
- • **avatar\_url**: `string`
15
+ > **avatar\_url**: `string`
16
16
 
17
17
  The URL to the avatar of the participant
18
18
 
19
- ___
19
+ ***
20
20
 
21
21
  ### position
22
22
 
23
- • **position**: `number`
23
+ > **position**: `number`
24
24
 
25
25
  The position of the participant in the leaderboard
26
26
 
27
- ___
27
+ ***
28
28
 
29
29
  ### points
30
30
 
31
- • **points**: `number`
31
+ > **points**: `number`
32
32
 
33
33
  The points of the participant in the leaderboard
34
34
 
35
- ___
35
+ ***
36
36
 
37
37
  ### is\_me
38
38
 
39
- • **is\_me**: `boolean`
39
+ > **is\_me**: `boolean`
40
40
 
41
41
  The indicator if the participant is current user
@@ -4,10 +4,10 @@
4
4
 
5
5
  ### place
6
6
 
7
- • **place**: `number`
7
+ > **place**: `number`
8
8
 
9
- ___
9
+ ***
10
10
 
11
11
  ### points
12
12
 
13
- • **points**: `number`
13
+ > **points**: `number`
@@ -4,48 +4,48 @@
4
4
 
5
5
  ### level\_id
6
6
 
7
- • **level\_id**: `number`
7
+ > **level\_id**: `number`
8
8
 
9
- ___
9
+ ***
10
10
 
11
11
  ### level\_public\_meta
12
12
 
13
- • **level\_public\_meta**: [`LevelPublicMeta`](LevelPublicMeta.md)
13
+ > **level\_public\_meta**: [`LevelPublicMeta`](LevelPublicMeta.md)
14
14
 
15
- ___
15
+ ***
16
16
 
17
17
  ### required\_points
18
18
 
19
- • **required\_points**: `number`
19
+ > **required\_points**: `number`
20
20
 
21
- ___
21
+ ***
22
22
 
23
23
  ### is\_first\_level
24
24
 
25
- • **is\_first\_level**: `boolean`
25
+ > **is\_first\_level**: `boolean`
26
26
 
27
- ___
27
+ ***
28
28
 
29
29
  ### level\_status\_id
30
30
 
31
- • **level\_status\_id**: `number`
31
+ > **level\_status\_id**: `number`
32
32
 
33
33
  Internal status of level. Not in use right now on the front-end
34
34
 
35
- ___
35
+ ***
36
36
 
37
37
  ### required\_level\_counter\_1
38
38
 
39
- • **required\_level\_counter\_1**: `number`
39
+ > **required\_level\_counter\_1**: `number`
40
40
 
41
- ___
41
+ ***
42
42
 
43
43
  ### required\_level\_counter\_2
44
44
 
45
- • **required\_level\_counter\_2**: `number`
45
+ > **required\_level\_counter\_2**: `number`
46
46
 
47
- ___
47
+ ***
48
48
 
49
49
  ### general\_level\_progress
50
50
 
51
- • **general\_level\_progress**: `number`
51
+ > **general\_level\_progress**: `number`
@@ -2,58 +2,65 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- ### description
5
+ ### description?
6
6
 
7
- • `Optional` **description**: `string`
7
+ > `optional` **description?**: `string`
8
8
 
9
9
  Description of level, HTML capabable
10
10
 
11
- ___
11
+ ***
12
12
 
13
- ### image\_url
13
+ ### image\_url?
14
14
 
15
- • `Optional` **image\_url**: `string`
15
+ > `optional` **image\_url?**: `string`
16
16
 
17
17
  URL to the image of level
18
18
 
19
- ___
19
+ ***
20
20
 
21
- ### name
21
+ ### name?
22
22
 
23
- • `Optional` **name**: `string`
23
+ > `optional` **name?**: `string`
24
24
 
25
25
  Name of level
26
26
 
27
- ___
27
+ ***
28
28
 
29
- ### visibility\_points
29
+ ### visibility\_points?
30
30
 
31
- • `Optional` **visibility\_points**: `number`
31
+ > `optional` **visibility\_points?**: `number`
32
32
 
33
33
  Number of points that user should have collected in order to see this level
34
34
 
35
- ___
35
+ ***
36
36
 
37
- ### position
37
+ ### position?
38
38
 
39
- • `Optional` **position**: `Object`
39
+ > `optional` **position?**: `object`
40
40
 
41
41
  X & Y coordinates of level on the visual mission map, for desktop and mobile
42
42
 
43
- #### Type declaration
43
+ #### mx
44
44
 
45
- | Name | Type |
46
- | :------ | :------ |
47
- | `mx` | `number` |
48
- | `my` | `number` |
49
- | `dx` | `number` |
50
- | `dy` | `number` |
45
+ > **mx**: `number`
51
46
 
52
- ___
47
+ #### my
53
48
 
54
- ### custom\_data
49
+ > **my**: `number`
55
50
 
56
- • `Optional` **custom\_data**: `string`
51
+ #### dx
52
+
53
+ > **dx**: `number`
54
+
55
+ #### dy
56
+
57
+ > **dy**: `number`
58
+
59
+ ***
60
+
61
+ ### custom\_data?
62
+
63
+ > `optional` **custom\_data?**: `string`
57
64
 
58
65
  Custom data as string or JSON string that can be used in API to build custom UI
59
66
  You can request from Smartico to define fields for your specific case that will be managed from Smartico BackOffice
@@ -2,40 +2,60 @@
2
2
 
3
3
  QuizEventMeta describes metadata for a quiz-type event (custom question with answer options)
4
4
 
5
- ## Hierarchy
5
+ ## Extended by
6
6
 
7
- - **`QuizEventMeta`**
8
-
9
- ↳ [`GamePickEventMeta`](GamePickEventMeta.md)
7
+ - [`GamePickEventMeta`](GamePickEventMeta.md)
10
8
 
11
9
  ## Properties
12
10
 
13
- ### answers
11
+ ### answers?
14
12
 
15
- • `Optional` **answers**: \{ `value`: `string` ; `text`: `string` ; `_translations`: \{ `[key: string]`: \{ `text`: `string` }; } }[]
13
+ > `optional` **answers?**: `object`[]
16
14
 
17
15
  List of possible answer options for the quiz question
18
16
 
19
- ___
17
+ #### value
18
+
19
+ > **value**: `string`
20
+
21
+ Answer identifier value sent on submission
22
+
23
+ #### text
24
+
25
+ > **text**: `string`
26
+
27
+ Localized display text of the answer
28
+
29
+ #### \_translations
30
+
31
+ > **\_translations**: `object`
32
+
33
+ Per-language overrides for the answer text
34
+
35
+ ##### Index Signature
36
+
37
+ \[`key`: `string`\]: `object`
38
+
39
+ ***
20
40
 
21
- ### question\_image
41
+ ### question\_image?
22
42
 
23
- • `Optional` **question\_image**: `string`
43
+ > `optional` **question\_image?**: `string`
24
44
 
25
45
  URL of an image associated with the question
26
46
 
27
- ___
47
+ ***
28
48
 
29
- ### result
49
+ ### result?
30
50
 
31
- • `Optional` **result**: [`QuizAnswersValueType`](../enums/QuizAnswersValueType.md)
51
+ > `optional` **result?**: [`QuizAnswersValueType`](../enumerations/QuizAnswersValueType.md)
32
52
 
33
53
  Correct answer value after resolution
34
54
 
35
- ___
55
+ ***
36
56
 
37
57
  ### custom\_question
38
58
 
39
- • **custom\_question**: `string`
59
+ > **custom\_question**: `string`
40
60
 
41
61
  Custom question text displayed to the user
@@ -4,55 +4,55 @@
4
4
 
5
5
  ### raffle\_id
6
6
 
7
- • **raffle\_id**: `number`
7
+ > **raffle\_id**: `number`
8
8
 
9
9
  ID of the Raffle template
10
10
 
11
- ___
11
+ ***
12
12
 
13
13
  ### public\_meta
14
14
 
15
- • **public\_meta**: [`RafflePublicMeta`](RafflePublicMeta.md)
15
+ > **public\_meta**: [`RafflePublicMeta`](RafflePublicMeta.md)
16
16
 
17
17
  Meta information about raffle for the presentation on UI
18
18
 
19
- ___
19
+ ***
20
20
 
21
21
  ### start\_date\_ts
22
22
 
23
- • **start\_date\_ts**: `number`
23
+ > **start\_date\_ts**: `number`
24
24
 
25
25
  Date of start
26
26
 
27
- ___
27
+ ***
28
28
 
29
29
  ### end\_date\_ts
30
30
 
31
- • **end\_date\_ts**: `number`
31
+ > **end\_date\_ts**: `number`
32
32
 
33
33
  Date of end
34
34
 
35
- ___
35
+ ***
36
36
 
37
37
  ### max\_tickets\_count
38
38
 
39
- • **max\_tickets\_count**: `number`
39
+ > **max\_tickets\_count**: `number`
40
40
 
41
41
  Maximum numer of tickets that can be given to all users for the whole period of raffle
42
42
 
43
- ___
43
+ ***
44
44
 
45
45
  ### current\_tickets\_count
46
46
 
47
- • **current\_tickets\_count**: `number`
47
+ > **current\_tickets\_count**: `number`
48
48
 
49
49
  Number of tickets that are already given to all users for this raffle
50
50
 
51
- ___
51
+ ***
52
52
 
53
53
  ### draws
54
54
 
55
- • **draws**: [`RaffleDraw`](RaffleDraw.md)[]
55
+ > **draws**: [`RaffleDraw`](RaffleDraw.md)[]
56
56
 
57
57
  List of draws that are available for this raffle.
58
58
  For example, if the raffle is containg one hourly draw, one daily draw and one draw on fixed date like 01/01/2022,
@@ -1,43 +1,41 @@
1
1
  # Interface: RaffleClaimPrizeRequest
2
2
 
3
- ## Hierarchy
3
+ ## Extends
4
4
 
5
5
  - `ProtocolMessage`
6
6
 
7
- ↳ **`RaffleClaimPrizeRequest`**
8
-
9
7
  ## Properties
10
8
 
11
9
  ### cid
12
10
 
13
- • **cid**: `number`
11
+ > **cid**: `number`
14
12
 
15
13
  #### Inherited from
16
14
 
17
- ProtocolMessage.cid
15
+ `ProtocolMessage.cid`
18
16
 
19
- ___
17
+ ***
20
18
 
21
- ### ts
19
+ ### ts?
22
20
 
23
- • `Optional` **ts**: `number`
21
+ > `optional` **ts?**: `number`
24
22
 
25
23
  #### Inherited from
26
24
 
27
- ProtocolMessage.ts
25
+ `ProtocolMessage.ts`
28
26
 
29
- ___
27
+ ***
30
28
 
31
- ### uuid
29
+ ### uuid?
32
30
 
33
- • `Optional` **uuid**: `string`
31
+ > `optional` **uuid?**: `string`
34
32
 
35
33
  #### Inherited from
36
34
 
37
- ProtocolMessage.uuid
35
+ `ProtocolMessage.uuid`
38
36
 
39
- ___
37
+ ***
40
38
 
41
39
  ### won\_id
42
40
 
43
- • **won\_id**: `number`
41
+ > **won\_id**: `number`
@@ -1,57 +1,55 @@
1
1
  # Interface: RaffleClaimPrizeResponse
2
2
 
3
- ## Hierarchy
3
+ ## Extends
4
4
 
5
5
  - `ProtocolResponse`
6
6
 
7
- ↳ **`RaffleClaimPrizeResponse`**
8
-
9
7
  ## Properties
10
8
 
11
9
  ### cid
12
10
 
13
- • **cid**: `number`
11
+ > **cid**: `number`
14
12
 
15
13
  #### Inherited from
16
14
 
17
- ProtocolResponse.cid
15
+ `ProtocolResponse.cid`
18
16
 
19
- ___
17
+ ***
20
18
 
21
- ### ts
19
+ ### ts?
22
20
 
23
- • `Optional` **ts**: `number`
21
+ > `optional` **ts?**: `number`
24
22
 
25
23
  #### Inherited from
26
24
 
27
- ProtocolResponse.ts
25
+ `ProtocolResponse.ts`
28
26
 
29
- ___
27
+ ***
30
28
 
31
- ### uuid
29
+ ### uuid?
32
30
 
33
- • `Optional` **uuid**: `string`
31
+ > `optional` **uuid?**: `string`
34
32
 
35
33
  #### Inherited from
36
34
 
37
- ProtocolResponse.uuid
35
+ `ProtocolResponse.uuid`
38
36
 
39
- ___
37
+ ***
40
38
 
41
39
  ### errCode
42
40
 
43
- • **errCode**: `number`
41
+ > **errCode**: `number`
44
42
 
45
43
  #### Overrides
46
44
 
47
- ProtocolResponse.errCode
45
+ `ProtocolResponse.errCode`
48
46
 
49
- ___
47
+ ***
50
48
 
51
- ### errMsg
49
+ ### errMsg?
52
50
 
53
- • `Optional` **errMsg**: `string`
51
+ > `optional` **errMsg?**: `string`
54
52
 
55
53
  #### Overrides
56
54
 
57
- ProtocolResponse.errMsg
55
+ `ProtocolResponse.errMsg`