@ughuuu/gamend 1.0.1240 → 1.0.1250
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/README.md +193 -123
- package/dist/ApiClient.js +1 -1
- package/dist/api/AdminAnalyticsApi.js +22 -21
- package/dist/api/AdminChatApi.js +97 -63
- package/dist/api/AdminEconomyApi.js +28 -23
- package/dist/api/AdminGroupsApi.js +14 -13
- package/dist/api/AdminKVApi.js +23 -22
- package/dist/api/AdminLeaderboardsApi.js +36 -34
- package/dist/api/AdminLobbiesApi.js +14 -13
- package/dist/api/AdminMatchmakingApi.js +14 -14
- package/dist/api/AdminNotificationsApi.js +14 -13
- package/dist/api/AdminPushApi.js +13 -14
- package/dist/api/AdminQuestsApi.js +43 -39
- package/dist/api/AdminReadyChecksApi.js +14 -13
- package/dist/api/AdminRetentionApi.js +9 -9
- package/dist/api/AdminSessionsApi.js +13 -12
- package/dist/api/AdminStorageApi.js +53 -12
- package/dist/api/AdminTournamentsApi.js +36 -33
- package/dist/api/AdminUsersApi.js +10 -9
- package/dist/api/AuthenticationApi.js +305 -57
- package/dist/api/ChatApi.js +25 -25
- package/dist/api/ClientLogsApi.js +9 -9
- package/dist/api/EconomyApi.js +14 -13
- package/dist/api/FriendsApi.js +27 -25
- package/dist/api/GroupsApi.js +58 -57
- package/dist/api/HealthApi.js +1 -1
- package/dist/api/HooksApi.js +28 -13
- package/dist/api/KVApi.js +6 -6
- package/dist/api/LeaderboardsApi.js +31 -32
- package/dist/api/LobbiesApi.js +26 -26
- package/dist/api/MatchmakingApi.js +21 -22
- package/dist/api/NotificationsApi.js +5 -5
- package/dist/api/PartiesApi.js +75 -54
- package/dist/api/PaymentsApi.js +57 -34
- package/dist/api/PushApi.js +8 -8
- package/dist/api/QuestsApi.js +22 -21
- package/dist/api/ReadyChecksApi.js +25 -24
- package/dist/api/SignalingApi.js +5 -5
- package/dist/api/StatsApi.js +5 -5
- package/dist/api/TimeApi.js +5 -5
- package/dist/api/TournamentsApi.js +58 -45
- package/dist/api/UsersApi.js +44 -39
- package/dist/index.js +1038 -604
- package/dist/model/AcceptPartyInviteRequest.js +1 -1
- package/dist/model/ActivityStats.js +159 -0
- package/dist/model/{AdminListChatMutes200ResponseDataInner.js → AdminChatMute.js} +77 -32
- package/dist/model/AdminChatMutePage.js +147 -0
- package/dist/model/AdminChatMuteResponse.js +115 -0
- package/dist/model/AdminClaimQuestRequest.js +1 -1
- package/dist/model/AdminCreateChatFilterWordRequest.js +1 -1
- package/dist/model/AdminCreateChatMuteRequest.js +1 -1
- package/dist/model/AdminCreateKvEntryRequest.js +3 -1
- package/dist/model/AdminCreateLeaderboardRequest.js +1 -1
- package/dist/model/AdminCreateNotificationRequest.js +1 -1
- package/dist/model/AdminCreateQuestRequest.js +1 -1
- package/dist/model/AdminCreateQuestRequestObjectivesInner.js +1 -1
- package/dist/model/AdminCreateQuestRequestRewardsInner.js +1 -1
- package/dist/model/AdminCreateTournamentRequest.js +1 -1
- package/dist/model/AdminGrantCurrencyRequest.js +1 -1
- package/dist/model/AdminGrantItemRequest.js +1 -1
- package/dist/model/AdminGrantQuestRequest.js +1 -1
- package/dist/model/AdminImportChatFilterWordsRequest.js +1 -1
- package/dist/model/AdminInventoryItem.js +161 -0
- package/dist/model/AdminInventoryItemPage.js +147 -0
- package/dist/model/{AdminUpsertKv200ResponseData.js → AdminKvEntry.js} +67 -29
- package/dist/model/{AdminListLobbies200Response.js → AdminKvEntryPage.js} +57 -34
- package/dist/model/AdminKvEntryResponse.js +115 -0
- package/dist/model/AdminLeaderboardIconUploadUrlRequest.js +1 -1
- package/dist/model/{AdminUpdateLeaderboardRecord200ResponseData.js → AdminLeaderboardRecord.js} +71 -28
- package/dist/model/AdminLeaderboardRecordResponse.js +115 -0
- package/dist/model/AdminLedgerEntry.js +195 -0
- package/dist/model/AdminLedgerEntryPage.js +147 -0
- package/dist/model/AdminMatchmakingStats.js +161 -0
- package/dist/model/AdminMatchmakingStatsResponse.js +115 -0
- package/dist/model/{AdminListMatchmakingTickets200ResponseDataInner.js → AdminMatchmakingTicket.js} +78 -33
- package/dist/model/{AdminListGroups200Response.js → AdminMatchmakingTicketPage.js} +57 -34
- package/dist/model/AdminMatchmakingTicketResponse.js +115 -0
- package/dist/model/{AdminListPushTokens200ResponseDataInner.js → AdminPushToken.js} +76 -50
- package/dist/model/AdminPushTokenPage.js +147 -0
- package/dist/model/{UserQuests200ResponseDataInner.js → AdminQuest.js} +146 -106
- package/dist/model/AdminQuestClaim.js +147 -0
- package/dist/model/AdminQuestClaimResponse.js +115 -0
- package/dist/model/AdminQuestIconUploadUrlRequest.js +1 -1
- package/dist/model/{AdminListNotifications200Response.js → AdminQuestPage.js} +57 -34
- package/dist/model/{AdminListQuestProgress200ResponseDataInner.js → AdminQuestProgress.js} +80 -34
- package/dist/model/AdminQuestProgressPage.js +147 -0
- package/dist/model/AdminQuestProgressResponse.js +115 -0
- package/dist/model/AdminQuestResponse.js +115 -0
- package/dist/model/{OpenLobbyReadyCheck201Response.js → AdminReadyCheck.js} +115 -63
- package/dist/model/AdminReadyCheckPage.js +147 -0
- package/dist/model/AdminReadyCheckResponse.js +115 -0
- package/dist/model/AdminResetQuestRequest.js +1 -1
- package/dist/model/AdminResolveChatReportRequest.js +1 -1
- package/dist/model/AdminResolveTournamentMatchRequest.js +1 -1
- package/dist/model/AdminSendPushRequest.js +1 -1
- package/dist/model/{AdminListSessions200ResponseDataInner.js → AdminSession.js} +87 -25
- package/dist/model/AdminSessionPage.js +147 -0
- package/dist/model/AdminSetLeaderboardIconRequest.js +1 -1
- package/dist/model/AdminSetQuestIconRequest.js +1 -1
- package/dist/model/AdminSetTournamentIconRequest.js +1 -1
- package/dist/model/AdminSpendCurrencyRequest.js +1 -1
- package/dist/model/AdminSubmitLeaderboardScoreRequest.js +1 -1
- package/dist/model/AdminTestChatPhraseRequest.js +1 -1
- package/dist/model/{AdminDrawTournament200ResponseData.js → AdminTournament.js} +101 -42
- package/dist/model/AdminTournamentIconUploadUrlRequest.js +1 -1
- package/dist/model/AdminTournamentResponse.js +115 -0
- package/dist/model/AdminUpdateChatFilterWordRequest.js +1 -1
- package/dist/model/AdminUpdateGroupRequest.js +1 -1
- package/dist/model/AdminUpdateKvEntryRequest.js +3 -1
- package/dist/model/AdminUpdateLeaderboardRecordRequest.js +1 -1
- package/dist/model/AdminUpdateLeaderboardRequest.js +1 -1
- package/dist/model/AdminUpdateLobbyRequest.js +1 -1
- package/dist/model/AdminUpdateQuestRequest.js +1 -1
- package/dist/model/AdminUpdateTournamentRequest.js +1 -1
- package/dist/model/AdminUpdateUserRequest.js +1 -1
- package/dist/model/AdminUpsertKvRequest.js +3 -1
- package/dist/model/{AdminUpdateUser200ResponseData.js → AdminUser.js} +94 -31
- package/dist/model/AdminUserResponse.js +115 -0
- package/dist/model/AdminWallet.js +151 -0
- package/dist/model/{ListLeaderboards200Response.js → AdminWalletPage.js} +57 -34
- package/dist/model/{AdminGetAnalyticsCounts200Response.js → AnalyticsCounts.js} +62 -34
- package/dist/model/AnalyticsCountsResponse.js +115 -0
- package/dist/model/{AdminGetAnalyticsDaily200Response.js → AnalyticsDaily.js} +53 -31
- package/dist/model/AnalyticsDailyResponse.js +115 -0
- package/dist/model/AnalyticsDay.js +159 -0
- package/dist/model/{AdminGetAnalyticsEconomy200Response.js → AnalyticsEconomy.js} +66 -43
- package/dist/model/AnalyticsEconomyResponse.js +115 -0
- package/dist/model/{AdminGetAnalyticsSummary200Response.js → AnalyticsSummary.js} +81 -36
- package/dist/model/AnalyticsSummaryResponse.js +115 -0
- package/dist/model/AuthProvidersResponse.js +1 -1
- package/dist/model/BlockedFriendship.js +1 -1
- package/dist/model/BlockedFriendshipPage.js +1 -1
- package/dist/model/CallHookRequest.js +1 -1
- package/dist/model/CancelPartyInviteRequest.js +1 -1
- package/dist/model/CancelledCount.js +109 -0
- package/dist/model/CancelledCountResponse.js +115 -0
- package/dist/model/ChatFilterHit.js +182 -0
- package/dist/model/ChatFilterLanguages.js +114 -0
- package/dist/model/ChatFilterLanguagesResponse.js +115 -0
- package/dist/model/{AdminTestChatPhrase200ResponseData.js → ChatFilterTest.js} +65 -36
- package/dist/model/ChatFilterTestResponse.js +115 -0
- package/dist/model/{AdminUpdateChatFilterWord200ResponseData.js → ChatFilterWord.js} +66 -30
- package/dist/model/ChatFilterWordPage.js +147 -0
- package/dist/model/ChatFilterWordResponse.js +115 -0
- package/dist/model/ChatMessage.js +1 -1
- package/dist/model/ChatMessagePage.js +1 -1
- package/dist/model/{OAuthResultResponse.js → ChatMessageResponse.js} +26 -26
- package/dist/model/ChatMuteRecord.js +1 -1
- package/dist/model/ChatMuteRecordPage.js +1 -1
- package/dist/model/ChatMuteRecordResponse.js +1 -1
- package/dist/model/ChatReadCursor.js +1 -1
- package/dist/model/ChatReadCursorResponse.js +115 -0
- package/dist/model/{AdminResolveChatReport200ResponseData.js → ChatReport.js} +89 -36
- package/dist/model/{ListLeaderboardRecords200Response.js → ChatReportPage.js} +57 -34
- package/dist/model/ChatReportResponse.js +115 -0
- package/dist/model/ChatUnread.js +1 -1
- package/dist/model/ChatUnreadResponse.js +1 -1
- package/dist/model/ClientLogBatch.js +1 -1
- package/dist/model/ClientLogEntry.js +1 -1
- package/dist/model/ClientLogPolicy.js +1 -1
- package/dist/model/ClientLogPolicyResponse.js +115 -0
- package/dist/model/ClientLogResult.js +1 -1
- package/dist/model/ClientLogResultResponse.js +115 -0
- package/dist/model/ClientLogSession.js +1 -1
- package/dist/model/{AvatarUpdate.js → CounterTotal.js} +35 -36
- package/dist/model/CreateCurrentUserAvatarUploadUrlRequest.js +1 -1
- package/dist/model/CreateFriendRequestRequest.js +1 -1
- package/dist/model/CreateGroupIconUploadUrlRequest.js +1 -1
- package/dist/model/CreateGroupRequest.js +1 -1
- package/dist/model/CreateLobbyRequest.js +1 -1
- package/dist/model/CreatePartyRequest.js +1 -1
- package/dist/model/CurrentUser.js +1 -1
- package/dist/model/CurrentUserResponse.js +115 -0
- package/dist/model/DeclinePartyInviteRequest.js +1 -1
- package/dist/model/{AdminSendPush200Response.js → DeleteCurrentUserRequest.js} +24 -23
- package/dist/model/DeleteNotificationsRequest.js +1 -1
- package/dist/model/DeletedCount.js +1 -1
- package/dist/model/DeletedCountResponse.js +1 -1
- package/dist/model/DemoteGroupMemberRequest.js +1 -1
- package/dist/model/DeviceLoginRequest.js +1 -1
- package/dist/model/EconomyFlowDay.js +167 -0
- package/dist/model/EconomyTotal.js +167 -0
- package/dist/model/Entitlement.js +213 -0
- package/dist/model/EntitlementPage.js +147 -0
- package/dist/model/ErrorResponse.js +4 -26
- package/dist/model/Friend.js +1 -1
- package/dist/model/FriendPage.js +1 -1
- package/dist/model/FriendRequest.js +1 -1
- package/dist/model/FriendRequestLists.js +1 -1
- package/dist/model/FriendRequestMeta.js +1 -1
- package/dist/model/FriendRequestResponse.js +115 -0
- package/dist/model/FriendRequestsResponse.js +1 -1
- package/dist/model/Group.js +1 -1
- package/dist/model/GroupInvite.js +13 -14
- package/dist/model/GroupInviteOutcome.js +132 -0
- package/dist/model/GroupInviteOutcomeResponse.js +115 -0
- package/dist/model/GroupInvitePage.js +1 -1
- package/dist/model/GroupJoinRequest.js +1 -1
- package/dist/model/GroupJoinRequestPage.js +1 -1
- package/dist/model/GroupJoinRequestResponse.js +115 -0
- package/dist/model/GroupMember.js +1 -1
- package/dist/model/GroupMemberPage.js +1 -1
- package/dist/model/GroupMemberResponse.js +115 -0
- package/dist/model/GroupPage.js +1 -1
- package/dist/model/GroupResponse.js +115 -0
- package/dist/model/{StatusResponse.js → Health.js} +35 -23
- package/dist/model/HealthResponse.js +17 -31
- package/dist/model/HookCallResponse.js +110 -0
- package/dist/model/HookFunction.js +196 -0
- package/dist/model/HookFunctionPage.js +147 -0
- package/dist/model/HookSignature.js +154 -0
- package/dist/model/ImportedCount.js +109 -0
- package/dist/model/ImportedCountResponse.js +115 -0
- package/dist/model/InventoryResponse.js +112 -0
- package/dist/model/InviteToGroupRequest.js +1 -1
- package/dist/model/InviteToPartyRequest.js +1 -1
- package/dist/model/ItemQuantity.js +137 -0
- package/dist/model/ItemQuantityResponse.js +115 -0
- package/dist/model/JoinLobbyRequest.js +1 -1
- package/dist/model/KickGroupMemberRequest.js +1 -1
- package/dist/model/KickPartyMemberRequest.js +1 -1
- package/dist/model/KickUserRequest.js +1 -1
- package/dist/model/KvEntry.js +164 -0
- package/dist/model/KvEntryResponse.js +115 -0
- package/dist/model/{ResolveLeaderboardSlugs200ResponseDataValue.js → Leaderboard.js} +90 -45
- package/dist/model/LeaderboardPage.js +147 -0
- package/dist/model/{GetMyRecord200ResponseData.js → LeaderboardRecord.js} +66 -31
- package/dist/model/{UserQuests200Response.js → LeaderboardRecordPage.js} +57 -34
- package/dist/model/LeaderboardRecordResponse.js +115 -0
- package/dist/model/LeaderboardResponse.js +115 -0
- package/dist/model/LeaderboardsBySlugResponse.js +113 -0
- package/dist/model/{ListCurrentUserLedger200ResponseDataInner.js → LedgerEntry.js} +65 -26
- package/dist/model/LedgerEntryPage.js +147 -0
- package/dist/model/LinkAppleIosRequest.js +113 -0
- package/dist/model/LinkDeviceRequest.js +1 -1
- package/dist/model/LinkGoogleIdTokenRequest.js +113 -0
- package/dist/model/LinkProviderRequest.js +113 -0
- package/dist/model/LinkedProviders.js +1 -1
- package/dist/model/Lobby.js +1 -1
- package/dist/model/LobbyPage.js +1 -1
- package/dist/model/LobbyResponse.js +6 -49
- package/dist/model/LobbyStats.js +1 -1
- package/dist/model/LobbyStatsResponse.js +1 -1
- package/dist/model/LoginRequest.js +1 -1
- package/dist/model/MarkChatReadRequest.js +1 -1
- package/dist/model/MatchmakingJoinRequest.js +1 -1
- package/dist/model/MatchmakingQueue.js +121 -0
- package/dist/model/{MatchmakingStats200ResponseData.js → MatchmakingStats.js} +53 -30
- package/dist/model/MatchmakingStatsResponse.js +115 -0
- package/dist/model/{MatchmakingJoin201ResponseData.js → MatchmakingTicket.js} +75 -33
- package/dist/model/MatchmakingTicketResponse.js +115 -0
- package/dist/model/MuteGroupMemberRequest.js +1 -1
- package/dist/model/MuteLobbyMemberRequest.js +1 -1
- package/dist/model/MutePartyMemberRequest.js +1 -1
- package/dist/model/MyReadyChecks.js +132 -0
- package/dist/model/MyReadyChecksResponse.js +115 -0
- package/dist/model/Notification.js +1 -1
- package/dist/model/NotificationPage.js +1 -1
- package/dist/model/NotificationResponse.js +115 -0
- package/dist/model/OAuthAuthorization.js +1 -1
- package/dist/model/OAuthAuthorizationResponse.js +115 -0
- package/dist/model/OAuthSessionStatus.js +38 -27
- package/dist/model/OAuthSessionStatusResponse.js +115 -0
- package/dist/model/OauthApiCallbackRequest.js +29 -6
- package/dist/model/OauthCallbackApiAppleIosRequest.js +1 -1
- package/dist/model/OauthGoogleIdTokenRequest.js +1 -1
- package/dist/model/OkResponse.js +1 -1
- package/dist/model/OpenLobbyReadyCheckRequest.js +1 -1
- package/dist/model/OpenPartyReadyCheckRequest.js +1 -1
- package/dist/model/PageMeta.js +1 -1
- package/dist/model/Party.js +1 -1
- package/dist/model/PartyCreateLobbyRequest.js +1 -1
- package/dist/model/PartyInvite.js +1 -1
- package/dist/model/PartyInvitePage.js +147 -0
- package/dist/model/PartyJoinLobbyRequest.js +1 -1
- package/dist/model/PartyResponse.js +115 -0
- package/dist/model/PartyStats.js +1 -1
- package/dist/model/PartyStatsResponse.js +1 -1
- package/dist/model/PaymentCatalogEntry.js +195 -0
- package/dist/model/{AdminListChatFilterWords200Response.js → PaymentCatalogEntryPage.js} +56 -45
- package/dist/model/PaymentProduct.js +180 -0
- package/dist/model/PaymentWebhookReceipt.js +137 -0
- package/dist/model/PaymentWebhookReceiptResponse.js +115 -0
- package/dist/model/PaymentsSteamCheckoutRequest.js +1 -1
- package/dist/model/PaymentsSteamFinalizeRequest.js +1 -1
- package/dist/model/PaymentsStripeCheckoutRequest.js +1 -1
- package/dist/model/PlayerStats.js +1 -1
- package/dist/model/PlayerStatsResponse.js +1 -1
- package/dist/model/PromoteGroupMemberRequest.js +1 -1
- package/dist/model/ProviderLinkStatus.js +181 -0
- package/dist/model/ProviderLinkStatusResponse.js +115 -0
- package/dist/model/PublicUser.js +5 -35
- package/dist/model/PublicUserPage.js +1 -1
- package/dist/model/PublicUserResponse.js +115 -0
- package/dist/model/Purchase.js +279 -0
- package/dist/model/PurchaseResponse.js +115 -0
- package/dist/model/PurchaseValidation.js +126 -0
- package/dist/model/PurchaseValidationResponse.js +115 -0
- package/dist/model/PushToken.js +1 -1
- package/dist/model/PushTokenPage.js +1 -1
- package/dist/model/PushTokenResponse.js +115 -0
- package/dist/model/{AdminListQuests200ResponseDataInner.js → Quest.js} +194 -73
- package/dist/model/{ClaimQuest200ResponseData.js → QuestClaim.js} +58 -35
- package/dist/model/QuestClaimResponse.js +115 -0
- package/dist/model/QuestFunnelResponse.js +112 -0
- package/dist/model/QuestObjective.js +136 -0
- package/dist/model/{AdminListChatMessages200Response.js → QuestPage.js} +57 -34
- package/dist/model/{UserQuests200ResponseDataInnerProgress.js → QuestProgress.js} +67 -31
- package/dist/model/QuestReward.js +157 -0
- package/dist/model/QuestStats.js +129 -0
- package/dist/model/QuestStatsResponse.js +115 -0
- package/dist/model/QuickJoinRequest.js +1 -1
- package/dist/model/ReadyCheckOutcomesResponse.js +112 -0
- package/dist/model/ReadyCheckParticipant.js +179 -0
- package/dist/model/{GetMyReadyCheck200ResponseParty.js → ReadyCheckState.js} +119 -42
- package/dist/model/ReadyCheckStateResponse.js +115 -0
- package/dist/model/RefreshTokenRequest.js +1 -1
- package/dist/model/RegisterPushTokenRequest.js +1 -1
- package/dist/model/{ProfileUpdate.js → RegisterRequest.js} +40 -49
- package/dist/model/ReportChatMessageRequest.js +1 -1
- package/dist/model/ResolveLeaderboardSlugsRequest.js +1 -1
- package/dist/model/RespondReadyCheckRequest.js +1 -1
- package/dist/model/RetentionStatus.js +133 -0
- package/dist/model/RetentionStatusResponse.js +115 -0
- package/dist/model/SendChatMessageRequest.js +1 -1
- package/dist/model/SendNotificationRequest.js +1 -1
- package/dist/model/ServerStats.js +227 -0
- package/dist/model/ServerStatsResponse.js +115 -0
- package/dist/model/ServerTime.js +110 -0
- package/dist/model/ServerTimeResponse.js +115 -0
- package/dist/model/Session.js +1 -1
- package/dist/model/SessionResponse.js +1 -1
- package/dist/model/SetCurrentUserAvatarRequest.js +1 -1
- package/dist/model/SetGroupIconRequest.js +1 -1
- package/dist/model/SetLobbyStateRequest.js +1 -1
- package/dist/model/SignalingStats.js +131 -0
- package/dist/model/SignalingStatsResponse.js +115 -0
- package/dist/model/SteamCheckout.js +144 -0
- package/dist/model/SteamCheckoutResponse.js +115 -0
- package/dist/model/StorageObject.js +134 -0
- package/dist/model/StorageObjectPage.js +147 -0
- package/dist/model/StorageObjectResponse.js +115 -0
- package/dist/model/{UnmuteResult.js → StorageUsage.js} +33 -34
- package/dist/model/StorageUsageResponse.js +115 -0
- package/dist/model/StripeCheckout.js +143 -0
- package/dist/model/StripeCheckoutResponse.js +115 -0
- package/dist/model/{ListTournaments200ResponseDataInner.js → Tournament.js} +111 -41
- package/dist/model/TournamentBracket.js +186 -0
- package/dist/model/TournamentBracketPage.js +147 -0
- package/dist/model/TournamentEntry.js +211 -0
- package/dist/model/TournamentEntryPage.js +147 -0
- package/dist/model/TournamentEntryResponse.js +115 -0
- package/dist/model/{TournamentMyMatch200Response.js → TournamentMatch.js} +105 -28
- package/dist/model/TournamentMatchCounts.js +129 -0
- package/dist/model/TournamentMatchResponse.js +115 -0
- package/dist/model/{AdminListMatchmakingTickets200Response.js → TournamentPage.js} +57 -34
- package/dist/model/TournamentPlacement.js +200 -0
- package/dist/model/TournamentResponse.js +115 -0
- package/dist/model/TournamentStandings.js +163 -0
- package/dist/model/TournamentStandingsResponse.js +115 -0
- package/dist/model/TournamentStats.js +141 -0
- package/dist/model/UnmuteGroupMemberRequest.js +1 -1
- package/dist/model/UnmuteLobbyMemberRequest.js +1 -1
- package/dist/model/UnmutePartyMemberRequest.js +1 -1
- package/dist/model/UpdateChatMessageRequest.js +1 -1
- package/dist/model/UpdateCurrentUserDisplayNameRequest.js +1 -1
- package/dist/model/UpdateCurrentUserPasswordRequest.js +1 -1
- package/dist/model/UpdateCurrentUserUsernameRequest.js +1 -1
- package/dist/model/UpdateGroupRequest.js +1 -1
- package/dist/model/UpdateLobbyRequest.js +1 -1
- package/dist/model/UpdatePartyRequest.js +1 -1
- package/dist/model/UploadTicket.js +1 -1
- package/dist/model/UploadTicketResponse.js +115 -0
- package/dist/model/UserBrief.js +1 -1
- package/dist/model/UserBriefPage.js +1 -1
- package/dist/model/WalletBalance.js +137 -0
- package/dist/model/WalletBalanceResponse.js +115 -0
- package/dist/model/WalletBalancesResponse.js +112 -0
- package/package.json +1 -1
- package/dist/model/AdminCancelMatchmakingTicket200Response.js +0 -91
- package/dist/model/AdminCancelReadyCheck200Response.js +0 -91
- package/dist/model/AdminCancelReadyCheck200ResponseData.js +0 -223
- package/dist/model/AdminConsumeItem400Response.js +0 -89
- package/dist/model/AdminCreateChatMute200Response.js +0 -91
- package/dist/model/AdminCreateLeaderboard200Response.js +0 -91
- package/dist/model/AdminCreateLeaderboard200ResponseData.js +0 -248
- package/dist/model/AdminDeleteChatConversation200Response.js +0 -91
- package/dist/model/AdminDeleteChatConversation200ResponseData.js +0 -85
- package/dist/model/AdminDeleteChatFilterWordsByLang200Response.js +0 -93
- package/dist/model/AdminDrawTournament200Response.js +0 -91
- package/dist/model/AdminGetAnalyticsCounts200ResponseTotalsInner.js +0 -97
- package/dist/model/AdminGetAnalyticsDaily200ResponseSeriesInner.js +0 -128
- package/dist/model/AdminGetAnalyticsEconomy200ResponseFlowInner.js +0 -133
- package/dist/model/AdminGetAnalyticsEconomy200ResponseTotalsInner.js +0 -133
- package/dist/model/AdminImportChatFilterWords200Response.js +0 -93
- package/dist/model/AdminListChatMessages200ResponseDataInner.js +0 -213
- package/dist/model/AdminListChatMutes200Response.js +0 -124
- package/dist/model/AdminListChatReports200Response.js +0 -124
- package/dist/model/AdminListKvEntries200Response.js +0 -124
- package/dist/model/AdminListLobbies200ResponseDataInner.js +0 -191
- package/dist/model/AdminListNotifications200ResponseDataInner.js +0 -173
- package/dist/model/AdminListPushTokens200Response.js +0 -118
- package/dist/model/AdminListQuestProgress200Response.js +0 -118
- package/dist/model/AdminListQuests200Response.js +0 -118
- package/dist/model/AdminListReadyChecks200Response.js +0 -124
- package/dist/model/AdminListSessions200Response.js +0 -124
- package/dist/model/AdminListStorageObjects200Response.js +0 -132
- package/dist/model/AdminListStorageObjects200ResponseDataInner.js +0 -105
- package/dist/model/AdminListStorageObjects200ResponseUsage.js +0 -93
- package/dist/model/AdminMatchmakingStats200Response.js +0 -91
- package/dist/model/AdminMatchmakingStats200ResponseData.js +0 -113
- package/dist/model/AdminResolveChatReport200Response.js +0 -91
- package/dist/model/AdminRunRetention200Response.js +0 -104
- package/dist/model/AdminTestChatPhrase200Response.js +0 -91
- package/dist/model/AdminTestChatPhrase200ResponseDataHitsInner.js +0 -113
- package/dist/model/AdminUpdateChatFilterWord200Response.js +0 -91
- package/dist/model/AdminUpdateGroup200Response.js +0 -199
- package/dist/model/AdminUpdateLeaderboardRecord200Response.js +0 -91
- package/dist/model/AdminUpdateLobby200Response.js +0 -91
- package/dist/model/AdminUpdateUser200Response.js +0 -91
- package/dist/model/AdminUpsertKv200Response.js +0 -91
- package/dist/model/CallHook200Response.js +0 -88
- package/dist/model/ClaimQuest200Response.js +0 -91
- package/dist/model/GetCurrentUserInventory200Response.js +0 -87
- package/dist/model/GetKv200Response.js +0 -93
- package/dist/model/GetMyReadyCheck200Response.js +0 -105
- package/dist/model/GetMyReadyCheck200ResponseLobby.js +0 -257
- package/dist/model/GetMyRecord200Response.js +0 -91
- package/dist/model/GetServerTime200Response.js +0 -86
- package/dist/model/GetStats200Response.js +0 -91
- package/dist/model/GetStats200ResponseData.js +0 -151
- package/dist/model/ListCurrentUserLedger200Response.js +0 -118
- package/dist/model/ListRecordsAroundUser200Response.js +0 -110
- package/dist/model/ListTournaments200Response.js +0 -110
- package/dist/model/MatchmakingCancel200Response.js +0 -85
- package/dist/model/MatchmakingJoin201Response.js +0 -91
- package/dist/model/MatchmakingMyTicket200Response.js +0 -91
- package/dist/model/MatchmakingMyTicket200ResponseData.js +0 -186
- package/dist/model/MatchmakingStats200Response.js +0 -91
- package/dist/model/MatchmakingStats200ResponseDataQueuesInner.js +0 -93
- package/dist/model/OAuthResult.js +0 -148
- package/dist/model/OAuthSessionData.js +0 -153
- package/dist/model/OAuthSessionDataDetails.js +0 -128
- package/dist/model/QuestStats200Response.js +0 -91
- package/dist/model/QuestStats200ResponseData.js +0 -101
- package/dist/model/ResolveLeaderboardSlugs200Response.js +0 -89
- package/dist/model/SignalingStats200Response.js +0 -91
- package/dist/model/SignalingStats200ResponseData.js +0 -101
- package/dist/model/UserQuests200ResponseDataInnerObjectivesInner.js +0 -108
- package/dist/model/UserQuests200ResponseDataInnerRewardsInner.js +0 -130
- package/dist/model/UserQuests200ResponseMeta.js +0 -125
|
@@ -5,13 +5,16 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
|
-
var _AdminConsumeItem400Response = _interopRequireDefault(require("../model/AdminConsumeItem400Response"));
|
|
9
8
|
var _AdminCreateTournamentRequest = _interopRequireDefault(require("../model/AdminCreateTournamentRequest"));
|
|
10
|
-
var _AdminDrawTournament200Response = _interopRequireDefault(require("../model/AdminDrawTournament200Response"));
|
|
11
9
|
var _AdminResolveTournamentMatchRequest = _interopRequireDefault(require("../model/AdminResolveTournamentMatchRequest"));
|
|
12
10
|
var _AdminSetTournamentIconRequest = _interopRequireDefault(require("../model/AdminSetTournamentIconRequest"));
|
|
13
11
|
var _AdminTournamentIconUploadUrlRequest = _interopRequireDefault(require("../model/AdminTournamentIconUploadUrlRequest"));
|
|
12
|
+
var _AdminTournamentResponse = _interopRequireDefault(require("../model/AdminTournamentResponse"));
|
|
14
13
|
var _AdminUpdateTournamentRequest = _interopRequireDefault(require("../model/AdminUpdateTournamentRequest"));
|
|
14
|
+
var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
|
|
15
|
+
var _OkResponse = _interopRequireDefault(require("../model/OkResponse"));
|
|
16
|
+
var _TournamentMatchResponse = _interopRequireDefault(require("../model/TournamentMatchResponse"));
|
|
17
|
+
var _UploadTicketResponse = _interopRequireDefault(require("../model/UploadTicketResponse"));
|
|
15
18
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
16
19
|
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
|
|
17
20
|
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
@@ -22,7 +25,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
22
25
|
* Gamend API
|
|
23
26
|
* API for Gamend. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, quests, leaderboards, tournaments, matchmaking, payments, server scripting, and admin portal. ## **1. Authentication** This API uses JWT (JSON Web Tokens) with access and refresh tokens: ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ``` ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token. ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights: - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported ## **3. Friends** The Friends domain offers lightweight social features: - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights: - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated ## **5. Notifications** Persistent user-to-user notifications that survive across sessions: - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect - **Push delivery**: notifications also fan out to the recipient's registered mobile devices (see Push notifications) ## **5b. Push notifications** Mobile/web push delivery to registered devices (FCM for Android/Web, APNs-direct for iOS): - **Register device tokens** via `POST /me/push_tokens` (`token`, `platform`, optional `provider`/`device_id`); re-registering a `device_id` rotates its token in place - **List/remove own devices** via `GET /me/push_tokens` and `DELETE /me/push_tokens/:id` - **Server-authoritative sending** — no public send endpoint; pushes originate from server hooks (`Gamend.Push.send_to_user/2`) or the admin API - **Per-token routing**: each token's `provider` (\"fcm\" | \"apns\") selects the delivery backend; unconfigured backends log instead of sending (dev-friendly) - **Reliability**: delivery rides the durable job queue with retries; dead tokens reported by the provider are disabled automatically ## **6. Groups** Groups provide persistent community management for players: - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"` ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads): - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel ## **8. Chat** Real-time messaging across multiple conversation types: - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation is built in**: an admin-managed word filter (`block` / `mask` / `flag`, matched on a normalized form so leetspeak and padding do not slip through) and mutes are enforced before a message is stored or broadcast; the `before_chat_message` pipeline hook stays available for rules of your own - **Report a message**: `POST /chat/messages/:id/report` with an optional `reason` — one report per player per message, capped per day; reports the filter files itself have no reporter - **Scoped mutes** mirror kick: `POST /lobbies/mute` + `/lobbies/unmute` (lobby host), `POST /groups/:id/mute` + `/groups/:id/unmute` (group admin), `POST /parties/mute` + `/parties/unmute` (party leader), each with a paginated `.../mutes` listing for the same authority. Body is `{target_user_id, expires_at?, reason?}`; omitting `expires_at` mutes permanently - **Global mutes and the blocklist are server-authoritative** — no public endpoint; admin API (`/api/v1/admin/chat`) or a plugin calling `Gamend.Chat.mute_user/4` - **Real-time moderation events**: the muted player receives `chat_muted` / `chat_unmuted` on their user channel ## **9. Leaderboards** Server-managed ranked scoreboards: - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings: - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata ## **11. Quests / Progression** One event-driven progression engine covering achievements, daily/weekly quests, time-boxed event quests, chains, and groups: - **Kinds**: `achievement` (permanent one-shot — the replacement for the old achievements system), `daily`/`weekly` (reset per UTC period), `event` (starts_at/ends_at window), `chain` (requires a prerequisite quest) - **Objectives**: each quest lists objectives `{event, target, params}`; server-side `report_event` advances every matching active quest — there is **no public endpoint to advance progress** (server-authoritative) - **Rewards**: currencies (Economy) and items (Inventory), paid **exactly once** per period via idempotent grants; `auto_claim` quests pay on completion, others via `POST /me/quests/:key/claim` - **My quests**: `GET /me/quests` returns active quests, per-period progress, and a claimable flag; hidden quests appear once completed - **Groups**: quests sharing a `group_key` collapse to one entry carrying `group_size`; `?group=<key>` lists that group's members in full - **Catalog**: `GET /quests` and per-user completions `GET /quests/user/:user_id` (gated by `GAMEND_FEATURES_LIST_QUESTS`) - **Admin management**: definitions CRUD plus per-user grant/reset/force-claim under `/api/v1/admin/quests` ## **12. Tournaments** Single-elimination bracket tournaments, server-structured and game-judged: - **Registration window → seeded draw → timed rounds → champions**; recurring tournaments (cron) create one occurrence per cycle sharing a slug; a nil starts_at keeps registration open until an admin draws manually - **Join/leave** as an entry leader (`POST`/`DELETE /tournaments/:id/join`); team composition is game policy - **Browse**: list/filter tournaments, standings, full bracket view, and the caller's current match (`GET /tournaments/:id/my_match`) - **Match verdicts are server-side** (game hooks) — no public resolve endpoint; clients get `tournament_match_ready` / `tournament_match_resolved` / `tournament_updated` / `tournament_finished` on the user channel - **Admin management** over HTTP: create/update/delete, cancel, draw now, finish, and force match verdicts under `/api/v1/admin/tournaments` ## **13. Matchmaking** Ticket-based queueing that turns waiting players into hidden, locked lobbies: - **Join over HTTP** (`POST /matchmaking/tickets` with a `match_params` string map); only tickets with identical params match together — encode mode/map/skill band as parameter values - **A match forms** when a group reaches `max_players`, or has at least `min_players` and the oldest ticket outwaited the timeout; the server creates a hidden lobby, seats everyone and locks it - **The result is a push, not a poll**: matched players receive `match_found` (`lobby_id`, `match_params`) on their user channel; disconnecting cancels your tickets - **Inspect**: `GET /matchmaking/tickets/me` for your ticket, `GET /matchmaking/stats` for queue depths - **Admin management** over HTTP: list/filter tickets, force-cancel, and stats under `/api/v1/admin/matchmaking` ## **14. Ready checks** One primitive for \"everyone must answer before this proceeds\", with one client-facing surface: - **A player holds at most one check per lane** — the match lane (lobby ready-up or matchmaking accept) and the party lane (the party's standing board) — so answering needs no id: `GET /me/ready_check` returns `{\"lobby\": …, \"party\": …}` (each null when none) and `POST /me/ready_check` with `{\"ready\": true|false, \"scope\": \"lobby\"|\"party\"}` answers one (scope defaults to `lobby`) - **Two kinds.** `ready` (lobby/party board) is a toggle — a \"no\" just leaves the check open, and it lists every participant. `accept` (match confirmation) is final — one decline fails it for everyone — and returns counts plus your own state, so a pending match does not reveal who you were paired with - **Hosts open one** with `POST /lobbies/ready_check` (host-managed lobbies only; hostless matchmaking lobbies belong to the server), **party leaders** with `POST /parties/ready_check`; either call is a **reset** — it quietly replaces an already-open board with a fresh one over the current members, so the same endpoint serves \"ready check!\", \"force ready\" (with `timeout_ms`) and \"start over\". Call it off with `DELETE /lobbies/ready_check` / `DELETE /parties/ready_check`. The opener is pre-marked ready — clicking the button is their answer - **Failure does nothing on its own**: a declined or timed-out check kicks nobody, starts nothing, and moves no lobby state. It reports who did not answer, and the game (or the host, with the kick they already have) decides - **Live**: `ready_check_started` / `ready_check_updated` / `ready_check_passed` / `ready_check_failed` on the lobby channel, the party channel for a party board, or the user channel for an accept check - **Admin management** over HTTP: list/filter checks, force-cancel, and 24h outcome stats under `/api/v1/admin/ready_checks` ## **15. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates. ### **15.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ``` ### **15.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, quest progress/completions/claims, party/group invites, tournament events, chat mutes (`chat_muted` / `chat_unmuted`), KV subscriptions - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat ### **15.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/gamend' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` `phoenix` ships as a dependency of the package, so no extra install is needed. ## **16. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients). ### **16.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency ### **16.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **16.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/gamend' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, { onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ```
|
|
24
27
|
*
|
|
25
|
-
* The version of the OpenAPI document: 1.0.
|
|
28
|
+
* The version of the OpenAPI document: 1.0.1250
|
|
26
29
|
*
|
|
27
30
|
*
|
|
28
31
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -51,7 +54,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
51
54
|
/**
|
|
52
55
|
* Cancel tournament (admin; terminal, no recurrence spawn)
|
|
53
56
|
* @param {String} id
|
|
54
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
57
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminTournamentResponse} and HTTP response
|
|
55
58
|
*/
|
|
56
59
|
return _createClass(AdminTournamentsApi, [{
|
|
57
60
|
key: "adminCancelTournamentWithHttpInfo",
|
|
@@ -70,14 +73,14 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
70
73
|
var authNames = ['authorization'];
|
|
71
74
|
var contentTypes = [];
|
|
72
75
|
var accepts = ['application/json'];
|
|
73
|
-
var returnType =
|
|
76
|
+
var returnType = _AdminTournamentResponse["default"];
|
|
74
77
|
return this.apiClient.callApi('/api/v1/admin/tournaments/{id}/cancel', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
75
78
|
}
|
|
76
79
|
|
|
77
80
|
/**
|
|
78
81
|
* Cancel tournament (admin; terminal, no recurrence spawn)
|
|
79
82
|
* @param {String} id
|
|
80
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
83
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminTournamentResponse}
|
|
81
84
|
*/
|
|
82
85
|
}, {
|
|
83
86
|
key: "adminCancelTournament",
|
|
@@ -91,7 +94,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
91
94
|
* Create tournament (admin)
|
|
92
95
|
* @param {Object} opts Optional parameters
|
|
93
96
|
* @param {module:model/AdminCreateTournamentRequest} [adminCreateTournamentRequest] Tournament
|
|
94
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
97
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminTournamentResponse} and HTTP response
|
|
95
98
|
*/
|
|
96
99
|
}, {
|
|
97
100
|
key: "adminCreateTournamentWithHttpInfo",
|
|
@@ -105,7 +108,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
105
108
|
var authNames = ['authorization'];
|
|
106
109
|
var contentTypes = ['application/json'];
|
|
107
110
|
var accepts = ['application/json'];
|
|
108
|
-
var returnType =
|
|
111
|
+
var returnType = _AdminTournamentResponse["default"];
|
|
109
112
|
return this.apiClient.callApi('/api/v1/admin/tournaments', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
110
113
|
}
|
|
111
114
|
|
|
@@ -113,7 +116,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
113
116
|
* Create tournament (admin)
|
|
114
117
|
* @param {Object} opts Optional parameters
|
|
115
118
|
* @param {module:model/AdminCreateTournamentRequest} opts.adminCreateTournamentRequest Tournament
|
|
116
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
119
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminTournamentResponse}
|
|
117
120
|
*/
|
|
118
121
|
}, {
|
|
119
122
|
key: "adminCreateTournament",
|
|
@@ -126,7 +129,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
126
129
|
/**
|
|
127
130
|
* Delete tournament and all its entries/matches (admin)
|
|
128
131
|
* @param {String} id
|
|
129
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
132
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OkResponse} and HTTP response
|
|
130
133
|
*/
|
|
131
134
|
}, {
|
|
132
135
|
key: "adminDeleteTournamentWithHttpInfo",
|
|
@@ -145,14 +148,14 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
145
148
|
var authNames = ['authorization'];
|
|
146
149
|
var contentTypes = [];
|
|
147
150
|
var accepts = ['application/json'];
|
|
148
|
-
var returnType =
|
|
151
|
+
var returnType = _OkResponse["default"];
|
|
149
152
|
return this.apiClient.callApi('/api/v1/admin/tournaments/{id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
150
153
|
}
|
|
151
154
|
|
|
152
155
|
/**
|
|
153
156
|
* Delete tournament and all its entries/matches (admin)
|
|
154
157
|
* @param {String} id
|
|
155
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
158
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OkResponse}
|
|
156
159
|
*/
|
|
157
160
|
}, {
|
|
158
161
|
key: "adminDeleteTournament",
|
|
@@ -165,7 +168,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
165
168
|
/**
|
|
166
169
|
* Draw the bracket now (admin; pulls starts_at to now)
|
|
167
170
|
* @param {String} id
|
|
168
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
171
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminTournamentResponse} and HTTP response
|
|
169
172
|
*/
|
|
170
173
|
}, {
|
|
171
174
|
key: "adminDrawTournamentWithHttpInfo",
|
|
@@ -184,14 +187,14 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
184
187
|
var authNames = ['authorization'];
|
|
185
188
|
var contentTypes = [];
|
|
186
189
|
var accepts = ['application/json'];
|
|
187
|
-
var returnType =
|
|
190
|
+
var returnType = _AdminTournamentResponse["default"];
|
|
188
191
|
return this.apiClient.callApi('/api/v1/admin/tournaments/{id}/draw', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
189
192
|
}
|
|
190
193
|
|
|
191
194
|
/**
|
|
192
195
|
* Draw the bracket now (admin; pulls starts_at to now)
|
|
193
196
|
* @param {String} id
|
|
194
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
197
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminTournamentResponse}
|
|
195
198
|
*/
|
|
196
199
|
}, {
|
|
197
200
|
key: "adminDrawTournament",
|
|
@@ -204,7 +207,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
204
207
|
/**
|
|
205
208
|
* Finish tournament now (admin; pulls ends_at to now)
|
|
206
209
|
* @param {String} id
|
|
207
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
210
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminTournamentResponse} and HTTP response
|
|
208
211
|
*/
|
|
209
212
|
}, {
|
|
210
213
|
key: "adminFinishTournamentWithHttpInfo",
|
|
@@ -223,14 +226,14 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
223
226
|
var authNames = ['authorization'];
|
|
224
227
|
var contentTypes = [];
|
|
225
228
|
var accepts = ['application/json'];
|
|
226
|
-
var returnType =
|
|
229
|
+
var returnType = _AdminTournamentResponse["default"];
|
|
227
230
|
return this.apiClient.callApi('/api/v1/admin/tournaments/{id}/finish', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
228
231
|
}
|
|
229
232
|
|
|
230
233
|
/**
|
|
231
234
|
* Finish tournament now (admin; pulls ends_at to now)
|
|
232
235
|
* @param {String} id
|
|
233
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
236
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminTournamentResponse}
|
|
234
237
|
*/
|
|
235
238
|
}, {
|
|
236
239
|
key: "adminFinishTournament",
|
|
@@ -243,7 +246,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
243
246
|
/**
|
|
244
247
|
* Reopen a cancelled tournament (admin)
|
|
245
248
|
* @param {String} id
|
|
246
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
249
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminTournamentResponse} and HTTP response
|
|
247
250
|
*/
|
|
248
251
|
}, {
|
|
249
252
|
key: "adminReopenTournamentWithHttpInfo",
|
|
@@ -262,14 +265,14 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
262
265
|
var authNames = ['authorization'];
|
|
263
266
|
var contentTypes = [];
|
|
264
267
|
var accepts = ['application/json'];
|
|
265
|
-
var returnType =
|
|
268
|
+
var returnType = _AdminTournamentResponse["default"];
|
|
266
269
|
return this.apiClient.callApi('/api/v1/admin/tournaments/{id}/reopen', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
267
270
|
}
|
|
268
271
|
|
|
269
272
|
/**
|
|
270
273
|
* Reopen a cancelled tournament (admin)
|
|
271
274
|
* @param {String} id
|
|
272
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
275
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminTournamentResponse}
|
|
273
276
|
*/
|
|
274
277
|
}, {
|
|
275
278
|
key: "adminReopenTournament",
|
|
@@ -285,7 +288,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
285
288
|
* @param {String} matchId
|
|
286
289
|
* @param {Object} opts Optional parameters
|
|
287
290
|
* @param {module:model/AdminResolveTournamentMatchRequest} [adminResolveTournamentMatchRequest] Verdict
|
|
288
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
291
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TournamentMatchResponse} and HTTP response
|
|
289
292
|
*/
|
|
290
293
|
}, {
|
|
291
294
|
key: "adminResolveTournamentMatchWithHttpInfo",
|
|
@@ -310,7 +313,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
310
313
|
var authNames = ['authorization'];
|
|
311
314
|
var contentTypes = ['application/json'];
|
|
312
315
|
var accepts = ['application/json'];
|
|
313
|
-
var returnType =
|
|
316
|
+
var returnType = _TournamentMatchResponse["default"];
|
|
314
317
|
return this.apiClient.callApi('/api/v1/admin/tournaments/{id}/matches/{match_id}/resolve', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
315
318
|
}
|
|
316
319
|
|
|
@@ -320,7 +323,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
320
323
|
* @param {String} matchId
|
|
321
324
|
* @param {Object} opts Optional parameters
|
|
322
325
|
* @param {module:model/AdminResolveTournamentMatchRequest} opts.adminResolveTournamentMatchRequest Verdict
|
|
323
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
326
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TournamentMatchResponse}
|
|
324
327
|
*/
|
|
325
328
|
}, {
|
|
326
329
|
key: "adminResolveTournamentMatch",
|
|
@@ -336,7 +339,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
336
339
|
* @param {String} id
|
|
337
340
|
* @param {Object} opts Optional parameters
|
|
338
341
|
* @param {module:model/AdminSetTournamentIconRequest} [adminSetTournamentIconRequest] Uploaded object key
|
|
339
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
342
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminTournamentResponse} and HTTP response
|
|
340
343
|
*/
|
|
341
344
|
}, {
|
|
342
345
|
key: "adminSetTournamentIconWithHttpInfo",
|
|
@@ -356,7 +359,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
356
359
|
var authNames = ['authorization'];
|
|
357
360
|
var contentTypes = ['application/json'];
|
|
358
361
|
var accepts = ['application/json'];
|
|
359
|
-
var returnType =
|
|
362
|
+
var returnType = _AdminTournamentResponse["default"];
|
|
360
363
|
return this.apiClient.callApi('/api/v1/admin/tournaments/{id}/icon', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
361
364
|
}
|
|
362
365
|
|
|
@@ -366,7 +369,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
366
369
|
* @param {String} id
|
|
367
370
|
* @param {Object} opts Optional parameters
|
|
368
371
|
* @param {module:model/AdminSetTournamentIconRequest} opts.adminSetTournamentIconRequest Uploaded object key
|
|
369
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
372
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminTournamentResponse}
|
|
370
373
|
*/
|
|
371
374
|
}, {
|
|
372
375
|
key: "adminSetTournamentIcon",
|
|
@@ -382,7 +385,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
382
385
|
* @param {String} id
|
|
383
386
|
* @param {Object} opts Optional parameters
|
|
384
387
|
* @param {module:model/AdminTournamentIconUploadUrlRequest} [adminTournamentIconUploadUrlRequest] Declared content type
|
|
385
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
388
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UploadTicketResponse} and HTTP response
|
|
386
389
|
*/
|
|
387
390
|
}, {
|
|
388
391
|
key: "adminTournamentIconUploadUrlWithHttpInfo",
|
|
@@ -402,7 +405,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
402
405
|
var authNames = ['authorization'];
|
|
403
406
|
var contentTypes = ['application/json'];
|
|
404
407
|
var accepts = ['application/json'];
|
|
405
|
-
var returnType =
|
|
408
|
+
var returnType = _UploadTicketResponse["default"];
|
|
406
409
|
return this.apiClient.callApi('/api/v1/admin/tournaments/{id}/icon/upload_url', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
407
410
|
}
|
|
408
411
|
|
|
@@ -412,7 +415,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
412
415
|
* @param {String} id
|
|
413
416
|
* @param {Object} opts Optional parameters
|
|
414
417
|
* @param {module:model/AdminTournamentIconUploadUrlRequest} opts.adminTournamentIconUploadUrlRequest Declared content type
|
|
415
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
418
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UploadTicketResponse}
|
|
416
419
|
*/
|
|
417
420
|
}, {
|
|
418
421
|
key: "adminTournamentIconUploadUrl",
|
|
@@ -427,7 +430,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
427
430
|
* @param {String} id
|
|
428
431
|
* @param {Object} opts Optional parameters
|
|
429
432
|
* @param {module:model/AdminUpdateTournamentRequest} [adminUpdateTournamentRequest] Fields to change
|
|
430
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
433
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminTournamentResponse} and HTTP response
|
|
431
434
|
*/
|
|
432
435
|
}, {
|
|
433
436
|
key: "adminUpdateTournamentWithHttpInfo",
|
|
@@ -447,7 +450,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
447
450
|
var authNames = ['authorization'];
|
|
448
451
|
var contentTypes = ['application/json'];
|
|
449
452
|
var accepts = ['application/json'];
|
|
450
|
-
var returnType =
|
|
453
|
+
var returnType = _AdminTournamentResponse["default"];
|
|
451
454
|
return this.apiClient.callApi('/api/v1/admin/tournaments/{id}', 'PATCH', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
452
455
|
}
|
|
453
456
|
|
|
@@ -456,7 +459,7 @@ var AdminTournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
456
459
|
* @param {String} id
|
|
457
460
|
* @param {Object} opts Optional parameters
|
|
458
461
|
* @param {module:model/AdminUpdateTournamentRequest} opts.adminUpdateTournamentRequest Fields to change
|
|
459
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
462
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminTournamentResponse}
|
|
460
463
|
*/
|
|
461
464
|
}, {
|
|
462
465
|
key: "adminUpdateTournament",
|
|
@@ -5,9 +5,10 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
|
-
var _AdminConsumeItem400Response = _interopRequireDefault(require("../model/AdminConsumeItem400Response"));
|
|
9
|
-
var _AdminUpdateUser200Response = _interopRequireDefault(require("../model/AdminUpdateUser200Response"));
|
|
10
8
|
var _AdminUpdateUserRequest = _interopRequireDefault(require("../model/AdminUpdateUserRequest"));
|
|
9
|
+
var _AdminUserResponse = _interopRequireDefault(require("../model/AdminUserResponse"));
|
|
10
|
+
var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
|
|
11
|
+
var _OkResponse = _interopRequireDefault(require("../model/OkResponse"));
|
|
11
12
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
12
13
|
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
|
|
13
14
|
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
@@ -18,7 +19,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
18
19
|
* Gamend API
|
|
19
20
|
* API for Gamend. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, quests, leaderboards, tournaments, matchmaking, payments, server scripting, and admin portal. ## **1. Authentication** This API uses JWT (JSON Web Tokens) with access and refresh tokens: ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ``` ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token. ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights: - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported ## **3. Friends** The Friends domain offers lightweight social features: - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights: - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated ## **5. Notifications** Persistent user-to-user notifications that survive across sessions: - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect - **Push delivery**: notifications also fan out to the recipient's registered mobile devices (see Push notifications) ## **5b. Push notifications** Mobile/web push delivery to registered devices (FCM for Android/Web, APNs-direct for iOS): - **Register device tokens** via `POST /me/push_tokens` (`token`, `platform`, optional `provider`/`device_id`); re-registering a `device_id` rotates its token in place - **List/remove own devices** via `GET /me/push_tokens` and `DELETE /me/push_tokens/:id` - **Server-authoritative sending** — no public send endpoint; pushes originate from server hooks (`Gamend.Push.send_to_user/2`) or the admin API - **Per-token routing**: each token's `provider` (\"fcm\" | \"apns\") selects the delivery backend; unconfigured backends log instead of sending (dev-friendly) - **Reliability**: delivery rides the durable job queue with retries; dead tokens reported by the provider are disabled automatically ## **6. Groups** Groups provide persistent community management for players: - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"` ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads): - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel ## **8. Chat** Real-time messaging across multiple conversation types: - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation is built in**: an admin-managed word filter (`block` / `mask` / `flag`, matched on a normalized form so leetspeak and padding do not slip through) and mutes are enforced before a message is stored or broadcast; the `before_chat_message` pipeline hook stays available for rules of your own - **Report a message**: `POST /chat/messages/:id/report` with an optional `reason` — one report per player per message, capped per day; reports the filter files itself have no reporter - **Scoped mutes** mirror kick: `POST /lobbies/mute` + `/lobbies/unmute` (lobby host), `POST /groups/:id/mute` + `/groups/:id/unmute` (group admin), `POST /parties/mute` + `/parties/unmute` (party leader), each with a paginated `.../mutes` listing for the same authority. Body is `{target_user_id, expires_at?, reason?}`; omitting `expires_at` mutes permanently - **Global mutes and the blocklist are server-authoritative** — no public endpoint; admin API (`/api/v1/admin/chat`) or a plugin calling `Gamend.Chat.mute_user/4` - **Real-time moderation events**: the muted player receives `chat_muted` / `chat_unmuted` on their user channel ## **9. Leaderboards** Server-managed ranked scoreboards: - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings: - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata ## **11. Quests / Progression** One event-driven progression engine covering achievements, daily/weekly quests, time-boxed event quests, chains, and groups: - **Kinds**: `achievement` (permanent one-shot — the replacement for the old achievements system), `daily`/`weekly` (reset per UTC period), `event` (starts_at/ends_at window), `chain` (requires a prerequisite quest) - **Objectives**: each quest lists objectives `{event, target, params}`; server-side `report_event` advances every matching active quest — there is **no public endpoint to advance progress** (server-authoritative) - **Rewards**: currencies (Economy) and items (Inventory), paid **exactly once** per period via idempotent grants; `auto_claim` quests pay on completion, others via `POST /me/quests/:key/claim` - **My quests**: `GET /me/quests` returns active quests, per-period progress, and a claimable flag; hidden quests appear once completed - **Groups**: quests sharing a `group_key` collapse to one entry carrying `group_size`; `?group=<key>` lists that group's members in full - **Catalog**: `GET /quests` and per-user completions `GET /quests/user/:user_id` (gated by `GAMEND_FEATURES_LIST_QUESTS`) - **Admin management**: definitions CRUD plus per-user grant/reset/force-claim under `/api/v1/admin/quests` ## **12. Tournaments** Single-elimination bracket tournaments, server-structured and game-judged: - **Registration window → seeded draw → timed rounds → champions**; recurring tournaments (cron) create one occurrence per cycle sharing a slug; a nil starts_at keeps registration open until an admin draws manually - **Join/leave** as an entry leader (`POST`/`DELETE /tournaments/:id/join`); team composition is game policy - **Browse**: list/filter tournaments, standings, full bracket view, and the caller's current match (`GET /tournaments/:id/my_match`) - **Match verdicts are server-side** (game hooks) — no public resolve endpoint; clients get `tournament_match_ready` / `tournament_match_resolved` / `tournament_updated` / `tournament_finished` on the user channel - **Admin management** over HTTP: create/update/delete, cancel, draw now, finish, and force match verdicts under `/api/v1/admin/tournaments` ## **13. Matchmaking** Ticket-based queueing that turns waiting players into hidden, locked lobbies: - **Join over HTTP** (`POST /matchmaking/tickets` with a `match_params` string map); only tickets with identical params match together — encode mode/map/skill band as parameter values - **A match forms** when a group reaches `max_players`, or has at least `min_players` and the oldest ticket outwaited the timeout; the server creates a hidden lobby, seats everyone and locks it - **The result is a push, not a poll**: matched players receive `match_found` (`lobby_id`, `match_params`) on their user channel; disconnecting cancels your tickets - **Inspect**: `GET /matchmaking/tickets/me` for your ticket, `GET /matchmaking/stats` for queue depths - **Admin management** over HTTP: list/filter tickets, force-cancel, and stats under `/api/v1/admin/matchmaking` ## **14. Ready checks** One primitive for \"everyone must answer before this proceeds\", with one client-facing surface: - **A player holds at most one check per lane** — the match lane (lobby ready-up or matchmaking accept) and the party lane (the party's standing board) — so answering needs no id: `GET /me/ready_check` returns `{\"lobby\": …, \"party\": …}` (each null when none) and `POST /me/ready_check` with `{\"ready\": true|false, \"scope\": \"lobby\"|\"party\"}` answers one (scope defaults to `lobby`) - **Two kinds.** `ready` (lobby/party board) is a toggle — a \"no\" just leaves the check open, and it lists every participant. `accept` (match confirmation) is final — one decline fails it for everyone — and returns counts plus your own state, so a pending match does not reveal who you were paired with - **Hosts open one** with `POST /lobbies/ready_check` (host-managed lobbies only; hostless matchmaking lobbies belong to the server), **party leaders** with `POST /parties/ready_check`; either call is a **reset** — it quietly replaces an already-open board with a fresh one over the current members, so the same endpoint serves \"ready check!\", \"force ready\" (with `timeout_ms`) and \"start over\". Call it off with `DELETE /lobbies/ready_check` / `DELETE /parties/ready_check`. The opener is pre-marked ready — clicking the button is their answer - **Failure does nothing on its own**: a declined or timed-out check kicks nobody, starts nothing, and moves no lobby state. It reports who did not answer, and the game (or the host, with the kick they already have) decides - **Live**: `ready_check_started` / `ready_check_updated` / `ready_check_passed` / `ready_check_failed` on the lobby channel, the party channel for a party board, or the user channel for an accept check - **Admin management** over HTTP: list/filter checks, force-cancel, and 24h outcome stats under `/api/v1/admin/ready_checks` ## **15. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates. ### **15.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ``` ### **15.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, quest progress/completions/claims, party/group invites, tournament events, chat mutes (`chat_muted` / `chat_unmuted`), KV subscriptions - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat ### **15.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/gamend' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` `phoenix` ships as a dependency of the package, so no extra install is needed. ## **16. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients). ### **16.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency ### **16.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **16.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/gamend' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, { onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ```
|
|
20
21
|
*
|
|
21
|
-
* The version of the OpenAPI document: 1.0.
|
|
22
|
+
* The version of the OpenAPI document: 1.0.1250
|
|
22
23
|
*
|
|
23
24
|
*
|
|
24
25
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -47,7 +48,7 @@ var AdminUsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
47
48
|
/**
|
|
48
49
|
* Delete user (admin)
|
|
49
50
|
* @param {String} id
|
|
50
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
51
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OkResponse} and HTTP response
|
|
51
52
|
*/
|
|
52
53
|
return _createClass(AdminUsersApi, [{
|
|
53
54
|
key: "adminDeleteUserWithHttpInfo",
|
|
@@ -66,14 +67,14 @@ var AdminUsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
66
67
|
var authNames = ['authorization'];
|
|
67
68
|
var contentTypes = [];
|
|
68
69
|
var accepts = ['application/json'];
|
|
69
|
-
var returnType =
|
|
70
|
+
var returnType = _OkResponse["default"];
|
|
70
71
|
return this.apiClient.callApi('/api/v1/admin/users/{id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
71
72
|
}
|
|
72
73
|
|
|
73
74
|
/**
|
|
74
75
|
* Delete user (admin)
|
|
75
76
|
* @param {String} id
|
|
76
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
77
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OkResponse}
|
|
77
78
|
*/
|
|
78
79
|
}, {
|
|
79
80
|
key: "adminDeleteUser",
|
|
@@ -88,7 +89,7 @@ var AdminUsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
88
89
|
* @param {String} id
|
|
89
90
|
* @param {Object} opts Optional parameters
|
|
90
91
|
* @param {module:model/AdminUpdateUserRequest} [adminUpdateUserRequest] User patch
|
|
91
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
92
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminUserResponse} and HTTP response
|
|
92
93
|
*/
|
|
93
94
|
}, {
|
|
94
95
|
key: "adminUpdateUserWithHttpInfo",
|
|
@@ -108,7 +109,7 @@ var AdminUsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
108
109
|
var authNames = ['authorization'];
|
|
109
110
|
var contentTypes = ['application/json'];
|
|
110
111
|
var accepts = ['application/json'];
|
|
111
|
-
var returnType =
|
|
112
|
+
var returnType = _AdminUserResponse["default"];
|
|
112
113
|
return this.apiClient.callApi('/api/v1/admin/users/{id}', 'PATCH', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
113
114
|
}
|
|
114
115
|
|
|
@@ -117,7 +118,7 @@ var AdminUsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
117
118
|
* @param {String} id
|
|
118
119
|
* @param {Object} opts Optional parameters
|
|
119
120
|
* @param {module:model/AdminUpdateUserRequest} opts.adminUpdateUserRequest User patch
|
|
120
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
121
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminUserResponse}
|
|
121
122
|
*/
|
|
122
123
|
}, {
|
|
123
124
|
key: "adminUpdateUser",
|