@ughuuu/gamend 1.0.1241 → 1.0.1250
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +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
|
@@ -5,10 +5,15 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
|
-
var _AdminConsumeItem400Response = _interopRequireDefault(require("../model/AdminConsumeItem400Response"));
|
|
9
8
|
var _AdminGrantCurrencyRequest = _interopRequireDefault(require("../model/AdminGrantCurrencyRequest"));
|
|
10
9
|
var _AdminGrantItemRequest = _interopRequireDefault(require("../model/AdminGrantItemRequest"));
|
|
10
|
+
var _AdminInventoryItemPage = _interopRequireDefault(require("../model/AdminInventoryItemPage"));
|
|
11
|
+
var _AdminLedgerEntryPage = _interopRequireDefault(require("../model/AdminLedgerEntryPage"));
|
|
11
12
|
var _AdminSpendCurrencyRequest = _interopRequireDefault(require("../model/AdminSpendCurrencyRequest"));
|
|
13
|
+
var _AdminWalletPage = _interopRequireDefault(require("../model/AdminWalletPage"));
|
|
14
|
+
var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
|
|
15
|
+
var _ItemQuantityResponse = _interopRequireDefault(require("../model/ItemQuantityResponse"));
|
|
16
|
+
var _WalletBalanceResponse = _interopRequireDefault(require("../model/WalletBalanceResponse"));
|
|
12
17
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
13
18
|
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); }
|
|
14
19
|
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
@@ -19,7 +24,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
19
24
|
* Gamend API
|
|
20
25
|
* 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 })) ```
|
|
21
26
|
*
|
|
22
|
-
* The version of the OpenAPI document: 1.0.
|
|
27
|
+
* The version of the OpenAPI document: 1.0.1250
|
|
23
28
|
*
|
|
24
29
|
*
|
|
25
30
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -47,7 +52,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
47
52
|
|
|
48
53
|
/**
|
|
49
54
|
* Consume items from a user (admin)
|
|
50
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
55
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ItemQuantityResponse} and HTTP response
|
|
51
56
|
*/
|
|
52
57
|
return _createClass(AdminEconomyApi, [{
|
|
53
58
|
key: "adminConsumeItemWithHttpInfo",
|
|
@@ -60,13 +65,13 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
60
65
|
var authNames = ['authorization'];
|
|
61
66
|
var contentTypes = [];
|
|
62
67
|
var accepts = ['application/json'];
|
|
63
|
-
var returnType =
|
|
68
|
+
var returnType = _ItemQuantityResponse["default"];
|
|
64
69
|
return this.apiClient.callApi('/api/v1/admin/economy/consume_item', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
65
70
|
}
|
|
66
71
|
|
|
67
72
|
/**
|
|
68
73
|
* Consume items from a user (admin)
|
|
69
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
74
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ItemQuantityResponse}
|
|
70
75
|
*/
|
|
71
76
|
}, {
|
|
72
77
|
key: "adminConsumeItem",
|
|
@@ -80,7 +85,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
80
85
|
* Grant currency to a user (admin)
|
|
81
86
|
* @param {Object} opts Optional parameters
|
|
82
87
|
* @param {module:model/AdminGrantCurrencyRequest} [adminGrantCurrencyRequest] Wallet change
|
|
83
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
88
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/WalletBalanceResponse} and HTTP response
|
|
84
89
|
*/
|
|
85
90
|
}, {
|
|
86
91
|
key: "adminGrantCurrencyWithHttpInfo",
|
|
@@ -94,7 +99,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
94
99
|
var authNames = ['authorization'];
|
|
95
100
|
var contentTypes = ['application/json'];
|
|
96
101
|
var accepts = ['application/json'];
|
|
97
|
-
var returnType =
|
|
102
|
+
var returnType = _WalletBalanceResponse["default"];
|
|
98
103
|
return this.apiClient.callApi('/api/v1/admin/economy/grant', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
99
104
|
}
|
|
100
105
|
|
|
@@ -102,7 +107,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
102
107
|
* Grant currency to a user (admin)
|
|
103
108
|
* @param {Object} opts Optional parameters
|
|
104
109
|
* @param {module:model/AdminGrantCurrencyRequest} opts.adminGrantCurrencyRequest Wallet change
|
|
105
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
110
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/WalletBalanceResponse}
|
|
106
111
|
*/
|
|
107
112
|
}, {
|
|
108
113
|
key: "adminGrantCurrency",
|
|
@@ -116,7 +121,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
116
121
|
* Grant items to a user (admin)
|
|
117
122
|
* @param {Object} opts Optional parameters
|
|
118
123
|
* @param {module:model/AdminGrantItemRequest} [adminGrantItemRequest] Item change
|
|
119
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
124
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ItemQuantityResponse} and HTTP response
|
|
120
125
|
*/
|
|
121
126
|
}, {
|
|
122
127
|
key: "adminGrantItemWithHttpInfo",
|
|
@@ -130,7 +135,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
130
135
|
var authNames = ['authorization'];
|
|
131
136
|
var contentTypes = ['application/json'];
|
|
132
137
|
var accepts = ['application/json'];
|
|
133
|
-
var returnType =
|
|
138
|
+
var returnType = _ItemQuantityResponse["default"];
|
|
134
139
|
return this.apiClient.callApi('/api/v1/admin/economy/grant_item', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
135
140
|
}
|
|
136
141
|
|
|
@@ -138,7 +143,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
138
143
|
* Grant items to a user (admin)
|
|
139
144
|
* @param {Object} opts Optional parameters
|
|
140
145
|
* @param {module:model/AdminGrantItemRequest} opts.adminGrantItemRequest Item change
|
|
141
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
146
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ItemQuantityResponse}
|
|
142
147
|
*/
|
|
143
148
|
}, {
|
|
144
149
|
key: "adminGrantItem",
|
|
@@ -155,7 +160,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
155
160
|
* @param {String} [item]
|
|
156
161
|
* @param {Number} [page = 1)]
|
|
157
162
|
* @param {Number} [pageSize = 25)]
|
|
158
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
163
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminInventoryItemPage} and HTTP response
|
|
159
164
|
*/
|
|
160
165
|
}, {
|
|
161
166
|
key: "adminListInventoryWithHttpInfo",
|
|
@@ -174,7 +179,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
174
179
|
var authNames = ['authorization'];
|
|
175
180
|
var contentTypes = [];
|
|
176
181
|
var accepts = ['application/json'];
|
|
177
|
-
var returnType =
|
|
182
|
+
var returnType = _AdminInventoryItemPage["default"];
|
|
178
183
|
return this.apiClient.callApi('/api/v1/admin/economy/items', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
179
184
|
}
|
|
180
185
|
|
|
@@ -185,7 +190,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
185
190
|
* @param {String} opts.item
|
|
186
191
|
* @param {Number} opts.page (default to 1)
|
|
187
192
|
* @param {Number} opts.pageSize (default to 25)
|
|
188
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
193
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminInventoryItemPage}
|
|
189
194
|
*/
|
|
190
195
|
}, {
|
|
191
196
|
key: "adminListInventory",
|
|
@@ -202,7 +207,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
202
207
|
* @param {String} [currency]
|
|
203
208
|
* @param {Number} [page = 1)]
|
|
204
209
|
* @param {Number} [pageSize = 25)]
|
|
205
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
210
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminLedgerEntryPage} and HTTP response
|
|
206
211
|
*/
|
|
207
212
|
}, {
|
|
208
213
|
key: "adminListLedgerWithHttpInfo",
|
|
@@ -221,7 +226,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
221
226
|
var authNames = ['authorization'];
|
|
222
227
|
var contentTypes = [];
|
|
223
228
|
var accepts = ['application/json'];
|
|
224
|
-
var returnType =
|
|
229
|
+
var returnType = _AdminLedgerEntryPage["default"];
|
|
225
230
|
return this.apiClient.callApi('/api/v1/admin/economy/ledger', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
226
231
|
}
|
|
227
232
|
|
|
@@ -232,7 +237,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
232
237
|
* @param {String} opts.currency
|
|
233
238
|
* @param {Number} opts.page (default to 1)
|
|
234
239
|
* @param {Number} opts.pageSize (default to 25)
|
|
235
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
240
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminLedgerEntryPage}
|
|
236
241
|
*/
|
|
237
242
|
}, {
|
|
238
243
|
key: "adminListLedger",
|
|
@@ -249,7 +254,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
249
254
|
* @param {String} [currency]
|
|
250
255
|
* @param {Number} [page = 1)]
|
|
251
256
|
* @param {Number} [pageSize = 25)]
|
|
252
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
257
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminWalletPage} and HTTP response
|
|
253
258
|
*/
|
|
254
259
|
}, {
|
|
255
260
|
key: "adminListWalletsWithHttpInfo",
|
|
@@ -268,7 +273,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
268
273
|
var authNames = ['authorization'];
|
|
269
274
|
var contentTypes = [];
|
|
270
275
|
var accepts = ['application/json'];
|
|
271
|
-
var returnType =
|
|
276
|
+
var returnType = _AdminWalletPage["default"];
|
|
272
277
|
return this.apiClient.callApi('/api/v1/admin/economy/wallets', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
273
278
|
}
|
|
274
279
|
|
|
@@ -279,7 +284,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
279
284
|
* @param {String} opts.currency
|
|
280
285
|
* @param {Number} opts.page (default to 1)
|
|
281
286
|
* @param {Number} opts.pageSize (default to 25)
|
|
282
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
287
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminWalletPage}
|
|
283
288
|
*/
|
|
284
289
|
}, {
|
|
285
290
|
key: "adminListWallets",
|
|
@@ -293,7 +298,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
293
298
|
* Spend currency from a user (admin)
|
|
294
299
|
* @param {Object} opts Optional parameters
|
|
295
300
|
* @param {module:model/AdminSpendCurrencyRequest} [adminSpendCurrencyRequest] Wallet change
|
|
296
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
301
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/WalletBalanceResponse} and HTTP response
|
|
297
302
|
*/
|
|
298
303
|
}, {
|
|
299
304
|
key: "adminSpendCurrencyWithHttpInfo",
|
|
@@ -307,7 +312,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
307
312
|
var authNames = ['authorization'];
|
|
308
313
|
var contentTypes = ['application/json'];
|
|
309
314
|
var accepts = ['application/json'];
|
|
310
|
-
var returnType =
|
|
315
|
+
var returnType = _WalletBalanceResponse["default"];
|
|
311
316
|
return this.apiClient.callApi('/api/v1/admin/economy/spend', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
312
317
|
}
|
|
313
318
|
|
|
@@ -315,7 +320,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
315
320
|
* Spend currency from a user (admin)
|
|
316
321
|
* @param {Object} opts Optional parameters
|
|
317
322
|
* @param {module:model/AdminSpendCurrencyRequest} opts.adminSpendCurrencyRequest Wallet change
|
|
318
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
323
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/WalletBalanceResponse}
|
|
319
324
|
*/
|
|
320
325
|
}, {
|
|
321
326
|
key: "adminSpendCurrency",
|
|
@@ -5,10 +5,11 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
|
-
var _AdminConsumeItem400Response = _interopRequireDefault(require("../model/AdminConsumeItem400Response"));
|
|
9
|
-
var _AdminListGroups200Response = _interopRequireDefault(require("../model/AdminListGroups200Response"));
|
|
10
|
-
var _AdminUpdateGroup200Response = _interopRequireDefault(require("../model/AdminUpdateGroup200Response"));
|
|
11
8
|
var _AdminUpdateGroupRequest = _interopRequireDefault(require("../model/AdminUpdateGroupRequest"));
|
|
9
|
+
var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
|
|
10
|
+
var _GroupPage = _interopRequireDefault(require("../model/GroupPage"));
|
|
11
|
+
var _GroupResponse = _interopRequireDefault(require("../model/GroupResponse"));
|
|
12
|
+
var _OkResponse = _interopRequireDefault(require("../model/OkResponse"));
|
|
12
13
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
13
14
|
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); }
|
|
14
15
|
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
@@ -19,7 +20,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
19
20
|
* Gamend API
|
|
20
21
|
* 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 })) ```
|
|
21
22
|
*
|
|
22
|
-
* The version of the OpenAPI document: 1.0.
|
|
23
|
+
* The version of the OpenAPI document: 1.0.1250
|
|
23
24
|
*
|
|
24
25
|
*
|
|
25
26
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -49,7 +50,7 @@ var AdminGroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
49
50
|
* Delete a group (admin)
|
|
50
51
|
* Admin-level group deletion.
|
|
51
52
|
* @param {String} id
|
|
52
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
53
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OkResponse} and HTTP response
|
|
53
54
|
*/
|
|
54
55
|
return _createClass(AdminGroupsApi, [{
|
|
55
56
|
key: "adminDeleteGroupWithHttpInfo",
|
|
@@ -68,7 +69,7 @@ var AdminGroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
68
69
|
var authNames = ['authorization'];
|
|
69
70
|
var contentTypes = [];
|
|
70
71
|
var accepts = ['application/json'];
|
|
71
|
-
var returnType =
|
|
72
|
+
var returnType = _OkResponse["default"];
|
|
72
73
|
return this.apiClient.callApi('/api/v1/admin/groups/{id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
73
74
|
}
|
|
74
75
|
|
|
@@ -76,7 +77,7 @@ var AdminGroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
76
77
|
* Delete a group (admin)
|
|
77
78
|
* Admin-level group deletion.
|
|
78
79
|
* @param {String} id
|
|
79
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
80
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OkResponse}
|
|
80
81
|
*/
|
|
81
82
|
}, {
|
|
82
83
|
key: "adminDeleteGroup",
|
|
@@ -97,7 +98,7 @@ var AdminGroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
97
98
|
* @param {module:model/String} [sortBy]
|
|
98
99
|
* @param {Number} [page]
|
|
99
100
|
* @param {Number} [pageSize]
|
|
100
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
101
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GroupPage} and HTTP response
|
|
101
102
|
*/
|
|
102
103
|
}, {
|
|
103
104
|
key: "adminListGroupsWithHttpInfo",
|
|
@@ -119,7 +120,7 @@ var AdminGroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
119
120
|
var authNames = ['authorization'];
|
|
120
121
|
var contentTypes = [];
|
|
121
122
|
var accepts = ['application/json'];
|
|
122
|
-
var returnType =
|
|
123
|
+
var returnType = _GroupPage["default"];
|
|
123
124
|
return this.apiClient.callApi('/api/v1/admin/groups', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
124
125
|
}
|
|
125
126
|
|
|
@@ -134,7 +135,7 @@ var AdminGroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
134
135
|
* @param {module:model/String} opts.sortBy
|
|
135
136
|
* @param {Number} opts.page
|
|
136
137
|
* @param {Number} opts.pageSize
|
|
137
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
138
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GroupPage}
|
|
138
139
|
*/
|
|
139
140
|
}, {
|
|
140
141
|
key: "adminListGroups",
|
|
@@ -150,7 +151,7 @@ var AdminGroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
150
151
|
* @param {String} id
|
|
151
152
|
* @param {Object} opts Optional parameters
|
|
152
153
|
* @param {module:model/AdminUpdateGroupRequest} [adminUpdateGroupRequest] Update parameters
|
|
153
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
154
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GroupResponse} and HTTP response
|
|
154
155
|
*/
|
|
155
156
|
}, {
|
|
156
157
|
key: "adminUpdateGroupWithHttpInfo",
|
|
@@ -170,7 +171,7 @@ var AdminGroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
170
171
|
var authNames = ['authorization'];
|
|
171
172
|
var contentTypes = ['application/json'];
|
|
172
173
|
var accepts = ['application/json'];
|
|
173
|
-
var returnType =
|
|
174
|
+
var returnType = _GroupResponse["default"];
|
|
174
175
|
return this.apiClient.callApi('/api/v1/admin/groups/{id}', 'PATCH', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
175
176
|
}
|
|
176
177
|
|
|
@@ -180,7 +181,7 @@ var AdminGroupsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
180
181
|
* @param {String} id
|
|
181
182
|
* @param {Object} opts Optional parameters
|
|
182
183
|
* @param {module:model/AdminUpdateGroupRequest} opts.adminUpdateGroupRequest Update parameters
|
|
183
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
184
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GroupResponse}
|
|
184
185
|
*/
|
|
185
186
|
}, {
|
|
186
187
|
key: "adminUpdateGroup",
|
package/dist/api/AdminKVApi.js
CHANGED
|
@@ -5,12 +5,13 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
|
-
var _AdminConsumeItem400Response = _interopRequireDefault(require("../model/AdminConsumeItem400Response"));
|
|
9
8
|
var _AdminCreateKvEntryRequest = _interopRequireDefault(require("../model/AdminCreateKvEntryRequest"));
|
|
10
|
-
var
|
|
9
|
+
var _AdminKvEntryPage = _interopRequireDefault(require("../model/AdminKvEntryPage"));
|
|
10
|
+
var _AdminKvEntryResponse = _interopRequireDefault(require("../model/AdminKvEntryResponse"));
|
|
11
11
|
var _AdminUpdateKvEntryRequest = _interopRequireDefault(require("../model/AdminUpdateKvEntryRequest"));
|
|
12
|
-
var _AdminUpsertKv200Response = _interopRequireDefault(require("../model/AdminUpsertKv200Response"));
|
|
13
12
|
var _AdminUpsertKvRequest = _interopRequireDefault(require("../model/AdminUpsertKvRequest"));
|
|
13
|
+
var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
|
|
14
|
+
var _OkResponse = _interopRequireDefault(require("../model/OkResponse"));
|
|
14
15
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
15
16
|
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); }
|
|
16
17
|
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
@@ -21,7 +22,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
21
22
|
* Gamend API
|
|
22
23
|
* 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 })) ```
|
|
23
24
|
*
|
|
24
|
-
* The version of the OpenAPI document: 1.0.
|
|
25
|
+
* The version of the OpenAPI document: 1.0.1250
|
|
25
26
|
*
|
|
26
27
|
*
|
|
27
28
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -51,7 +52,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
51
52
|
* Create KV entry (admin)
|
|
52
53
|
* @param {Object} opts Optional parameters
|
|
53
54
|
* @param {module:model/AdminCreateKvEntryRequest} [adminCreateKvEntryRequest] KV entry
|
|
54
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
55
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminKvEntryResponse} and HTTP response
|
|
55
56
|
*/
|
|
56
57
|
return _createClass(AdminKVApi, [{
|
|
57
58
|
key: "adminCreateKvEntryWithHttpInfo",
|
|
@@ -65,7 +66,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
65
66
|
var authNames = ['authorization'];
|
|
66
67
|
var contentTypes = ['application/json'];
|
|
67
68
|
var accepts = ['application/json'];
|
|
68
|
-
var returnType =
|
|
69
|
+
var returnType = _AdminKvEntryResponse["default"];
|
|
69
70
|
return this.apiClient.callApi('/api/v1/admin/kv/entries', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
70
71
|
}
|
|
71
72
|
|
|
@@ -73,7 +74,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
73
74
|
* Create KV entry (admin)
|
|
74
75
|
* @param {Object} opts Optional parameters
|
|
75
76
|
* @param {module:model/AdminCreateKvEntryRequest} opts.adminCreateKvEntryRequest KV entry
|
|
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/AdminKvEntryResponse}
|
|
77
78
|
*/
|
|
78
79
|
}, {
|
|
79
80
|
key: "adminCreateKvEntry",
|
|
@@ -89,7 +90,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
89
90
|
* @param {Object} opts Optional parameters
|
|
90
91
|
* @param {String} [userId]
|
|
91
92
|
* @param {String} [lobbyId]
|
|
92
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
93
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OkResponse} and HTTP response
|
|
93
94
|
*/
|
|
94
95
|
}, {
|
|
95
96
|
key: "adminDeleteKvWithHttpInfo",
|
|
@@ -111,7 +112,7 @@ var AdminKVApi = 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 = _OkResponse["default"];
|
|
115
116
|
return this.apiClient.callApi('/api/v1/admin/kv', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
116
117
|
}
|
|
117
118
|
|
|
@@ -121,7 +122,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
121
122
|
* @param {Object} opts Optional parameters
|
|
122
123
|
* @param {String} opts.userId
|
|
123
124
|
* @param {String} opts.lobbyId
|
|
124
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
125
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OkResponse}
|
|
125
126
|
*/
|
|
126
127
|
}, {
|
|
127
128
|
key: "adminDeleteKv",
|
|
@@ -134,7 +135,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
134
135
|
/**
|
|
135
136
|
* Delete KV entry by id (admin)
|
|
136
137
|
* @param {String} id
|
|
137
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
138
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OkResponse} and HTTP response
|
|
138
139
|
*/
|
|
139
140
|
}, {
|
|
140
141
|
key: "adminDeleteKvEntryWithHttpInfo",
|
|
@@ -153,14 +154,14 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
153
154
|
var authNames = ['authorization'];
|
|
154
155
|
var contentTypes = [];
|
|
155
156
|
var accepts = ['application/json'];
|
|
156
|
-
var returnType =
|
|
157
|
+
var returnType = _OkResponse["default"];
|
|
157
158
|
return this.apiClient.callApi('/api/v1/admin/kv/entries/{id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
158
159
|
}
|
|
159
160
|
|
|
160
161
|
/**
|
|
161
162
|
* Delete KV entry by id (admin)
|
|
162
163
|
* @param {String} id
|
|
163
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
164
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OkResponse}
|
|
164
165
|
*/
|
|
165
166
|
}, {
|
|
166
167
|
key: "adminDeleteKvEntry",
|
|
@@ -179,7 +180,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
179
180
|
* @param {String} [userId]
|
|
180
181
|
* @param {String} [lobbyId]
|
|
181
182
|
* @param {Boolean} [globalOnly]
|
|
182
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
183
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminKvEntryPage} and HTTP response
|
|
183
184
|
*/
|
|
184
185
|
}, {
|
|
185
186
|
key: "adminListKvEntriesWithHttpInfo",
|
|
@@ -200,7 +201,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
200
201
|
var authNames = ['authorization'];
|
|
201
202
|
var contentTypes = [];
|
|
202
203
|
var accepts = ['application/json'];
|
|
203
|
-
var returnType =
|
|
204
|
+
var returnType = _AdminKvEntryPage["default"];
|
|
204
205
|
return this.apiClient.callApi('/api/v1/admin/kv/entries', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
205
206
|
}
|
|
206
207
|
|
|
@@ -213,7 +214,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
213
214
|
* @param {String} opts.userId
|
|
214
215
|
* @param {String} opts.lobbyId
|
|
215
216
|
* @param {Boolean} opts.globalOnly
|
|
216
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
217
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminKvEntryPage}
|
|
217
218
|
*/
|
|
218
219
|
}, {
|
|
219
220
|
key: "adminListKvEntries",
|
|
@@ -228,7 +229,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
228
229
|
* @param {String} id
|
|
229
230
|
* @param {Object} opts Optional parameters
|
|
230
231
|
* @param {module:model/AdminUpdateKvEntryRequest} [adminUpdateKvEntryRequest] KV entry patch
|
|
231
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
232
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminKvEntryResponse} and HTTP response
|
|
232
233
|
*/
|
|
233
234
|
}, {
|
|
234
235
|
key: "adminUpdateKvEntryWithHttpInfo",
|
|
@@ -248,7 +249,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
248
249
|
var authNames = ['authorization'];
|
|
249
250
|
var contentTypes = ['application/json'];
|
|
250
251
|
var accepts = ['application/json'];
|
|
251
|
-
var returnType =
|
|
252
|
+
var returnType = _AdminKvEntryResponse["default"];
|
|
252
253
|
return this.apiClient.callApi('/api/v1/admin/kv/entries/{id}', 'PATCH', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
253
254
|
}
|
|
254
255
|
|
|
@@ -257,7 +258,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
257
258
|
* @param {String} id
|
|
258
259
|
* @param {Object} opts Optional parameters
|
|
259
260
|
* @param {module:model/AdminUpdateKvEntryRequest} opts.adminUpdateKvEntryRequest KV entry patch
|
|
260
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
261
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminKvEntryResponse}
|
|
261
262
|
*/
|
|
262
263
|
}, {
|
|
263
264
|
key: "adminUpdateKvEntry",
|
|
@@ -271,7 +272,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
271
272
|
* Upsert KV by key (admin)
|
|
272
273
|
* @param {Object} opts Optional parameters
|
|
273
274
|
* @param {module:model/AdminUpsertKvRequest} [adminUpsertKvRequest] KV upsert
|
|
274
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
275
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminKvEntryResponse} and HTTP response
|
|
275
276
|
*/
|
|
276
277
|
}, {
|
|
277
278
|
key: "adminUpsertKvWithHttpInfo",
|
|
@@ -285,7 +286,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
285
286
|
var authNames = ['authorization'];
|
|
286
287
|
var contentTypes = ['application/json'];
|
|
287
288
|
var accepts = ['application/json'];
|
|
288
|
-
var returnType =
|
|
289
|
+
var returnType = _AdminKvEntryResponse["default"];
|
|
289
290
|
return this.apiClient.callApi('/api/v1/admin/kv', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
290
291
|
}
|
|
291
292
|
|
|
@@ -293,7 +294,7 @@ var AdminKVApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
293
294
|
* Upsert KV by key (admin)
|
|
294
295
|
* @param {Object} opts Optional parameters
|
|
295
296
|
* @param {module:model/AdminUpsertKvRequest} opts.adminUpsertKvRequest KV upsert
|
|
296
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
297
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminKvEntryResponse}
|
|
297
298
|
*/
|
|
298
299
|
}, {
|
|
299
300
|
key: "adminUpsertKv",
|