@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.
- package/dist/Base/ClassId.d.ts +8 -0
- package/dist/Clans/Clan.d.ts +17 -0
- package/dist/Clans/GetClanInfoRequest.d.ts +5 -0
- package/dist/Clans/GetClanInfoResponse.d.ts +22 -0
- package/dist/Clans/GetClanListRequest.d.ts +4 -0
- package/dist/Clans/GetClanListResponse.d.ts +9 -0
- package/dist/Clans/JoinClanRequest.d.ts +5 -0
- package/dist/Clans/JoinClanResponse.d.ts +5 -0
- package/dist/Clans/index.d.ts +7 -0
- package/dist/SmarticoAPI.d.ts +8 -1
- package/dist/SmarticoLib/index.d.ts +196 -0
- package/dist/Tournaments/GetClanTournamentPlayersRequest.d.ts +6 -0
- package/dist/Tournaments/GetClanTournamentPlayersResponse.d.ts +40 -0
- package/dist/Tournaments/GetTournamentInfoResponse.d.ts +11 -0
- package/dist/Tournaments/Tournament.d.ts +2 -0
- package/dist/Tournaments/TournamentClan.d.ts +27 -0
- package/dist/Tournaments/index.d.ts +3 -0
- package/dist/WSAPI/WSAPI.d.ts +34 -1
- package/dist/WSAPI/WSAPITypes.d.ts +144 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +561 -290
- package/dist/index.js.map +1 -1
- package/dist/index.modern.mjs +193 -2
- package/dist/index.modern.mjs.map +1 -1
- package/docs/api/README.md +99 -330
- package/docs/api/classes/SAWUtils.md +25 -11
- package/docs/api/classes/WSAPI.md +737 -379
- package/docs/api/enumerations/AchCustomLayoutTheme.md +25 -0
- package/docs/api/enumerations/AchCustomSectionType.md +79 -0
- package/docs/api/{enums → enumerations}/AchMissionsTabsOptions.md +5 -5
- package/docs/api/{enums → enumerations}/AchOverviewMissionsFilter.md +9 -9
- package/docs/api/{enums → enumerations}/AchievementAvailabilityStatus.md +29 -29
- package/docs/api/enumerations/AchievementStatus.md +49 -0
- package/docs/api/{enums → enumerations}/AchievementTaskType.md +3 -3
- package/docs/api/{enums → enumerations}/AchievementType.md +3 -3
- package/docs/api/enumerations/ActivityTypeLimited.md +115 -0
- package/docs/api/{enums → enumerations}/AttemptPeriodType.md +7 -7
- package/docs/api/{enums → enumerations}/BadgesTimeLimitStates.md +11 -11
- package/docs/api/{enums → enumerations}/BonusStatus-1.md +11 -11
- package/docs/api/enumerations/BonusStatus.md +37 -0
- package/docs/api/{enums → enumerations}/BuyStoreItemErrorCode.md +21 -21
- package/docs/api/{enums → enumerations}/GPRoundStatus.md +9 -9
- package/docs/api/{enums → enumerations}/GamePickMarketType.md +3 -3
- package/docs/api/{enums → enumerations}/GamePickResolutionType.md +7 -7
- package/docs/api/{enums → enumerations}/GamePickScoreType.md +3 -3
- package/docs/api/enumerations/GamePickSportType.md +375 -0
- package/docs/api/{enums → enumerations}/GameRoundOrderType.md +7 -7
- package/docs/api/{enums → enumerations}/InboxCategories.md +5 -5
- package/docs/api/enumerations/InboxMessageType.md +55 -0
- package/docs/api/{enums → enumerations}/InboxReadStatus.md +3 -3
- package/docs/api/{enums → enumerations}/JackPotTemparature.md +7 -7
- package/docs/api/{enums → enumerations}/JackpotContributionType.md +3 -3
- package/docs/api/{enums → enumerations}/JackpotType.md +3 -3
- package/docs/api/{enums → enumerations}/LeaderBoardPeriodType.md +5 -5
- package/docs/api/enumerations/LiquidEntityData.md +73 -0
- package/docs/api/enumerations/MiniGamePrizeTypeName.md +67 -0
- package/docs/api/{enums → enumerations}/OpenLinksType.md +3 -3
- package/docs/api/enumerations/PointChangeSourceType.md +109 -0
- package/docs/api/enumerations/PrizeModifiers.md +49 -0
- package/docs/api/enumerations/QuizAnswersValueType.md +121 -0
- package/docs/api/{enums → enumerations}/RaffleDrawInstanceState.md +5 -5
- package/docs/api/{enums → enumerations}/RaffleDrawTypeExecution.md +5 -5
- package/docs/api/{enums → enumerations}/RaffleTicketCapVisualization.md +5 -5
- package/docs/api/{enums → enumerations}/SAWAcknowledgeType.md +7 -7
- package/docs/api/enumerations/SAWAcknowledgeTypeName.md +25 -0
- package/docs/api/{enums → enumerations}/SAWAskForUsername.md +3 -3
- package/docs/api/enumerations/SAWBuyInType.md +31 -0
- package/docs/api/enumerations/SAWBuyInTypeName.md +37 -0
- package/docs/api/{enums → enumerations}/SAWExposeUserSpinId.md +3 -3
- package/docs/api/{enums → enumerations}/SAWExposeUserSpinIdName.md +3 -3
- package/docs/api/enumerations/SAWGPMarketType.md +157 -0
- package/docs/api/{enums → enumerations}/SAWGameDifficultyType.md +5 -5
- package/docs/api/{enums → enumerations}/SAWGameDifficultyTypeName.md +5 -5
- package/docs/api/{enums → enumerations}/SAWGameLayout.md +3 -3
- package/docs/api/{enums → enumerations}/SAWGameLayoutName.md +3 -3
- package/docs/api/enumerations/SAWGameType.md +73 -0
- package/docs/api/enumerations/SAWGameTypeName.md +79 -0
- package/docs/api/enumerations/SAWPrizeType.md +61 -0
- package/docs/api/{enums → enumerations}/SAWSpinErrorCode.md +19 -19
- package/docs/api/{enums → enumerations}/SAWWheelLayout.md +7 -7
- package/docs/api/enumerations/SAWWinSoundType.md +31 -0
- package/docs/api/{enums → enumerations}/ScheduledMissionType.md +5 -5
- package/docs/api/{enums → enumerations}/StoreItemPurchaseType.md +5 -5
- package/docs/api/enumerations/StoreItemType.md +37 -0
- package/docs/api/enumerations/StoreItemTypeName.md +43 -0
- package/docs/api/enumerations/TournamentInstanceStatus.md +43 -0
- package/docs/api/enumerations/TournamentRegistrationError.md +55 -0
- package/docs/api/enumerations/TournamentRegistrationStatus.md +43 -0
- package/docs/api/enumerations/TournamentRegistrationStatusName.md +49 -0
- package/docs/api/enumerations/TournamentRegistrationType.md +43 -0
- package/docs/api/{enums → enumerations}/TournamentType.md +5 -5
- package/docs/api/{enums → enumerations}/UserBalanceType.md +5 -5
- package/docs/api/functions/AchCategoryTransform.md +13 -0
- package/docs/api/functions/BonusItemsTransform.md +13 -0
- package/docs/api/functions/InboxMessageBodyTransform.md +13 -0
- package/docs/api/functions/SAWHistoryTransform.md +13 -0
- package/docs/api/functions/SAWTemplatesTransform.md +13 -0
- package/docs/api/functions/StoreCategoryTransform.md +13 -0
- package/docs/api/functions/StoreItemTransform.md +13 -0
- package/docs/api/functions/StoreItemTypeNamed.md +13 -0
- package/docs/api/functions/TournamentInstanceStatusName.md +13 -0
- package/docs/api/functions/TournamentItemsTransform.md +13 -0
- package/docs/api/functions/UICustomSectionTransform.md +13 -0
- package/docs/api/functions/UserAchievementTransform.md +13 -0
- package/docs/api/functions/enrichUserAchievementsWithBadgeState.md +13 -0
- package/docs/api/functions/tournamentInfoItemTransform.md +13 -0
- package/docs/api/interfaces/AchCategory.md +5 -5
- package/docs/api/interfaces/AchCategoryPublicMeta.md +5 -5
- package/docs/api/interfaces/AchRelatedGame-1.md +50 -15
- package/docs/api/interfaces/AchRelatedGame.md +35 -16
- package/docs/api/interfaces/AchievementPublicMeta.md +65 -65
- package/docs/api/interfaces/AchievementTaskPublicMeta.md +16 -16
- package/docs/api/interfaces/AffectsProgress.md +7 -7
- package/docs/api/interfaces/Bonus.md +37 -37
- package/docs/api/interfaces/BonusMetaMap-1.md +2 -2
- package/docs/api/interfaces/BonusMetaMap.md +2 -2
- package/docs/api/interfaces/BonusTemplateMetaMap-1.md +8 -8
- package/docs/api/interfaces/BonusTemplateMetaMap.md +8 -8
- package/docs/api/interfaces/Clan.md +53 -0
- package/docs/api/interfaces/ClanLeaderboardEntry.md +31 -0
- package/docs/api/interfaces/ClanPrizeStructureEntry.md +45 -0
- package/docs/api/interfaces/ClanPrizeTier.md +43 -0
- package/docs/api/interfaces/ClanPublicMeta.md +19 -0
- package/docs/api/interfaces/GamePickBoardUser.md +17 -17
- package/docs/api/interfaces/GamePickEvent.md +40 -38
- package/docs/api/interfaces/GamePickEventMeta.md +79 -59
- package/docs/api/interfaces/GamePickGameInfo.md +5 -5
- package/docs/api/interfaces/GamePickRequestParams.md +10 -12
- package/docs/api/interfaces/GamePickRound.md +96 -98
- package/docs/api/interfaces/GamePickRoundBase.md +58 -61
- package/docs/api/interfaces/GamePickRoundBoard.md +88 -90
- package/docs/api/interfaces/GamePickRoundPublicMeta.md +26 -26
- package/docs/api/interfaces/GamePickRoundRequestParams.md +15 -17
- package/docs/api/interfaces/GamePickUserInfo.md +34 -34
- package/docs/api/interfaces/GamesApiResponse.md +11 -11
- package/docs/api/interfaces/GetCustomSectionsResponse.md +23 -25
- package/docs/api/interfaces/GetDrawRunRequest.md +21 -23
- package/docs/api/interfaces/GetDrawRunResponse.md +21 -23
- package/docs/api/interfaces/GetJackpotEligibleGamesRequest.md +13 -15
- package/docs/api/interfaces/GetJackpotEligibleGamesResponse.md +21 -23
- package/docs/api/interfaces/GetJackpotWinnersRequest.md +26 -28
- package/docs/api/interfaces/GetJackpotWinnersResponse.md +23 -25
- package/docs/api/interfaces/GetJackpotsPotsRequest.md +13 -15
- package/docs/api/interfaces/GetJackpotsPotsResponse.md +21 -23
- package/docs/api/interfaces/GetJackpotsRequest.md +17 -19
- package/docs/api/interfaces/GetJackpotsResponse.md +21 -23
- package/docs/api/interfaces/GetRaffleDrawRunsHistoryRequest.md +16 -18
- package/docs/api/interfaces/GetRaffleDrawRunsHistoryResponse.md +21 -23
- package/docs/api/interfaces/GetRafflesRequest.md +14 -16
- package/docs/api/interfaces/GetRafflesResponse.md +21 -23
- package/docs/api/interfaces/GetRelatedAchTourResponse.md +24 -26
- package/docs/api/interfaces/GetTournamentInfoResponse.md +68 -38
- package/docs/api/interfaces/InboxMarkMessageAction.md +3 -3
- package/docs/api/interfaces/InboxMessage.md +18 -18
- package/docs/api/interfaces/InboxMessageBody.md +37 -29
- package/docs/api/interfaces/JackPotWinner.md +11 -11
- package/docs/api/interfaces/JackpotDetails.md +23 -23
- package/docs/api/interfaces/JackpotEligibleGame.md +19 -19
- package/docs/api/interfaces/JackpotHtmlTemplate.md +3 -3
- package/docs/api/interfaces/JackpotPot.md +11 -11
- package/docs/api/interfaces/JackpotPublicMeta.md +15 -15
- package/docs/api/interfaces/JackpotWinPush.md +15 -17
- package/docs/api/interfaces/JackpotWinnerHistory.md +5 -5
- package/docs/api/interfaces/JackpotsOptinRequest.md +13 -15
- package/docs/api/interfaces/JackpotsOptinResponse.md +19 -21
- package/docs/api/interfaces/JackpotsOptoutRequest.md +13 -15
- package/docs/api/interfaces/JackpotsOptoutResponse.md +19 -21
- package/docs/api/interfaces/LeaderBoardDetailsT.md +16 -16
- package/docs/api/interfaces/LeaderBoardUserT.md +9 -9
- package/docs/api/interfaces/LeaderBoardsRewardsT.md +3 -3
- package/docs/api/interfaces/Level.md +15 -15
- package/docs/api/interfaces/LevelPublicMeta.md +31 -24
- package/docs/api/interfaces/QuizEventMeta.md +34 -14
- package/docs/api/interfaces/Raffle.md +13 -13
- package/docs/api/interfaces/RaffleClaimPrizeRequest.md +13 -15
- package/docs/api/interfaces/RaffleClaimPrizeResponse.md +18 -20
- package/docs/api/interfaces/RaffleDraw.md +44 -44
- package/docs/api/interfaces/RaffleDrawPublicMeta.md +15 -15
- package/docs/api/interfaces/RaffleDrawRun.md +15 -15
- package/docs/api/interfaces/RaffleOptinRequest.md +17 -19
- package/docs/api/interfaces/RaffleOptinResponse.md +19 -21
- package/docs/api/interfaces/RafflePrize.md +31 -31
- package/docs/api/interfaces/RafflePrizePublicMeta.md +7 -7
- package/docs/api/interfaces/RafflePrizeWinner.md +15 -15
- package/docs/api/interfaces/RafflePublicMeta.md +16 -16
- package/docs/api/interfaces/RaffleTicket.md +3 -3
- package/docs/api/interfaces/SAWAcknowledgeSpinPushRequest.md +24 -26
- package/docs/api/interfaces/SAWDoAknowledgeRequest.md +13 -15
- package/docs/api/interfaces/SAWDoAknowledgeResponse.md +13 -15
- package/docs/api/interfaces/SAWDoSpinRequest.md +24 -26
- package/docs/api/interfaces/SAWDoSpinResponse.md +33 -35
- package/docs/api/interfaces/SAWEventSawPush.md +17 -19
- package/docs/api/interfaces/SAWGetTemplatesRequest.md +26 -28
- package/docs/api/interfaces/SAWGetTemplatesResponse.md +21 -23
- package/docs/api/interfaces/SAWPrize.md +52 -52
- package/docs/api/interfaces/SAWPrizeDropAknowledgeRequest.md +17 -19
- package/docs/api/interfaces/SAWPrizeDropAknowledgeResponse.md +13 -15
- package/docs/api/interfaces/SAWPrizeDropWinPush.md +21 -23
- package/docs/api/interfaces/SAWPrizeUI.md +78 -78
- package/docs/api/interfaces/SAWPrizesHistory.md +15 -15
- package/docs/api/interfaces/SAWSpinsCountPush.md +15 -17
- package/docs/api/interfaces/SAWTemplate.md +70 -63
- package/docs/api/interfaces/SAWTemplateUI.md +155 -150
- package/docs/api/interfaces/SAWWinningHistoryRequest.md +21 -23
- package/docs/api/interfaces/SAWWinningHistoryResponse.md +23 -25
- package/docs/api/interfaces/StoreCategory.md +5 -5
- package/docs/api/interfaces/StoreCategoryPublicMeta.md +5 -5
- package/docs/api/interfaces/StoreItem.md +19 -19
- package/docs/api/interfaces/StoreItemPublicMeta.md +51 -51
- package/docs/api/interfaces/TAchCategory.md +5 -5
- package/docs/api/interfaces/TActivityLog.md +16 -16
- package/docs/api/interfaces/TAvatarCustomized.md +27 -0
- package/docs/api/interfaces/TAvatarDefinition.md +101 -0
- package/docs/api/interfaces/TAvatarPrompt.md +44 -0
- package/docs/api/interfaces/TBonus.md +22 -22
- package/docs/api/interfaces/TBuyStoreItemResult.md +3 -3
- package/docs/api/interfaces/TClaimBonusResult.md +6 -6
- package/docs/api/interfaces/TClan.md +79 -0
- package/docs/api/interfaces/TClanInfo.md +111 -0
- package/docs/api/interfaces/TClanJoinResult.md +15 -0
- package/docs/api/interfaces/TClanTournamentPlayers.md +71 -0
- package/docs/api/interfaces/TClans.md +27 -0
- package/docs/api/interfaces/TGetJackpotEligibleGamesResponse.md +1 -1
- package/docs/api/interfaces/TGetTranslations.md +3 -3
- package/docs/api/interfaces/TInboxMessage.md +13 -13
- package/docs/api/interfaces/TInboxMessageBody.md +28 -16
- package/docs/api/interfaces/TLevel.md +21 -23
- package/docs/api/interfaces/TLevelCurrent.md +32 -34
- package/docs/api/interfaces/TMiniGamePlayBatchResult.md +12 -12
- package/docs/api/interfaces/TMiniGamePlayResult.md +5 -5
- package/docs/api/interfaces/TMiniGamePrize.md +83 -83
- package/docs/api/interfaces/TMiniGameTemplate.md +81 -81
- package/docs/api/interfaces/TMissionClaimRewardResult.md +3 -3
- package/docs/api/interfaces/TMissionOptInResult.md +3 -3
- package/docs/api/interfaces/TMissionOrBadge.md +110 -110
- package/docs/api/interfaces/TMissionOrBadgeTask.md +15 -15
- package/docs/api/interfaces/TRaffle.md +25 -25
- package/docs/api/interfaces/TRaffleDraw.md +61 -61
- package/docs/api/interfaces/TRaffleDrawRun.md +39 -39
- package/docs/api/interfaces/TRaffleOptinResponse.md +4 -4
- package/docs/api/interfaces/TRafflePrize.md +35 -35
- package/docs/api/interfaces/TRafflePrizeWinner.md +13 -13
- package/docs/api/interfaces/TRaffleTicket.md +3 -3
- package/docs/api/interfaces/TSawHistory.md +15 -15
- package/docs/api/interfaces/TSegmentCheckResult.md +3 -3
- package/docs/api/interfaces/TSetAvatarResult.md +19 -0
- package/docs/api/interfaces/TStoreCategory.md +5 -5
- package/docs/api/interfaces/TStoreItem.md +77 -77
- package/docs/api/interfaces/TTournament.md +165 -97
- package/docs/api/interfaces/TTournamentDetailed.md +378 -140
- package/docs/api/interfaces/TTournamentRegistrationResult.md +3 -3
- package/docs/api/interfaces/TUICustomSection.md +52 -52
- package/docs/api/interfaces/TUserProfile.md +32 -32
- package/docs/api/interfaces/Tournament.md +87 -81
- package/docs/api/interfaces/TournamentPlayer.md +18 -18
- package/docs/api/interfaces/TournamentPrize.md +17 -17
- package/docs/api/interfaces/TournamentPublicMeta.md +47 -47
- package/docs/api/interfaces/TransformedRaffleClaimPrizeResponse.md +4 -4
- package/docs/api/interfaces/UICustomSection.md +50 -50
- package/docs/api/interfaces/UserAchievement.md +101 -101
- package/docs/api/interfaces/UserAchievementTask.md +38 -38
- package/docs/api/interfaces/UserLevelExtraCountersT.md +5 -5
- package/docs/api/type-aliases/TournamentRegistrationTypeName.md +3 -0
- package/docs/api/variables/AllRoundsGameBoardID.md +5 -0
- package/docs/api/variables/PrizeModifiersKeysNames.md +37 -0
- package/docs/api/variables/SAWWinSoundFiles.md +21 -0
- package/package.json +1 -1
- package/src/Base/ClassId.ts +12 -0
- package/src/Clans/Clan.ts +18 -0
- package/src/Clans/GetClanInfoRequest.ts +6 -0
- package/src/Clans/GetClanInfoResponse.ts +24 -0
- package/src/Clans/GetClanListRequest.ts +5 -0
- package/src/Clans/GetClanListResponse.ts +10 -0
- package/src/Clans/JoinClanRequest.ts +6 -0
- package/src/Clans/JoinClanResponse.ts +6 -0
- package/src/Clans/index.ts +7 -0
- package/src/Raffle/GetRafflesResponse.ts +1 -1
- package/src/SmarticoAPI.ts +95 -0
- package/src/SmarticoLib/index.ts +163 -0
- package/src/Tournaments/GetClanTournamentPlayersRequest.ts +7 -0
- package/src/Tournaments/GetClanTournamentPlayersResponse.ts +58 -0
- package/src/Tournaments/GetTournamentInfoResponse.ts +52 -0
- package/src/Tournaments/Tournament.ts +2 -0
- package/src/Tournaments/TournamentClan.ts +30 -0
- package/src/Tournaments/index.ts +3 -0
- package/src/WSAPI/WSAPI.ts +61 -2
- package/src/WSAPI/WSAPITypes.ts +131 -0
- package/src/index.ts +2 -1
- package/tsconfig.json +5 -3
- package/docs/api/.nojekyll +0 -1
- package/docs/api/enums/AchCustomLayoutTheme.md +0 -25
- package/docs/api/enums/AchCustomSectionType.md +0 -79
- package/docs/api/enums/AchievementStatus.md +0 -49
- package/docs/api/enums/ActivityTypeLimited.md +0 -115
- package/docs/api/enums/BonusStatus.md +0 -37
- package/docs/api/enums/GamePickSportType.md +0 -375
- package/docs/api/enums/InboxMessageType.md +0 -55
- package/docs/api/enums/LiquidEntityData.md +0 -73
- package/docs/api/enums/MiniGamePrizeTypeName.md +0 -67
- package/docs/api/enums/PointChangeSourceType.md +0 -109
- package/docs/api/enums/PrizeModifiers.md +0 -49
- package/docs/api/enums/QuizAnswersValueType.md +0 -121
- package/docs/api/enums/SAWAcknowledgeTypeName.md +0 -25
- package/docs/api/enums/SAWBuyInType.md +0 -31
- package/docs/api/enums/SAWBuyInTypeName.md +0 -37
- package/docs/api/enums/SAWGPMarketType.md +0 -157
- package/docs/api/enums/SAWGameType.md +0 -73
- package/docs/api/enums/SAWGameTypeName.md +0 -79
- package/docs/api/enums/SAWPrizeType.md +0 -61
- package/docs/api/enums/SAWWinSoundType.md +0 -31
- package/docs/api/enums/StoreItemType.md +0 -37
- package/docs/api/enums/StoreItemTypeName.md +0 -43
- package/docs/api/enums/TournamentInstanceStatus.md +0 -43
- package/docs/api/enums/TournamentRegistrationError.md +0 -55
- package/docs/api/enums/TournamentRegistrationStatus.md +0 -43
- package/docs/api/enums/TournamentRegistrationStatusName.md +0 -49
- package/docs/api/enums/TournamentRegistrationType.md +0 -43
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
### err\_code
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
> **err\_code**: [`TournamentRegistrationError`](../enumerations/TournamentRegistrationError.md)
|
|
8
8
|
|
|
9
9
|
Error code that represents outcome of the tournament registration request. Successful registration in case err_code is 0
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
***
|
|
12
12
|
|
|
13
13
|
### err\_message
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
> **err\_message**: `string`
|
|
16
16
|
|
|
17
17
|
Optional error message
|
|
@@ -4,142 +4,142 @@
|
|
|
4
4
|
|
|
5
5
|
### id
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
> **id**: `number`
|
|
8
8
|
|
|
9
9
|
The ID of the custom section
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
***
|
|
12
12
|
|
|
13
|
-
### body
|
|
13
|
+
### body?
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
> `optional` **body?**: `string`
|
|
16
16
|
|
|
17
17
|
The body of the custom section
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
***
|
|
20
20
|
|
|
21
|
-
### menu\_img
|
|
21
|
+
### menu\_img?
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
> `optional` **menu\_img?**: `string`
|
|
24
24
|
|
|
25
25
|
The image of the custom section, 64x64px
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
***
|
|
28
28
|
|
|
29
|
-
### menu\_name
|
|
29
|
+
### menu\_name?
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
> `optional` **menu\_name?**: `string`
|
|
32
32
|
|
|
33
33
|
The name of the custom section
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
***
|
|
36
36
|
|
|
37
|
-
### custom\_skin\_images
|
|
37
|
+
### custom\_skin\_images?
|
|
38
38
|
|
|
39
|
-
|
|
39
|
+
> `optional` **custom\_skin\_images?**: `string`
|
|
40
40
|
|
|
41
41
|
Custom images for custom section
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
***
|
|
44
44
|
|
|
45
|
-
### section\_type\_id
|
|
45
|
+
### section\_type\_id?
|
|
46
46
|
|
|
47
|
-
|
|
47
|
+
> `optional` **section\_type\_id?**: [`AchCustomSectionType`](../enumerations/AchCustomSectionType.md)
|
|
48
48
|
|
|
49
49
|
The particular type of custom section, can be Missions, Tournaments, Lootbox and etc
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
***
|
|
52
52
|
|
|
53
|
-
### theme
|
|
53
|
+
### theme?
|
|
54
54
|
|
|
55
|
-
|
|
55
|
+
> `optional` **theme?**: [`AchCustomLayoutTheme`](../enumerations/AchCustomLayoutTheme.md)
|
|
56
56
|
|
|
57
57
|
Theme of the custom section
|
|
58
58
|
|
|
59
|
-
|
|
59
|
+
***
|
|
60
60
|
|
|
61
|
-
### generic\_custom\_css
|
|
61
|
+
### generic\_custom\_css?
|
|
62
62
|
|
|
63
|
-
|
|
63
|
+
> `optional` **generic\_custom\_css?**: `string`
|
|
64
64
|
|
|
65
65
|
Custom css for the custom section
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
***
|
|
68
68
|
|
|
69
|
-
### mission\_tabs\_options
|
|
69
|
+
### mission\_tabs\_options?
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
> `optional` **mission\_tabs\_options?**: [`AchMissionsTabsOptions`](../enumerations/AchMissionsTabsOptions.md)
|
|
72
72
|
|
|
73
73
|
Tabs that can be shown in custom section, e.g Overview, No Overview, All tabs
|
|
74
74
|
|
|
75
|
-
|
|
75
|
+
***
|
|
76
76
|
|
|
77
|
-
### overview\_missions\_filter
|
|
77
|
+
### overview\_missions\_filter?
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
> `optional` **overview\_missions\_filter?**: [`AchOverviewMissionsFilter`](../enumerations/AchOverviewMissionsFilter.md)
|
|
80
80
|
|
|
81
81
|
Filter that allow to show missions by criteria
|
|
82
82
|
|
|
83
|
-
|
|
83
|
+
***
|
|
84
84
|
|
|
85
|
-
### overview\_missions\_count
|
|
85
|
+
### overview\_missions\_count?
|
|
86
86
|
|
|
87
|
-
|
|
87
|
+
> `optional` **overview\_missions\_count?**: `number`
|
|
88
88
|
|
|
89
89
|
Quantity of missions to be shown in overview
|
|
90
90
|
|
|
91
|
-
|
|
91
|
+
***
|
|
92
92
|
|
|
93
|
-
### liquid\_entity\_data
|
|
93
|
+
### liquid\_entity\_data?
|
|
94
94
|
|
|
95
|
-
|
|
95
|
+
> `optional` **liquid\_entity\_data?**: [`LiquidEntityData`](../enumerations/LiquidEntityData.md)[]
|
|
96
96
|
|
|
97
97
|
Data to be used for Liquid templates
|
|
98
98
|
|
|
99
|
-
|
|
99
|
+
***
|
|
100
100
|
|
|
101
|
-
### ach\_tournament\_id
|
|
101
|
+
### ach\_tournament\_id?
|
|
102
102
|
|
|
103
|
-
|
|
103
|
+
> `optional` **ach\_tournament\_id?**: `number`
|
|
104
104
|
|
|
105
105
|
Tournament ID to be used for Liquid templates
|
|
106
106
|
|
|
107
|
-
|
|
107
|
+
***
|
|
108
108
|
|
|
109
|
-
### show\_raw\_data
|
|
109
|
+
### show\_raw\_data?
|
|
110
110
|
|
|
111
|
-
|
|
111
|
+
> `optional` **show\_raw\_data?**: `boolean`
|
|
112
112
|
|
|
113
113
|
Indicates if the data should be shown as raw data (for Liquid templates)
|
|
114
114
|
|
|
115
|
-
|
|
115
|
+
***
|
|
116
116
|
|
|
117
|
-
### liquid\_template
|
|
117
|
+
### liquid\_template?
|
|
118
118
|
|
|
119
|
-
|
|
119
|
+
> `optional` **liquid\_template?**: `number`
|
|
120
120
|
|
|
121
121
|
Liquid template id to be used for Liquid templates
|
|
122
122
|
|
|
123
|
-
|
|
123
|
+
***
|
|
124
124
|
|
|
125
|
-
### ach\_category\_ids
|
|
125
|
+
### ach\_category\_ids?
|
|
126
126
|
|
|
127
|
-
|
|
127
|
+
> `optional` **ach\_category\_ids?**: `number`[]
|
|
128
128
|
|
|
129
129
|
List of IDs of the categories where the badge item is assigned, information about categories can be retrieved with getAchCategories method
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
***
|
|
132
132
|
|
|
133
|
-
### shop\_category\_ids
|
|
133
|
+
### shop\_category\_ids?
|
|
134
134
|
|
|
135
|
-
|
|
135
|
+
> `optional` **shop\_category\_ids?**: `number`[]
|
|
136
136
|
|
|
137
137
|
List of IDs of the categories where the store item is assigned, information about categories can be retrieved with getShopCategories method
|
|
138
138
|
|
|
139
|
-
|
|
139
|
+
***
|
|
140
140
|
|
|
141
|
-
### raffle\_id
|
|
141
|
+
### raffle\_id?
|
|
142
142
|
|
|
143
|
-
|
|
143
|
+
> `optional` **raffle\_id?**: `number`
|
|
144
144
|
|
|
145
145
|
ID of the raffle to be used for Liquid templates
|
|
@@ -9,105 +9,105 @@ If you want to track the changes of the user profile, you can subscribe to the c
|
|
|
9
9
|
|
|
10
10
|
### core\_user\_language
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
> **core\_user\_language**: `string`
|
|
13
13
|
|
|
14
14
|
The language of the user
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
***
|
|
17
17
|
|
|
18
18
|
### ach\_points\_balance
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
> **ach\_points\_balance**: `number`
|
|
21
21
|
|
|
22
22
|
The current points balance that user can use in the Store, Mini-games, Tournaments, etc..
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
***
|
|
25
25
|
|
|
26
26
|
### ach\_points\_ever
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
> **ach\_points\_ever**: `number`
|
|
29
29
|
|
|
30
30
|
The amount of points that user collected in total
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
***
|
|
33
33
|
|
|
34
34
|
### ach\_gems\_balance
|
|
35
35
|
|
|
36
|
-
|
|
36
|
+
> **ach\_gems\_balance**: `number`
|
|
37
37
|
|
|
38
38
|
The current gems balance
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
***
|
|
41
41
|
|
|
42
42
|
### ach\_diamonds\_balance
|
|
43
43
|
|
|
44
|
-
|
|
44
|
+
> **ach\_diamonds\_balance**: `number`
|
|
45
45
|
|
|
46
46
|
The current diamonds balance
|
|
47
47
|
|
|
48
|
-
|
|
48
|
+
***
|
|
49
49
|
|
|
50
50
|
### core\_public\_tags
|
|
51
51
|
|
|
52
|
-
|
|
52
|
+
> **core\_public\_tags**: `string`[]
|
|
53
53
|
|
|
54
54
|
The array of the public tags set on the user object.
|
|
55
55
|
They can be treated as server-based cookies.
|
|
56
56
|
You can set tags using following method _smartico.event('core_public_tags_update', { core_public_tags: ['A', 'B'] } );
|
|
57
57
|
And then you can check for the tags
|
|
58
58
|
|
|
59
|
-
|
|
59
|
+
***
|
|
60
60
|
|
|
61
|
-
### ach\_level\_current\_id
|
|
61
|
+
### ach\_level\_current\_id?
|
|
62
62
|
|
|
63
|
-
|
|
63
|
+
> `optional` **ach\_level\_current\_id?**: `number`
|
|
64
64
|
|
|
65
65
|
The ID of the current level of the user
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
***
|
|
68
68
|
|
|
69
|
-
### core\_is\_test\_account
|
|
69
|
+
### core\_is\_test\_account?
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
> `optional` **core\_is\_test\_account?**: `boolean`
|
|
72
72
|
|
|
73
73
|
The indicator if user is marked as test user
|
|
74
74
|
|
|
75
|
-
|
|
75
|
+
***
|
|
76
76
|
|
|
77
|
-
### avatar\_url
|
|
77
|
+
### avatar\_url?
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
> `optional` **avatar\_url?**: `string`
|
|
80
80
|
|
|
81
81
|
The URL to the user avatar
|
|
82
82
|
|
|
83
|
-
|
|
83
|
+
***
|
|
84
84
|
|
|
85
|
-
### public\_username
|
|
85
|
+
### public\_username?
|
|
86
86
|
|
|
87
|
-
|
|
87
|
+
> `optional` **public\_username?**: `string`
|
|
88
88
|
|
|
89
89
|
The username of current user
|
|
90
90
|
|
|
91
|
-
|
|
91
|
+
***
|
|
92
92
|
|
|
93
|
-
### core\_inbox\_unread\_count
|
|
93
|
+
### core\_inbox\_unread\_count?
|
|
94
94
|
|
|
95
|
-
|
|
95
|
+
> `optional` **core\_inbox\_unread\_count?**: `number`
|
|
96
96
|
|
|
97
97
|
THe number of unread inbox messages
|
|
98
98
|
|
|
99
|
-
|
|
99
|
+
***
|
|
100
100
|
|
|
101
|
-
### core\_recommended\_deposit\_amount
|
|
101
|
+
### core\_recommended\_deposit\_amount?
|
|
102
102
|
|
|
103
|
-
|
|
103
|
+
> `optional` **core\_recommended\_deposit\_amount?**: `number`
|
|
104
104
|
|
|
105
105
|
The recommended deposit amount for the user
|
|
106
106
|
|
|
107
|
-
|
|
107
|
+
***
|
|
108
108
|
|
|
109
|
-
### core\_recommended\_casino\_bet\_amount
|
|
109
|
+
### core\_recommended\_casino\_bet\_amount?
|
|
110
110
|
|
|
111
|
-
|
|
111
|
+
> `optional` **core\_recommended\_casino\_bet\_amount?**: `number`
|
|
112
112
|
|
|
113
113
|
The recommended casino bet amount for the user
|
|
@@ -2,214 +2,220 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
### tournamentId
|
|
5
|
+
### tournamentId?
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
> `optional` **tournamentId?**: `number`
|
|
8
8
|
|
|
9
9
|
ID of tournament template
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
***
|
|
12
12
|
|
|
13
|
-
### tournamentInstanceId
|
|
13
|
+
### tournamentInstanceId?
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
> `optional` **tournamentInstanceId?**: `number`
|
|
16
16
|
|
|
17
17
|
ID of tournament instance. Generated every time when tournament based on specific template is scheduled for run
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
***
|
|
20
20
|
|
|
21
|
-
### tournamentType
|
|
21
|
+
### tournamentType?
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
> `optional` **tournamentType?**: [`TournamentType`](../enumerations/TournamentType.md)
|
|
24
24
|
|
|
25
25
|
Type of the tournament. For now only SCHEDULED is support
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
***
|
|
28
28
|
|
|
29
|
-
### publicMeta
|
|
29
|
+
### publicMeta?
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
> `optional` **publicMeta?**: [`TournamentPublicMeta`](TournamentPublicMeta.md)
|
|
32
32
|
|
|
33
33
|
Meta information about tournament that should be used to build UI
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
***
|
|
36
36
|
|
|
37
|
-
### buyInAmount
|
|
37
|
+
### buyInAmount?
|
|
38
38
|
|
|
39
|
-
|
|
39
|
+
> `optional` **buyInAmount?**: `number`
|
|
40
40
|
|
|
41
41
|
Cost of registration in the tournament in gamification points
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
***
|
|
44
44
|
|
|
45
|
-
### prizePool
|
|
45
|
+
### prizePool?
|
|
46
46
|
|
|
47
|
-
|
|
47
|
+
> `optional` **prizePool?**: `number`
|
|
48
48
|
|
|
49
49
|
Not in use
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
***
|
|
52
52
|
|
|
53
|
-
### startTime
|
|
53
|
+
### startTime?
|
|
54
54
|
|
|
55
|
-
|
|
55
|
+
> `optional` **startTime?**: `string`
|
|
56
56
|
|
|
57
57
|
The time when tournament is going to start
|
|
58
58
|
|
|
59
|
-
|
|
59
|
+
***
|
|
60
60
|
|
|
61
|
-
### endTime
|
|
61
|
+
### endTime?
|
|
62
62
|
|
|
63
|
-
|
|
63
|
+
> `optional` **endTime?**: `string`
|
|
64
64
|
|
|
65
65
|
The time when tournament is going to finish
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
***
|
|
68
68
|
|
|
69
|
-
### startTimeTs
|
|
69
|
+
### startTimeTs?
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
> `optional` **startTimeTs?**: `number`
|
|
72
72
|
|
|
73
73
|
The time when tournament is going to start, epoch
|
|
74
74
|
|
|
75
|
-
|
|
75
|
+
***
|
|
76
76
|
|
|
77
|
-
### endTimeTs
|
|
77
|
+
### endTimeTs?
|
|
78
78
|
|
|
79
|
-
|
|
79
|
+
> `optional` **endTimeTs?**: `number`
|
|
80
80
|
|
|
81
81
|
The time when tournament is going to finish, epoch
|
|
82
82
|
|
|
83
|
-
|
|
83
|
+
***
|
|
84
84
|
|
|
85
|
-
### registrationCount
|
|
85
|
+
### registrationCount?
|
|
86
86
|
|
|
87
|
-
|
|
87
|
+
> `optional` **registrationCount?**: `number`
|
|
88
88
|
|
|
89
89
|
Number of users registered in the tournament
|
|
90
90
|
|
|
91
|
-
|
|
91
|
+
***
|
|
92
92
|
|
|
93
|
-
### totalCount
|
|
93
|
+
### totalCount?
|
|
94
94
|
|
|
95
|
-
|
|
95
|
+
> `optional` **totalCount?**: `number`
|
|
96
96
|
|
|
97
97
|
Not in use
|
|
98
98
|
|
|
99
|
-
|
|
99
|
+
***
|
|
100
100
|
|
|
101
|
-
### registrationType
|
|
101
|
+
### registrationType?
|
|
102
102
|
|
|
103
|
-
|
|
103
|
+
> `optional` **registrationType?**: [`TournamentRegistrationType`](../enumerations/TournamentRegistrationType.md)
|
|
104
104
|
|
|
105
105
|
Type of registration in the tournament
|
|
106
106
|
|
|
107
|
-
|
|
107
|
+
***
|
|
108
108
|
|
|
109
|
-
### tournamentRegistrationStatus
|
|
109
|
+
### tournamentRegistrationStatus?
|
|
110
110
|
|
|
111
|
-
|
|
111
|
+
> `optional` **tournamentRegistrationStatus?**: [`TournamentRegistrationStatus`](../enumerations/TournamentRegistrationStatus.md)
|
|
112
112
|
|
|
113
113
|
Status of registration in the tournament for current user
|
|
114
114
|
|
|
115
|
-
|
|
115
|
+
***
|
|
116
116
|
|
|
117
|
-
### tournamentInstanceStatus
|
|
117
|
+
### tournamentInstanceStatus?
|
|
118
118
|
|
|
119
|
-
|
|
119
|
+
> `optional` **tournamentInstanceStatus?**: [`TournamentInstanceStatus`](../enumerations/TournamentInstanceStatus.md)
|
|
120
120
|
|
|
121
121
|
Status of tournament instance
|
|
122
122
|
|
|
123
|
-
|
|
123
|
+
***
|
|
124
124
|
|
|
125
|
-
### isUserRegistered
|
|
125
|
+
### isUserRegistered?
|
|
126
126
|
|
|
127
|
-
|
|
127
|
+
> `optional` **isUserRegistered?**: `boolean`
|
|
128
128
|
|
|
129
129
|
flag indicating if current user is registered in the tournament
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
***
|
|
132
132
|
|
|
133
|
-
### allowLateRegistration
|
|
133
|
+
### allowLateRegistration?
|
|
134
134
|
|
|
135
|
-
|
|
135
|
+
> `optional` **allowLateRegistration?**: `boolean`
|
|
136
136
|
|
|
137
137
|
Indicator if tournament allows later registration, when tournament is already started
|
|
138
138
|
|
|
139
|
-
|
|
139
|
+
***
|
|
140
140
|
|
|
141
|
-
### playersMinCount
|
|
141
|
+
### playersMinCount?
|
|
142
142
|
|
|
143
|
-
|
|
143
|
+
> `optional` **playersMinCount?**: `number`
|
|
144
144
|
|
|
145
145
|
Minimum number of participant for this tournament. If tournament doesnt have enough registrations, it will not start
|
|
146
146
|
|
|
147
|
-
|
|
147
|
+
***
|
|
148
148
|
|
|
149
|
-
### playersMaxCount
|
|
149
|
+
### playersMaxCount?
|
|
150
150
|
|
|
151
|
-
|
|
151
|
+
> `optional` **playersMaxCount?**: `number`
|
|
152
152
|
|
|
153
153
|
Maximum number of participant for this tournament. When reached, new users won't be able to register
|
|
154
154
|
|
|
155
|
-
|
|
155
|
+
***
|
|
156
156
|
|
|
157
|
-
### durationMs
|
|
157
|
+
### durationMs?
|
|
158
158
|
|
|
159
|
-
|
|
159
|
+
> `optional` **durationMs?**: `number`
|
|
160
160
|
|
|
161
161
|
Tournament duration in millisecnnds
|
|
162
162
|
|
|
163
|
-
|
|
163
|
+
***
|
|
164
164
|
|
|
165
|
-
### prizeStructure
|
|
165
|
+
### prizeStructure?
|
|
166
166
|
|
|
167
|
-
|
|
167
|
+
> `optional` **prizeStructure?**: `object`
|
|
168
168
|
|
|
169
169
|
prizes structure
|
|
170
170
|
|
|
171
|
-
####
|
|
171
|
+
#### prizes
|
|
172
172
|
|
|
173
|
-
|
|
174
|
-
| :------ | :------ |
|
|
175
|
-
| `prizes` | [`TournamentPrize`](TournamentPrize.md)[] |
|
|
173
|
+
> **prizes**: [`TournamentPrize`](TournamentPrize.md)[]
|
|
176
174
|
|
|
177
|
-
|
|
175
|
+
***
|
|
178
176
|
|
|
179
|
-
### tournamentPlayer
|
|
177
|
+
### tournamentPlayer?
|
|
180
178
|
|
|
181
|
-
|
|
179
|
+
> `optional` **tournamentPlayer?**: [`TournamentPlayer`](TournamentPlayer.md)
|
|
182
180
|
|
|
183
181
|
Information about current user
|
|
184
182
|
|
|
185
|
-
|
|
183
|
+
***
|
|
186
184
|
|
|
187
|
-
### related\_games
|
|
185
|
+
### related\_games?
|
|
188
186
|
|
|
189
|
-
|
|
187
|
+
> `optional` **related\_games?**: [`AchRelatedGame`](AchRelatedGame.md)[]
|
|
190
188
|
|
|
191
189
|
List of casino games (or other types of entities) related to the tournament
|
|
192
190
|
|
|
193
|
-
|
|
191
|
+
***
|
|
194
192
|
|
|
195
|
-
### minScoreToWin
|
|
193
|
+
### minScoreToWin?
|
|
196
194
|
|
|
197
|
-
|
|
195
|
+
> `optional` **minScoreToWin?**: `number`
|
|
198
196
|
|
|
199
197
|
The minimum amount of score points that the user should get in order to be qualified for the prize
|
|
200
198
|
|
|
201
|
-
|
|
199
|
+
***
|
|
202
200
|
|
|
203
|
-
### hideLeaderboardsMinScores
|
|
201
|
+
### hideLeaderboardsMinScores?
|
|
204
202
|
|
|
205
|
-
|
|
203
|
+
> `optional` **hideLeaderboardsMinScores?**: `boolean`
|
|
206
204
|
|
|
207
205
|
When enabled, users who don't meet the minimum qualifying score will be hidden from the Leaderboard.
|
|
208
206
|
|
|
209
|
-
|
|
207
|
+
***
|
|
210
208
|
|
|
211
|
-
### totalScores
|
|
209
|
+
### totalScores?
|
|
212
210
|
|
|
213
|
-
|
|
211
|
+
> `optional` **totalScores?**: `number`
|
|
214
212
|
|
|
215
213
|
Total scores across all participants in the tournament
|
|
214
|
+
|
|
215
|
+
***
|
|
216
|
+
|
|
217
|
+
### isClanBased?
|
|
218
|
+
|
|
219
|
+
> `optional` **isClanBased?**: `boolean`
|
|
220
|
+
|
|
221
|
+
Indicates if the tournament is clan-based
|