@ughuuu/gamend 1.0.1241 → 1.0.1251
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 +155 -108
- 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 +293 -46
- package/dist/api/ChatApi.js +1 -1
- package/dist/api/ClientLogsApi.js +9 -9
- package/dist/api/EconomyApi.js +14 -13
- package/dist/api/FriendsApi.js +1 -1
- package/dist/api/GroupsApi.js +1 -1
- 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 +1 -1
- package/dist/api/LobbiesApi.js +1 -1
- package/dist/api/MatchmakingApi.js +21 -22
- package/dist/api/NotificationsApi.js +1 -1
- package/dist/api/PartiesApi.js +1 -1
- package/dist/api/PaymentsApi.js +57 -34
- package/dist/api/PushApi.js +1 -1
- 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 +1 -1
- package/dist/api/UsersApi.js +14 -8
- package/dist/index.js +803 -530
- 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/{UserQuests200Response.js → AdminChatMuteResponse.js} +42 -51
- 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/AdminKvEntry.js +197 -0
- package/dist/model/{AdminListChatMutes200Response.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/{AdminListPushTokens200Response.js → AdminLeaderboardRecordResponse.js} +44 -47
- 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/{AdminListStorageObjects200Response.js → AdminQuestClaim.js} +66 -51
- 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/{AdminListLobbies200Response.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/{ListCurrentUserLedger200Response.js → AnalyticsSummaryResponse.js} +44 -47
- 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/{AdminUpdateChatFilterWord200ResponseData.js → ChatFilterHit.js} +52 -65
- 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/ChatFilterWord.js +231 -0
- 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/ChatMessageResponse.js +1 -1
- 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 +1 -1
- package/dist/model/{AdminResolveChatReport200ResponseData.js → ChatReport.js} +89 -36
- package/dist/model/{AdminListMatchmakingTickets200Response.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/CounterTotal.js +123 -0
- 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 +1 -1
- 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/{AdminGetAnalyticsEconomy200ResponseFlowInner.js → EconomyFlowDay.js} +59 -25
- package/dist/model/{AdminGetAnalyticsEconomy200ResponseTotalsInner.js → EconomyTotal.js} +59 -25
- package/dist/model/Entitlement.js +213 -0
- package/dist/model/{AdminListChatReports200Response.js → EntitlementPage.js} +57 -34
- package/dist/model/ErrorResponse.js +1 -1
- 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 +1 -1
- package/dist/model/FriendRequestsResponse.js +1 -1
- package/dist/model/Group.js +1 -1
- package/dist/model/GroupInvite.js +1 -1
- package/dist/model/GroupInviteOutcome.js +1 -1
- package/dist/model/GroupInviteOutcomeResponse.js +1 -1
- 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 +1 -1
- package/dist/model/GroupMember.js +1 -1
- package/dist/model/GroupMemberPage.js +1 -1
- package/dist/model/GroupMemberResponse.js +1 -1
- package/dist/model/GroupPage.js +1 -1
- package/dist/model/GroupResponse.js +1 -1
- package/dist/model/Health.js +125 -0
- 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/{AdminUpsertKv200ResponseData.js → KvEntry.js} +58 -53
- package/dist/model/KvEntryResponse.js +115 -0
- package/dist/model/Leaderboard.js +1 -1
- package/dist/model/LeaderboardPage.js +1 -1
- package/dist/model/LeaderboardRecord.js +1 -1
- package/dist/model/LeaderboardRecordPage.js +1 -1
- package/dist/model/LeaderboardRecordResponse.js +1 -1
- package/dist/model/LeaderboardResponse.js +1 -1
- package/dist/model/LeaderboardsBySlugResponse.js +1 -1
- 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 +1 -1
- 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/{AdminListSessions200Response.js → MyReadyChecks.js} +57 -49
- 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 +1 -1
- package/dist/model/OAuthAuthorization.js +1 -1
- package/dist/model/OAuthAuthorizationResponse.js +1 -1
- package/dist/model/OAuthSessionStatus.js +37 -26
- package/dist/model/OAuthSessionStatusResponse.js +1 -1
- 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 +1 -1
- package/dist/model/PartyJoinLobbyRequest.js +1 -1
- package/dist/model/PartyResponse.js +1 -1
- 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/{AdminUpdateGroup200Response.js → PaymentProduct.js} +72 -91
- package/dist/model/{AdminListKvEntries200Response.js → PaymentWebhookReceipt.js} +64 -51
- 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 +1 -1
- 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 +1 -1
- 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/{AdminListQuests200Response.js → ReadyCheckOutcomesResponse.js} +41 -47
- 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/RegisterRequest.js +141 -0
- 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/{AdminListQuestProgress200Response.js → RetentionStatusResponse.js} +44 -47
- package/dist/model/SendChatMessageRequest.js +1 -1
- package/dist/model/SendNotificationRequest.js +1 -1
- package/dist/model/ServerStats.js +227 -0
- package/dist/model/{OAuthResultResponse.js → ServerStatsResponse.js} +26 -26
- 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/StorageUsage.js +119 -0
- package/dist/model/StorageUsageResponse.js +115 -0
- package/dist/model/StripeCheckout.js +143 -0
- package/dist/model/StripeCheckoutResponse.js +115 -0
- package/dist/model/Tournament.js +1 -1
- package/dist/model/TournamentBracket.js +1 -1
- package/dist/model/TournamentBracketPage.js +1 -1
- package/dist/model/TournamentEntry.js +1 -1
- package/dist/model/TournamentEntryPage.js +1 -1
- package/dist/model/TournamentEntryResponse.js +1 -1
- package/dist/model/TournamentMatch.js +11 -6
- package/dist/model/TournamentMatchCounts.js +129 -0
- package/dist/model/TournamentMatchResponse.js +1 -1
- package/dist/model/TournamentPage.js +1 -1
- package/dist/model/TournamentPlacement.js +1 -1
- package/dist/model/TournamentResponse.js +1 -1
- package/dist/model/TournamentStandings.js +1 -1
- package/dist/model/TournamentStandingsResponse.js +1 -1
- 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 +1 -1
- 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/AdminImportChatFilterWords200Response.js +0 -93
- package/dist/model/AdminListChatMessages200ResponseDataInner.js +0 -213
- package/dist/model/AdminListLobbies200ResponseDataInner.js +0 -191
- package/dist/model/AdminListNotifications200ResponseDataInner.js +0 -173
- package/dist/model/AdminListReadyChecks200Response.js +0 -124
- 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/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/GetServerTime200Response.js +0 -86
- package/dist/model/GetStats200Response.js +0 -91
- package/dist/model/GetStats200ResponseData.js +0 -151
- 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/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
|
@@ -6,17 +6,21 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
8
|
var _AdminClaimQuestRequest = _interopRequireDefault(require("../model/AdminClaimQuestRequest"));
|
|
9
|
-
var _AdminConsumeItem400Response = _interopRequireDefault(require("../model/AdminConsumeItem400Response"));
|
|
10
9
|
var _AdminCreateQuestRequest = _interopRequireDefault(require("../model/AdminCreateQuestRequest"));
|
|
11
10
|
var _AdminGrantQuestRequest = _interopRequireDefault(require("../model/AdminGrantQuestRequest"));
|
|
12
|
-
var
|
|
13
|
-
var _AdminListQuestProgress200ResponseDataInner = _interopRequireDefault(require("../model/AdminListQuestProgress200ResponseDataInner"));
|
|
14
|
-
var _AdminListQuests200Response = _interopRequireDefault(require("../model/AdminListQuests200Response"));
|
|
15
|
-
var _AdminListQuests200ResponseDataInner = _interopRequireDefault(require("../model/AdminListQuests200ResponseDataInner"));
|
|
11
|
+
var _AdminQuestClaimResponse = _interopRequireDefault(require("../model/AdminQuestClaimResponse"));
|
|
16
12
|
var _AdminQuestIconUploadUrlRequest = _interopRequireDefault(require("../model/AdminQuestIconUploadUrlRequest"));
|
|
13
|
+
var _AdminQuestPage = _interopRequireDefault(require("../model/AdminQuestPage"));
|
|
14
|
+
var _AdminQuestProgressPage = _interopRequireDefault(require("../model/AdminQuestProgressPage"));
|
|
15
|
+
var _AdminQuestProgressResponse = _interopRequireDefault(require("../model/AdminQuestProgressResponse"));
|
|
16
|
+
var _AdminQuestResponse = _interopRequireDefault(require("../model/AdminQuestResponse"));
|
|
17
17
|
var _AdminResetQuestRequest = _interopRequireDefault(require("../model/AdminResetQuestRequest"));
|
|
18
18
|
var _AdminSetQuestIconRequest = _interopRequireDefault(require("../model/AdminSetQuestIconRequest"));
|
|
19
19
|
var _AdminUpdateQuestRequest = _interopRequireDefault(require("../model/AdminUpdateQuestRequest"));
|
|
20
|
+
var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
|
|
21
|
+
var _OkResponse = _interopRequireDefault(require("../model/OkResponse"));
|
|
22
|
+
var _QuestFunnelResponse = _interopRequireDefault(require("../model/QuestFunnelResponse"));
|
|
23
|
+
var _UploadTicketResponse = _interopRequireDefault(require("../model/UploadTicketResponse"));
|
|
20
24
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
21
25
|
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); }
|
|
22
26
|
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
@@ -27,7 +31,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
27
31
|
* Gamend API
|
|
28
32
|
* 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 })) ```
|
|
29
33
|
*
|
|
30
|
-
* The version of the OpenAPI document: 1.0.
|
|
34
|
+
* The version of the OpenAPI document: 1.0.1251
|
|
31
35
|
*
|
|
32
36
|
*
|
|
33
37
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -58,7 +62,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
58
62
|
* Skips the before_quest_claim veto. Reward grants stay exactly-once.
|
|
59
63
|
* @param {Object} opts Optional parameters
|
|
60
64
|
* @param {module:model/AdminClaimQuestRequest} [adminClaimQuestRequest] Claim
|
|
61
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
65
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminQuestClaimResponse} and HTTP response
|
|
62
66
|
*/
|
|
63
67
|
return _createClass(AdminQuestsApi, [{
|
|
64
68
|
key: "adminClaimQuestWithHttpInfo",
|
|
@@ -72,7 +76,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
72
76
|
var authNames = ['authorization'];
|
|
73
77
|
var contentTypes = ['application/json'];
|
|
74
78
|
var accepts = ['application/json'];
|
|
75
|
-
var returnType =
|
|
79
|
+
var returnType = _AdminQuestClaimResponse["default"];
|
|
76
80
|
return this.apiClient.callApi('/api/v1/admin/quests/claim', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
77
81
|
}
|
|
78
82
|
|
|
@@ -81,7 +85,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
81
85
|
* Skips the before_quest_claim veto. Reward grants stay exactly-once.
|
|
82
86
|
* @param {Object} opts Optional parameters
|
|
83
87
|
* @param {module:model/AdminClaimQuestRequest} opts.adminClaimQuestRequest Claim
|
|
84
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
88
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminQuestClaimResponse}
|
|
85
89
|
*/
|
|
86
90
|
}, {
|
|
87
91
|
key: "adminClaimQuest",
|
|
@@ -95,7 +99,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
95
99
|
* Create quest (admin)
|
|
96
100
|
* @param {Object} opts Optional parameters
|
|
97
101
|
* @param {module:model/AdminCreateQuestRequest} [adminCreateQuestRequest] Quest
|
|
98
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
102
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminQuestResponse} and HTTP response
|
|
99
103
|
*/
|
|
100
104
|
}, {
|
|
101
105
|
key: "adminCreateQuestWithHttpInfo",
|
|
@@ -109,7 +113,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
109
113
|
var authNames = ['authorization'];
|
|
110
114
|
var contentTypes = ['application/json'];
|
|
111
115
|
var accepts = ['application/json'];
|
|
112
|
-
var returnType =
|
|
116
|
+
var returnType = _AdminQuestResponse["default"];
|
|
113
117
|
return this.apiClient.callApi('/api/v1/admin/quests', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
114
118
|
}
|
|
115
119
|
|
|
@@ -117,7 +121,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
117
121
|
* Create quest (admin)
|
|
118
122
|
* @param {Object} opts Optional parameters
|
|
119
123
|
* @param {module:model/AdminCreateQuestRequest} opts.adminCreateQuestRequest Quest
|
|
120
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
124
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminQuestResponse}
|
|
121
125
|
*/
|
|
122
126
|
}, {
|
|
123
127
|
key: "adminCreateQuest",
|
|
@@ -130,7 +134,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
130
134
|
/**
|
|
131
135
|
* Delete quest and all user progress (admin)
|
|
132
136
|
* @param {String} id
|
|
133
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
137
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OkResponse} and HTTP response
|
|
134
138
|
*/
|
|
135
139
|
}, {
|
|
136
140
|
key: "adminDeleteQuestWithHttpInfo",
|
|
@@ -149,14 +153,14 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
149
153
|
var authNames = ['authorization'];
|
|
150
154
|
var contentTypes = [];
|
|
151
155
|
var accepts = ['application/json'];
|
|
152
|
-
var returnType =
|
|
156
|
+
var returnType = _OkResponse["default"];
|
|
153
157
|
return this.apiClient.callApi('/api/v1/admin/quests/{id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
154
158
|
}
|
|
155
159
|
|
|
156
160
|
/**
|
|
157
161
|
* Delete quest and all user progress (admin)
|
|
158
162
|
* @param {String} id
|
|
159
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
163
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OkResponse}
|
|
160
164
|
*/
|
|
161
165
|
}, {
|
|
162
166
|
key: "adminDeleteQuest",
|
|
@@ -171,7 +175,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
171
175
|
* Every objective jumps to its target for the current period; completion hooks fire and auto-claim quests pay out immediately.
|
|
172
176
|
* @param {Object} opts Optional parameters
|
|
173
177
|
* @param {module:model/AdminGrantQuestRequest} [adminGrantQuestRequest] Grant
|
|
174
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
178
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminQuestProgressResponse} and HTTP response
|
|
175
179
|
*/
|
|
176
180
|
}, {
|
|
177
181
|
key: "adminGrantQuestWithHttpInfo",
|
|
@@ -185,7 +189,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
185
189
|
var authNames = ['authorization'];
|
|
186
190
|
var contentTypes = ['application/json'];
|
|
187
191
|
var accepts = ['application/json'];
|
|
188
|
-
var returnType =
|
|
192
|
+
var returnType = _AdminQuestProgressResponse["default"];
|
|
189
193
|
return this.apiClient.callApi('/api/v1/admin/quests/grant', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
190
194
|
}
|
|
191
195
|
|
|
@@ -194,7 +198,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
194
198
|
* Every objective jumps to its target for the current period; completion hooks fire and auto-claim quests pay out immediately.
|
|
195
199
|
* @param {Object} opts Optional parameters
|
|
196
200
|
* @param {module:model/AdminGrantQuestRequest} opts.adminGrantQuestRequest Grant
|
|
197
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
201
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminQuestProgressResponse}
|
|
198
202
|
*/
|
|
199
203
|
}, {
|
|
200
204
|
key: "adminGrantQuest",
|
|
@@ -212,7 +216,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
212
216
|
* @param {String} [status]
|
|
213
217
|
* @param {Number} [page]
|
|
214
218
|
* @param {Number} [pageSize]
|
|
215
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
219
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminQuestProgressPage} and HTTP response
|
|
216
220
|
*/
|
|
217
221
|
}, {
|
|
218
222
|
key: "adminListQuestProgressWithHttpInfo",
|
|
@@ -232,7 +236,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
232
236
|
var authNames = ['authorization'];
|
|
233
237
|
var contentTypes = [];
|
|
234
238
|
var accepts = ['application/json'];
|
|
235
|
-
var returnType =
|
|
239
|
+
var returnType = _AdminQuestProgressPage["default"];
|
|
236
240
|
return this.apiClient.callApi('/api/v1/admin/quests/progress', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
237
241
|
}
|
|
238
242
|
|
|
@@ -244,7 +248,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
244
248
|
* @param {String} opts.status
|
|
245
249
|
* @param {Number} opts.page
|
|
246
250
|
* @param {Number} opts.pageSize
|
|
247
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
251
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminQuestProgressPage}
|
|
248
252
|
*/
|
|
249
253
|
}, {
|
|
250
254
|
key: "adminListQuestProgress",
|
|
@@ -261,7 +265,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
261
265
|
* @param {String} [search]
|
|
262
266
|
* @param {Number} [page]
|
|
263
267
|
* @param {Number} [pageSize]
|
|
264
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
268
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminQuestPage} and HTTP response
|
|
265
269
|
*/
|
|
266
270
|
}, {
|
|
267
271
|
key: "adminListQuestsWithHttpInfo",
|
|
@@ -280,7 +284,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
280
284
|
var authNames = ['authorization'];
|
|
281
285
|
var contentTypes = [];
|
|
282
286
|
var accepts = ['application/json'];
|
|
283
|
-
var returnType =
|
|
287
|
+
var returnType = _AdminQuestPage["default"];
|
|
284
288
|
return this.apiClient.callApi('/api/v1/admin/quests', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
285
289
|
}
|
|
286
290
|
|
|
@@ -291,7 +295,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
291
295
|
* @param {String} opts.search
|
|
292
296
|
* @param {Number} opts.page
|
|
293
297
|
* @param {Number} opts.pageSize
|
|
294
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
298
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminQuestPage}
|
|
295
299
|
*/
|
|
296
300
|
}, {
|
|
297
301
|
key: "adminListQuests",
|
|
@@ -304,7 +308,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
304
308
|
/**
|
|
305
309
|
* Per-status progress counts for one quest (admin)
|
|
306
310
|
* @param {String} key
|
|
307
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
311
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/QuestFunnelResponse} and HTTP response
|
|
308
312
|
*/
|
|
309
313
|
}, {
|
|
310
314
|
key: "adminQuestFunnelWithHttpInfo",
|
|
@@ -323,14 +327,14 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
323
327
|
var authNames = ['authorization'];
|
|
324
328
|
var contentTypes = [];
|
|
325
329
|
var accepts = ['application/json'];
|
|
326
|
-
var returnType =
|
|
330
|
+
var returnType = _QuestFunnelResponse["default"];
|
|
327
331
|
return this.apiClient.callApi('/api/v1/admin/quests/{key}/funnel', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
328
332
|
}
|
|
329
333
|
|
|
330
334
|
/**
|
|
331
335
|
* Per-status progress counts for one quest (admin)
|
|
332
336
|
* @param {String} key
|
|
333
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
337
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/QuestFunnelResponse}
|
|
334
338
|
*/
|
|
335
339
|
}, {
|
|
336
340
|
key: "adminQuestFunnel",
|
|
@@ -346,7 +350,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
346
350
|
* @param {String} id
|
|
347
351
|
* @param {Object} opts Optional parameters
|
|
348
352
|
* @param {module:model/AdminQuestIconUploadUrlRequest} [adminQuestIconUploadUrlRequest] Declared content type
|
|
349
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
353
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UploadTicketResponse} and HTTP response
|
|
350
354
|
*/
|
|
351
355
|
}, {
|
|
352
356
|
key: "adminQuestIconUploadUrlWithHttpInfo",
|
|
@@ -366,7 +370,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
366
370
|
var authNames = ['authorization'];
|
|
367
371
|
var contentTypes = ['application/json'];
|
|
368
372
|
var accepts = ['application/json'];
|
|
369
|
-
var returnType =
|
|
373
|
+
var returnType = _UploadTicketResponse["default"];
|
|
370
374
|
return this.apiClient.callApi('/api/v1/admin/quests/{id}/icon/upload_url', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
371
375
|
}
|
|
372
376
|
|
|
@@ -376,7 +380,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
376
380
|
* @param {String} id
|
|
377
381
|
* @param {Object} opts Optional parameters
|
|
378
382
|
* @param {module:model/AdminQuestIconUploadUrlRequest} opts.adminQuestIconUploadUrlRequest Declared content type
|
|
379
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
383
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UploadTicketResponse}
|
|
380
384
|
*/
|
|
381
385
|
}, {
|
|
382
386
|
key: "adminQuestIconUploadUrl",
|
|
@@ -390,7 +394,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
390
394
|
* Reset a user's current-period quest progress (admin)
|
|
391
395
|
* @param {Object} opts Optional parameters
|
|
392
396
|
* @param {module:model/AdminResetQuestRequest} [adminResetQuestRequest] Reset
|
|
393
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
397
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OkResponse} and HTTP response
|
|
394
398
|
*/
|
|
395
399
|
}, {
|
|
396
400
|
key: "adminResetQuestWithHttpInfo",
|
|
@@ -404,7 +408,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
404
408
|
var authNames = ['authorization'];
|
|
405
409
|
var contentTypes = ['application/json'];
|
|
406
410
|
var accepts = ['application/json'];
|
|
407
|
-
var returnType =
|
|
411
|
+
var returnType = _OkResponse["default"];
|
|
408
412
|
return this.apiClient.callApi('/api/v1/admin/quests/reset', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
409
413
|
}
|
|
410
414
|
|
|
@@ -412,7 +416,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
412
416
|
* Reset a user's current-period quest progress (admin)
|
|
413
417
|
* @param {Object} opts Optional parameters
|
|
414
418
|
* @param {module:model/AdminResetQuestRequest} opts.adminResetQuestRequest Reset
|
|
415
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
419
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OkResponse}
|
|
416
420
|
*/
|
|
417
421
|
}, {
|
|
418
422
|
key: "adminResetQuest",
|
|
@@ -428,7 +432,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
428
432
|
* @param {String} id
|
|
429
433
|
* @param {Object} opts Optional parameters
|
|
430
434
|
* @param {module:model/AdminSetQuestIconRequest} [adminSetQuestIconRequest] Uploaded object key
|
|
431
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
435
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminQuestResponse} and HTTP response
|
|
432
436
|
*/
|
|
433
437
|
}, {
|
|
434
438
|
key: "adminSetQuestIconWithHttpInfo",
|
|
@@ -448,7 +452,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
448
452
|
var authNames = ['authorization'];
|
|
449
453
|
var contentTypes = ['application/json'];
|
|
450
454
|
var accepts = ['application/json'];
|
|
451
|
-
var returnType =
|
|
455
|
+
var returnType = _AdminQuestResponse["default"];
|
|
452
456
|
return this.apiClient.callApi('/api/v1/admin/quests/{id}/icon', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
453
457
|
}
|
|
454
458
|
|
|
@@ -458,7 +462,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
458
462
|
* @param {String} id
|
|
459
463
|
* @param {Object} opts Optional parameters
|
|
460
464
|
* @param {module:model/AdminSetQuestIconRequest} opts.adminSetQuestIconRequest Uploaded object key
|
|
461
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
465
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminQuestResponse}
|
|
462
466
|
*/
|
|
463
467
|
}, {
|
|
464
468
|
key: "adminSetQuestIcon",
|
|
@@ -473,7 +477,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
473
477
|
* @param {String} id
|
|
474
478
|
* @param {Object} opts Optional parameters
|
|
475
479
|
* @param {module:model/AdminUpdateQuestRequest} [adminUpdateQuestRequest] Quest
|
|
476
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
480
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminQuestResponse} and HTTP response
|
|
477
481
|
*/
|
|
478
482
|
}, {
|
|
479
483
|
key: "adminUpdateQuestWithHttpInfo",
|
|
@@ -493,7 +497,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
493
497
|
var authNames = ['authorization'];
|
|
494
498
|
var contentTypes = ['application/json'];
|
|
495
499
|
var accepts = ['application/json'];
|
|
496
|
-
var returnType =
|
|
500
|
+
var returnType = _AdminQuestResponse["default"];
|
|
497
501
|
return this.apiClient.callApi('/api/v1/admin/quests/{id}', 'PATCH', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
498
502
|
}
|
|
499
503
|
|
|
@@ -502,7 +506,7 @@ var AdminQuestsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
502
506
|
* @param {String} id
|
|
503
507
|
* @param {Object} opts Optional parameters
|
|
504
508
|
* @param {module:model/AdminUpdateQuestRequest} opts.adminUpdateQuestRequest Quest
|
|
505
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
509
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminQuestResponse}
|
|
506
510
|
*/
|
|
507
511
|
}, {
|
|
508
512
|
key: "adminUpdateQuest",
|
|
@@ -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
|
|
9
|
-
var
|
|
10
|
-
var
|
|
8
|
+
var _AdminReadyCheckPage = _interopRequireDefault(require("../model/AdminReadyCheckPage"));
|
|
9
|
+
var _AdminReadyCheckResponse = _interopRequireDefault(require("../model/AdminReadyCheckResponse"));
|
|
10
|
+
var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
|
|
11
|
+
var _ReadyCheckOutcomesResponse = _interopRequireDefault(require("../model/ReadyCheckOutcomesResponse"));
|
|
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.1251
|
|
22
23
|
*
|
|
23
24
|
*
|
|
24
25
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -47,7 +48,7 @@ var AdminReadyChecksApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
47
48
|
/**
|
|
48
49
|
* Force-cancel a pending ready check (admin)
|
|
49
50
|
* @param {String} id
|
|
50
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
51
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminReadyCheckResponse} and HTTP response
|
|
51
52
|
*/
|
|
52
53
|
return _createClass(AdminReadyChecksApi, [{
|
|
53
54
|
key: "adminCancelReadyCheckWithHttpInfo",
|
|
@@ -66,14 +67,14 @@ var AdminReadyChecksApi = 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 = _AdminReadyCheckResponse["default"];
|
|
70
71
|
return this.apiClient.callApi('/api/v1/admin/ready_checks/{id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
71
72
|
}
|
|
72
73
|
|
|
73
74
|
/**
|
|
74
75
|
* Force-cancel a pending ready check (admin)
|
|
75
76
|
* @param {String} id
|
|
76
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
77
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminReadyCheckResponse}
|
|
77
78
|
*/
|
|
78
79
|
}, {
|
|
79
80
|
key: "adminCancelReadyCheck",
|
|
@@ -91,7 +92,7 @@ var AdminReadyChecksApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
91
92
|
* @param {String} [lobbyId]
|
|
92
93
|
* @param {Number} [page = 1)]
|
|
93
94
|
* @param {Number} [pageSize = 25)]
|
|
94
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
95
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminReadyCheckPage} and HTTP response
|
|
95
96
|
*/
|
|
96
97
|
}, {
|
|
97
98
|
key: "adminListReadyChecksWithHttpInfo",
|
|
@@ -111,7 +112,7 @@ var AdminReadyChecksApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
111
112
|
var authNames = ['authorization'];
|
|
112
113
|
var contentTypes = [];
|
|
113
114
|
var accepts = ['application/json'];
|
|
114
|
-
var returnType =
|
|
115
|
+
var returnType = _AdminReadyCheckPage["default"];
|
|
115
116
|
return this.apiClient.callApi('/api/v1/admin/ready_checks', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
116
117
|
}
|
|
117
118
|
|
|
@@ -123,7 +124,7 @@ var AdminReadyChecksApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
123
124
|
* @param {String} opts.lobbyId
|
|
124
125
|
* @param {Number} opts.page (default to 1)
|
|
125
126
|
* @param {Number} opts.pageSize (default to 25)
|
|
126
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
127
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminReadyCheckPage}
|
|
127
128
|
*/
|
|
128
129
|
}, {
|
|
129
130
|
key: "adminListReadyChecks",
|
|
@@ -136,7 +137,7 @@ var AdminReadyChecksApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
136
137
|
/**
|
|
137
138
|
* Ready check outcomes over the last 24 hours (admin)
|
|
138
139
|
* Counts by status — the accept rate and dodge rate of the queue and of lobby starts.
|
|
139
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
140
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ReadyCheckOutcomesResponse} and HTTP response
|
|
140
141
|
*/
|
|
141
142
|
}, {
|
|
142
143
|
key: "adminReadyCheckStatsWithHttpInfo",
|
|
@@ -149,14 +150,14 @@ var AdminReadyChecksApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
149
150
|
var authNames = ['authorization'];
|
|
150
151
|
var contentTypes = [];
|
|
151
152
|
var accepts = ['application/json'];
|
|
152
|
-
var returnType =
|
|
153
|
+
var returnType = _ReadyCheckOutcomesResponse["default"];
|
|
153
154
|
return this.apiClient.callApi('/api/v1/admin/ready_checks/stats', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
154
155
|
}
|
|
155
156
|
|
|
156
157
|
/**
|
|
157
158
|
* Ready check outcomes over the last 24 hours (admin)
|
|
158
159
|
* Counts by status — the accept rate and dodge rate of the queue and of lobby starts.
|
|
159
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
160
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ReadyCheckOutcomesResponse}
|
|
160
161
|
*/
|
|
161
162
|
}, {
|
|
162
163
|
key: "adminReadyCheckStats",
|
|
@@ -5,8 +5,8 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
|
-
var
|
|
9
|
-
var
|
|
8
|
+
var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
|
|
9
|
+
var _RetentionStatusResponse = _interopRequireDefault(require("../model/RetentionStatusResponse"));
|
|
10
10
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
11
11
|
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); }
|
|
12
12
|
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
@@ -17,7 +17,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
17
17
|
* Gamend API
|
|
18
18
|
* 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 })) ```
|
|
19
19
|
*
|
|
20
|
-
* The version of the OpenAPI document: 1.0.
|
|
20
|
+
* The version of the OpenAPI document: 1.0.1251
|
|
21
21
|
*
|
|
22
22
|
*
|
|
23
23
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -45,7 +45,7 @@ var AdminRetentionApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
45
45
|
|
|
46
46
|
/**
|
|
47
47
|
* Last retention sweep (admin)
|
|
48
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
48
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetentionStatusResponse} and HTTP response
|
|
49
49
|
*/
|
|
50
50
|
return _createClass(AdminRetentionApi, [{
|
|
51
51
|
key: "adminGetRetentionStatusWithHttpInfo",
|
|
@@ -58,13 +58,13 @@ var AdminRetentionApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
58
58
|
var authNames = ['authorization'];
|
|
59
59
|
var contentTypes = [];
|
|
60
60
|
var accepts = ['application/json'];
|
|
61
|
-
var returnType =
|
|
61
|
+
var returnType = _RetentionStatusResponse["default"];
|
|
62
62
|
return this.apiClient.callApi('/api/v1/admin/retention', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
63
63
|
}
|
|
64
64
|
|
|
65
65
|
/**
|
|
66
66
|
* Last retention sweep (admin)
|
|
67
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
67
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetentionStatusResponse}
|
|
68
68
|
*/
|
|
69
69
|
}, {
|
|
70
70
|
key: "adminGetRetentionStatus",
|
|
@@ -77,7 +77,7 @@ var AdminRetentionApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
77
77
|
/**
|
|
78
78
|
* Run a retention sweep now (admin)
|
|
79
79
|
* Sweeps immediately instead of waiting for the next 6h cycle. Runs inside the sweeper, so it can never overlap the scheduled run.
|
|
80
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
80
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetentionStatusResponse} and HTTP response
|
|
81
81
|
*/
|
|
82
82
|
}, {
|
|
83
83
|
key: "adminRunRetentionWithHttpInfo",
|
|
@@ -90,14 +90,14 @@ var AdminRetentionApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
90
90
|
var authNames = ['authorization'];
|
|
91
91
|
var contentTypes = [];
|
|
92
92
|
var accepts = ['application/json'];
|
|
93
|
-
var returnType =
|
|
93
|
+
var returnType = _RetentionStatusResponse["default"];
|
|
94
94
|
return this.apiClient.callApi('/api/v1/admin/retention/run', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
95
95
|
}
|
|
96
96
|
|
|
97
97
|
/**
|
|
98
98
|
* Run a retention sweep now (admin)
|
|
99
99
|
* Sweeps immediately instead of waiting for the next 6h cycle. Runs inside the sweeper, so it can never overlap the scheduled run.
|
|
100
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
100
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetentionStatusResponse}
|
|
101
101
|
*/
|
|
102
102
|
}, {
|
|
103
103
|
key: "adminRunRetention",
|