@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,30 +4,30 @@
4
4
 
5
5
  ### name
6
6
 
7
- • **name**: `string`
7
+ > **name**: `string`
8
8
 
9
9
  Name of the prize
10
10
 
11
- ___
11
+ ***
12
12
 
13
13
  ### description
14
14
 
15
- • **description**: `string`
15
+ > **description**: `string`
16
16
 
17
17
  Description of the prize
18
18
 
19
- ___
19
+ ***
20
20
 
21
21
  ### image\_url
22
22
 
23
- • **image\_url**: `string`
23
+ > **image\_url**: `string`
24
24
 
25
25
  URL of the image that represents the prize
26
26
 
27
- ___
27
+ ***
28
28
 
29
29
  ### hide\_chance\_to\_win
30
30
 
31
- • **hide\_chance\_to\_win**: `boolean`
31
+ > **hide\_chance\_to\_win**: `boolean`
32
32
 
33
33
  Indicates whether the chance to win should be hidden in the UI.
@@ -4,40 +4,40 @@
4
4
 
5
5
  ### user\_id
6
6
 
7
- • **user\_id**: `number`
7
+ > **user\_id**: `number`
8
8
 
9
- ___
9
+ ***
10
10
 
11
- ### public\_username
11
+ ### public\_username?
12
12
 
13
- • `Optional` **public\_username**: `string`
13
+ > `optional` **public\_username?**: `string`
14
14
 
15
- ___
15
+ ***
16
16
 
17
17
  ### avatar\_id
18
18
 
19
- • **avatar\_id**: `string`
19
+ > **avatar\_id**: `string`
20
20
 
21
- ___
21
+ ***
22
22
 
23
- ### avatar\_url
23
+ ### avatar\_url?
24
24
 
25
- • `Optional` **avatar\_url**: `string`
25
+ > `optional` **avatar\_url?**: `string`
26
26
 
27
- ___
27
+ ***
28
28
 
29
29
  ### ticket
30
30
 
31
- • **ticket**: [`RaffleTicket`](RaffleTicket.md)
31
+ > **ticket**: [`RaffleTicket`](RaffleTicket.md)
32
32
 
33
- ___
33
+ ***
34
34
 
35
35
  ### raf\_won\_id
36
36
 
37
- • **raf\_won\_id**: `number`
37
+ > **raf\_won\_id**: `number`
38
38
 
39
- ___
39
+ ***
40
40
 
41
41
  ### claimed\_date
42
42
 
43
- • **claimed\_date**: `number`
43
+ > **claimed\_date**: `number`
@@ -4,65 +4,65 @@
4
4
 
5
5
  ### name
6
6
 
7
- • **name**: `string`
7
+ > **name**: `string`
8
8
 
9
9
  Name of the raffle
10
10
 
11
- ___
11
+ ***
12
12
 
13
13
  ### description
14
14
 
15
- • **description**: `string`
15
+ > **description**: `string`
16
16
 
17
17
  Description of the raffle
18
18
 
19
- ___
19
+ ***
20
20
 
21
21
  ### custom\_section\_id
22
22
 
23
- • **custom\_section\_id**: `number`
23
+ > **custom\_section\_id**: `number`
24
24
 
25
25
  ID of the custom section that is linked to the raffle in the Gamification widget
26
26
 
27
- ___
27
+ ***
28
28
 
29
29
  ### image\_url
30
30
 
31
- • **image\_url**: `string`
31
+ > **image\_url**: `string`
32
32
 
33
33
  URL of the image that represents the raffle
34
34
 
35
- ___
35
+ ***
36
36
 
37
37
  ### image\_url\_mobile
38
38
 
39
- • **image\_url\_mobile**: `string`
39
+ > **image\_url\_mobile**: `string`
40
40
 
41
41
  URL of the mobile image that represents the raffle
42
42
 
43
- ___
43
+ ***
44
44
 
45
45
  ### hint\_text
46
46
 
47
- • **hint\_text**: `string`
47
+ > **hint\_text**: `string`
48
48
 
49
49
  Text for Terms and Conditions
50
50
 
51
- ___
51
+ ***
52
52
 
53
53
  ### custom\_data
54
54
 
55
- • **custom\_data**: `string`
55
+ > **custom\_data**: `string`
56
56
 
57
57
  Custom data as string or JSON string that can be used in API to build custom UI
58
58
  You can request from Smartico to define fields for your specific case that will be managed from Smartico BackOffice
59
59
  Read more here - <https://help.smartico.ai/welcome/products/general-concepts/custom-fields-attributes>
60
60
 
61
- ___
61
+ ***
62
62
 
63
- ### ticket\_cap\_visualization
63
+ ### ticket\_cap\_visualization?
64
64
 
65
- • `Optional` **ticket\_cap\_visualization**: [`RaffleTicketCapVisualization`](../enums/RaffleTicketCapVisualization.md)
65
+ > `optional` **ticket\_cap\_visualization?**: [`RaffleTicketCapVisualization`](../enumerations/RaffleTicketCapVisualization.md)
66
66
 
67
67
  - Value 1 (Counter): Shows a real-time "Tickets Remaining" display available during the whole Raffle activity.
68
68
  - Value 2 (Message): Will show a specific message that triggers only when the cap is reached and inform users that tickets will be no longer be issued.
@@ -4,14 +4,14 @@
4
4
 
5
5
  ### id
6
6
 
7
- • **id**: `number`
7
+ > **id**: `number`
8
8
 
9
9
  Int presentation of the ticket
10
10
 
11
- ___
11
+ ***
12
12
 
13
13
  ### s
14
14
 
15
- • **s**: `string`
15
+ > **s**: `string`
16
16
 
17
17
  String presentation of the ticket
@@ -1,79 +1,77 @@
1
1
  # Interface: SAWAcknowledgeSpinPushRequest
2
2
 
3
- ## Hierarchy
3
+ ## Extends
4
4
 
5
5
  - `ProtocolRequest`
6
6
 
7
- ↳ **`SAWAcknowledgeSpinPushRequest`**
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
- ProtocolRequest.cid
15
+ `ProtocolRequest.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
- ProtocolRequest.ts
25
+ `ProtocolRequest.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
- ProtocolRequest.uuid
35
+ `ProtocolRequest.uuid`
38
36
 
39
- ___
37
+ ***
40
38
 
41
39
  ### api\_key
42
40
 
43
- • **api\_key**: `string`
41
+ > **api\_key**: `string`
44
42
 
45
43
  #### Inherited from
46
44
 
47
- ProtocolRequest.api\_key
45
+ `ProtocolRequest.api_key`
48
46
 
49
- ___
47
+ ***
50
48
 
51
49
  ### brand\_key
52
50
 
53
- • **brand\_key**: `string`
51
+ > **brand\_key**: `string`
54
52
 
55
53
  #### Inherited from
56
54
 
57
- ProtocolRequest.brand\_key
55
+ `ProtocolRequest.brand_key`
58
56
 
59
- ___
57
+ ***
60
58
 
61
59
  ### ext\_user\_id
62
60
 
63
- • **ext\_user\_id**: `string`
61
+ > **ext\_user\_id**: `string`
64
62
 
65
63
  #### Inherited from
66
64
 
67
- ProtocolRequest.ext\_user\_id
65
+ `ProtocolRequest.ext_user_id`
68
66
 
69
- ___
67
+ ***
70
68
 
71
69
  ### pending\_message\_id
72
70
 
73
- • **pending\_message\_id**: `number`
71
+ > **pending\_message\_id**: `number`
74
72
 
75
- ___
73
+ ***
76
74
 
77
75
  ### saw\_template\_id
78
76
 
79
- • **saw\_template\_id**: `number`
77
+ > **saw\_template\_id**: `number`
@@ -1,43 +1,41 @@
1
1
  # Interface: SAWDoAknowledgeRequest
2
2
 
3
- ## Hierarchy
3
+ ## Extends
4
4
 
5
5
  - `ProtocolMessage`
6
6
 
7
- ↳ **`SAWDoAknowledgeRequest`**
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
  ### request\_id
42
40
 
43
- • **request\_id**: `string`
41
+ > **request\_id**: `string`
@@ -1,43 +1,41 @@
1
1
  # Interface: SAWDoAknowledgeResponse
2
2
 
3
- ## Hierarchy
3
+ ## Extends
4
4
 
5
5
  - `ProtocolMessage`
6
6
 
7
- ↳ **`SAWDoAknowledgeResponse`**
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
  ### request\_id
42
40
 
43
- • **request\_id**: `string`
41
+ > **request\_id**: `string`
@@ -1,79 +1,77 @@
1
1
  # Interface: SAWDoSpinRequest
2
2
 
3
- ## Hierarchy
3
+ ## Extends
4
4
 
5
5
  - `ProtocolRequest`
6
6
 
7
- ↳ **`SAWDoSpinRequest`**
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
- ProtocolRequest.cid
15
+ `ProtocolRequest.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
- ProtocolRequest.ts
25
+ `ProtocolRequest.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
- ProtocolRequest.uuid
35
+ `ProtocolRequest.uuid`
38
36
 
39
- ___
37
+ ***
40
38
 
41
39
  ### api\_key
42
40
 
43
- • **api\_key**: `string`
41
+ > **api\_key**: `string`
44
42
 
45
43
  #### Inherited from
46
44
 
47
- ProtocolRequest.api\_key
45
+ `ProtocolRequest.api_key`
48
46
 
49
- ___
47
+ ***
50
48
 
51
49
  ### brand\_key
52
50
 
53
- • **brand\_key**: `string`
51
+ > **brand\_key**: `string`
54
52
 
55
53
  #### Inherited from
56
54
 
57
- ProtocolRequest.brand\_key
55
+ `ProtocolRequest.brand_key`
58
56
 
59
- ___
57
+ ***
60
58
 
61
59
  ### ext\_user\_id
62
60
 
63
- • **ext\_user\_id**: `string`
61
+ > **ext\_user\_id**: `string`
64
62
 
65
63
  #### Inherited from
66
64
 
67
- ProtocolRequest.ext\_user\_id
65
+ `ProtocolRequest.ext_user_id`
68
66
 
69
- ___
67
+ ***
70
68
 
71
69
  ### request\_id
72
70
 
73
- • **request\_id**: `string`
71
+ > **request\_id**: `string`
74
72
 
75
- ___
73
+ ***
76
74
 
77
75
  ### saw\_template\_id
78
76
 
79
- • **saw\_template\_id**: `number`
77
+ > **saw\_template\_id**: `number`
@@ -1,93 +1,91 @@
1
1
  # Interface: SAWDoSpinResponse
2
2
 
3
- ## Hierarchy
3
+ ## Extends
4
4
 
5
5
  - `ProtocolResponse`
6
6
 
7
- ↳ **`SAWDoSpinResponse`**
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**: [`SAWSpinErrorCode`](../enums/SAWSpinErrorCode.md)
41
+ > **errCode**: [`SAWSpinErrorCode`](../enumerations/SAWSpinErrorCode.md)
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`
58
56
 
59
- ___
57
+ ***
60
58
 
61
59
  ### request\_id
62
60
 
63
- • **request\_id**: `string`
61
+ > **request\_id**: `string`
64
62
 
65
- ___
63
+ ***
66
64
 
67
65
  ### saw\_prize\_id
68
66
 
69
- • **saw\_prize\_id**: `number`
67
+ > **saw\_prize\_id**: `number`
70
68
 
71
- ___
69
+ ***
72
70
 
73
- ### jackpot\_amount
71
+ ### jackpot\_amount?
74
72
 
75
- • `Optional` **jackpot\_amount**: `number`
73
+ > `optional` **jackpot\_amount?**: `number`
76
74
 
77
- ___
75
+ ***
78
76
 
79
77
  ### first\_spin\_in\_period
80
78
 
81
- • **first\_spin\_in\_period**: `number`
79
+ > **first\_spin\_in\_period**: `number`
82
80
 
83
- ___
81
+ ***
84
82
 
85
- ### visitor\_win\_uuid
83
+ ### visitor\_win\_uuid?
86
84
 
87
- • `Optional` **visitor\_win\_uuid**: `string`
85
+ > `optional` **visitor\_win\_uuid?**: `string`
88
86
 
89
- ___
87
+ ***
90
88
 
91
- ### spin\_id
89
+ ### spin\_id?
92
90
 
93
- • `Optional` **spin\_id**: `number`
91
+ > `optional` **spin\_id?**: `number`