@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,38 +4,38 @@
|
|
|
4
4
|
|
|
5
5
|
### public\_username
|
|
6
6
|
|
|
7
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
39
|
+
> **is\_me**: `boolean`
|
|
40
40
|
|
|
41
41
|
The indicator if the participant is current user
|
|
@@ -4,48 +4,48 @@
|
|
|
4
4
|
|
|
5
5
|
### level\_id
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
> **level\_id**: `number`
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
***
|
|
10
10
|
|
|
11
11
|
### level\_public\_meta
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
> **level\_public\_meta**: [`LevelPublicMeta`](LevelPublicMeta.md)
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
***
|
|
16
16
|
|
|
17
17
|
### required\_points
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
> **required\_points**: `number`
|
|
20
20
|
|
|
21
|
-
|
|
21
|
+
***
|
|
22
22
|
|
|
23
23
|
### is\_first\_level
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
> **is\_first\_level**: `boolean`
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
***
|
|
28
28
|
|
|
29
29
|
### level\_status\_id
|
|
30
30
|
|
|
31
|
-
|
|
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
|
-
|
|
39
|
+
> **required\_level\_counter\_1**: `number`
|
|
40
40
|
|
|
41
|
-
|
|
41
|
+
***
|
|
42
42
|
|
|
43
43
|
### required\_level\_counter\_2
|
|
44
44
|
|
|
45
|
-
|
|
45
|
+
> **required\_level\_counter\_2**: `number`
|
|
46
46
|
|
|
47
|
-
|
|
47
|
+
***
|
|
48
48
|
|
|
49
49
|
### general\_level\_progress
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
> **general\_level\_progress**: `number`
|
|
@@ -2,58 +2,65 @@
|
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
|
-
### description
|
|
5
|
+
### description?
|
|
6
6
|
|
|
7
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
####
|
|
43
|
+
#### mx
|
|
44
44
|
|
|
45
|
-
|
|
46
|
-
| :------ | :------ |
|
|
47
|
-
| `mx` | `number` |
|
|
48
|
-
| `my` | `number` |
|
|
49
|
-
| `dx` | `number` |
|
|
50
|
-
| `dy` | `number` |
|
|
45
|
+
> **mx**: `number`
|
|
51
46
|
|
|
52
|
-
|
|
47
|
+
#### my
|
|
53
48
|
|
|
54
|
-
|
|
49
|
+
> **my**: `number`
|
|
55
50
|
|
|
56
|
-
|
|
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
|
-
##
|
|
5
|
+
## Extended by
|
|
6
6
|
|
|
7
|
-
-
|
|
8
|
-
|
|
9
|
-
↳ [`GamePickEventMeta`](GamePickEventMeta.md)
|
|
7
|
+
- [`GamePickEventMeta`](GamePickEventMeta.md)
|
|
10
8
|
|
|
11
9
|
## Properties
|
|
12
10
|
|
|
13
|
-
### answers
|
|
11
|
+
### answers?
|
|
14
12
|
|
|
15
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
##
|
|
3
|
+
## Extends
|
|
4
4
|
|
|
5
5
|
- `ProtocolMessage`
|
|
6
6
|
|
|
7
|
-
↳ **`RaffleClaimPrizeRequest`**
|
|
8
|
-
|
|
9
7
|
## Properties
|
|
10
8
|
|
|
11
9
|
### cid
|
|
12
10
|
|
|
13
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
41
|
+
> **won\_id**: `number`
|
|
@@ -1,57 +1,55 @@
|
|
|
1
1
|
# Interface: RaffleClaimPrizeResponse
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Extends
|
|
4
4
|
|
|
5
5
|
- `ProtocolResponse`
|
|
6
6
|
|
|
7
|
-
↳ **`RaffleClaimPrizeResponse`**
|
|
8
|
-
|
|
9
7
|
## Properties
|
|
10
8
|
|
|
11
9
|
### cid
|
|
12
10
|
|
|
13
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
51
|
+
> `optional` **errMsg?**: `string`
|
|
54
52
|
|
|
55
53
|
#### Overrides
|
|
56
54
|
|
|
57
|
-
ProtocolResponse.errMsg
|
|
55
|
+
`ProtocolResponse.errMsg`
|