@ughuuu/gamend 1.0.1239 → 1.0.1241
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 +74 -28
- package/dist/ApiClient.js +1 -1
- package/dist/api/AdminAnalyticsApi.js +1 -1
- package/dist/api/AdminChatApi.js +1 -1
- package/dist/api/AdminEconomyApi.js +5 -4
- package/dist/api/AdminGroupsApi.js +1 -1
- package/dist/api/AdminKVApi.js +5 -4
- package/dist/api/AdminLeaderboardsApi.js +9 -9
- package/dist/api/AdminLobbiesApi.js +1 -1
- package/dist/api/AdminMatchmakingApi.js +1 -1
- package/dist/api/AdminNotificationsApi.js +1 -1
- package/dist/api/AdminPushApi.js +1 -1
- package/dist/api/AdminQuestsApi.js +17 -14
- package/dist/api/AdminReadyChecksApi.js +1 -1
- package/dist/api/AdminRetentionApi.js +1 -1
- package/dist/api/AdminSessionsApi.js +1 -1
- package/dist/api/AdminStorageApi.js +1 -1
- package/dist/api/AdminTournamentsApi.js +9 -8
- package/dist/api/AdminUsersApi.js +1 -1
- package/dist/api/AuthenticationApi.js +22 -21
- package/dist/api/ChatApi.js +77 -69
- package/dist/api/ClientLogsApi.js +1 -1
- package/dist/api/EconomyApi.js +1 -1
- package/dist/api/FriendsApi.js +27 -25
- package/dist/api/GroupsApi.js +66 -65
- package/dist/api/HealthApi.js +1 -1
- package/dist/api/HooksApi.js +1 -1
- package/dist/api/KVApi.js +1 -1
- package/dist/api/LeaderboardsApi.js +31 -32
- package/dist/api/LobbiesApi.js +34 -34
- package/dist/api/MatchmakingApi.js +1 -1
- package/dist/api/NotificationsApi.js +14 -14
- package/dist/api/PartiesApi.js +75 -54
- package/dist/api/PaymentsApi.js +1 -1
- package/dist/api/PushApi.js +13 -13
- package/dist/api/QuestsApi.js +1 -1
- package/dist/api/ReadyChecksApi.js +5 -4
- package/dist/api/SignalingApi.js +1 -1
- package/dist/api/StatsApi.js +1 -1
- package/dist/api/TimeApi.js +1 -1
- package/dist/api/TournamentsApi.js +58 -45
- package/dist/api/UsersApi.js +35 -36
- package/dist/index.js +460 -138
- package/dist/model/AcceptPartyInviteRequest.js +1 -1
- package/dist/model/AdminCancelMatchmakingTicket200Response.js +1 -1
- package/dist/model/AdminCancelReadyCheck200Response.js +1 -1
- package/dist/model/AdminCancelReadyCheck200ResponseData.js +1 -1
- package/dist/model/AdminClaimQuestRequest.js +127 -0
- package/dist/model/AdminConsumeItem400Response.js +1 -1
- package/dist/model/AdminCreateChatFilterWordRequest.js +1 -1
- package/dist/model/AdminCreateChatMute200Response.js +1 -1
- package/dist/model/AdminCreateChatMuteRequest.js +1 -1
- package/dist/model/AdminCreateKvEntryRequest.js +154 -0
- package/dist/model/AdminCreateLeaderboard200Response.js +1 -1
- package/dist/model/AdminCreateLeaderboard200ResponseData.js +1 -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/{ListTournaments200ResponseDataInner.js → AdminCreateTournamentRequest.js} +80 -85
- package/dist/model/AdminDeleteChatConversation200Response.js +1 -1
- package/dist/model/AdminDeleteChatConversation200ResponseData.js +1 -1
- package/dist/model/AdminDeleteChatFilterWordsByLang200Response.js +1 -1
- package/dist/model/AdminDrawTournament200Response.js +1 -1
- package/dist/model/AdminDrawTournament200ResponseData.js +1 -1
- package/dist/model/AdminGetAnalyticsCounts200Response.js +1 -1
- package/dist/model/AdminGetAnalyticsCounts200ResponseTotalsInner.js +1 -1
- package/dist/model/AdminGetAnalyticsDaily200Response.js +1 -1
- package/dist/model/AdminGetAnalyticsDaily200ResponseSeriesInner.js +1 -1
- package/dist/model/AdminGetAnalyticsEconomy200Response.js +1 -1
- package/dist/model/AdminGetAnalyticsEconomy200ResponseFlowInner.js +1 -1
- package/dist/model/AdminGetAnalyticsEconomy200ResponseTotalsInner.js +1 -1
- package/dist/model/AdminGetAnalyticsSummary200Response.js +1 -1
- package/dist/model/AdminGrantCurrencyRequest.js +160 -0
- package/dist/model/AdminGrantItemRequest.js +1 -1
- package/dist/model/AdminGrantQuestRequest.js +127 -0
- package/dist/model/AdminImportChatFilterWords200Response.js +1 -1
- package/dist/model/AdminImportChatFilterWordsRequest.js +1 -1
- package/dist/model/AdminLeaderboardIconUploadUrlRequest.js +112 -0
- package/dist/model/AdminListChatFilterWords200Response.js +1 -1
- package/dist/model/AdminListChatMessages200Response.js +1 -1
- package/dist/model/AdminListChatMessages200ResponseDataInner.js +1 -1
- package/dist/model/AdminListChatMutes200Response.js +1 -1
- package/dist/model/AdminListChatMutes200ResponseDataInner.js +1 -1
- package/dist/model/AdminListChatReports200Response.js +1 -1
- package/dist/model/AdminListGroups200Response.js +1 -1
- package/dist/model/AdminListKvEntries200Response.js +1 -1
- package/dist/model/AdminListLobbies200Response.js +1 -1
- package/dist/model/AdminListLobbies200ResponseDataInner.js +1 -1
- package/dist/model/AdminListMatchmakingTickets200Response.js +1 -1
- package/dist/model/AdminListMatchmakingTickets200ResponseDataInner.js +1 -1
- package/dist/model/AdminListNotifications200Response.js +1 -1
- package/dist/model/AdminListNotifications200ResponseDataInner.js +1 -1
- package/dist/model/AdminListPushTokens200Response.js +1 -1
- package/dist/model/AdminListPushTokens200ResponseDataInner.js +1 -1
- package/dist/model/AdminListQuestProgress200Response.js +1 -1
- package/dist/model/AdminListQuestProgress200ResponseDataInner.js +1 -1
- package/dist/model/AdminListQuests200Response.js +1 -1
- package/dist/model/AdminListQuests200ResponseDataInner.js +1 -1
- package/dist/model/AdminListReadyChecks200Response.js +1 -1
- package/dist/model/AdminListSessions200Response.js +1 -1
- package/dist/model/AdminListSessions200ResponseDataInner.js +1 -1
- package/dist/model/AdminListStorageObjects200Response.js +1 -1
- package/dist/model/AdminListStorageObjects200ResponseDataInner.js +1 -1
- package/dist/model/AdminListStorageObjects200ResponseUsage.js +1 -1
- package/dist/model/AdminMatchmakingStats200Response.js +1 -1
- package/dist/model/AdminMatchmakingStats200ResponseData.js +1 -1
- package/dist/model/AdminQuestIconUploadUrlRequest.js +112 -0
- package/dist/model/AdminResetQuestRequest.js +1 -1
- package/dist/model/AdminResolveChatReport200Response.js +1 -1
- package/dist/model/AdminResolveChatReport200ResponseData.js +1 -1
- package/dist/model/AdminResolveChatReportRequest.js +1 -1
- package/dist/model/AdminResolveTournamentMatchRequest.js +1 -1
- package/dist/model/AdminRunRetention200Response.js +1 -1
- package/dist/model/AdminSendPush200Response.js +1 -1
- package/dist/model/AdminSendPushRequest.js +1 -1
- package/dist/model/AdminSetLeaderboardIconRequest.js +112 -0
- package/dist/model/AdminSetQuestIconRequest.js +1 -1
- package/dist/model/AdminSetTournamentIconRequest.js +112 -0
- package/dist/model/AdminSpendCurrencyRequest.js +1 -1
- package/dist/model/AdminSubmitLeaderboardScoreRequest.js +1 -1
- package/dist/model/AdminTestChatPhrase200Response.js +1 -1
- package/dist/model/AdminTestChatPhrase200ResponseData.js +1 -1
- package/dist/model/AdminTestChatPhrase200ResponseDataHitsInner.js +1 -1
- package/dist/model/AdminTestChatPhraseRequest.js +1 -1
- package/dist/model/AdminTournamentIconUploadUrlRequest.js +1 -1
- package/dist/model/AdminUpdateChatFilterWord200Response.js +1 -1
- package/dist/model/AdminUpdateChatFilterWord200ResponseData.js +1 -1
- package/dist/model/AdminUpdateChatFilterWordRequest.js +1 -1
- package/dist/model/AdminUpdateGroup200Response.js +1 -1
- package/dist/model/AdminUpdateGroupRequest.js +1 -1
- package/dist/model/AdminUpdateKvEntryRequest.js +1 -1
- package/dist/model/AdminUpdateLeaderboardRecord200Response.js +1 -1
- package/dist/model/AdminUpdateLeaderboardRecord200ResponseData.js +1 -1
- package/dist/model/AdminUpdateLeaderboardRecordRequest.js +1 -1
- package/dist/model/AdminUpdateLeaderboardRequest.js +1 -1
- package/dist/model/AdminUpdateLobby200Response.js +1 -1
- package/dist/model/AdminUpdateLobbyRequest.js +1 -1
- package/dist/model/AdminUpdateQuestRequest.js +350 -0
- package/dist/model/AdminUpdateTournamentRequest.js +1 -1
- package/dist/model/AdminUpdateUser200Response.js +1 -1
- package/dist/model/AdminUpdateUser200ResponseData.js +1 -1
- package/dist/model/AdminUpdateUserRequest.js +1 -1
- package/dist/model/AdminUpsertKv200Response.js +1 -1
- package/dist/model/AdminUpsertKv200ResponseData.js +1 -1
- package/dist/model/AdminUpsertKvRequest.js +1 -1
- package/dist/model/AuthProvidersResponse.js +1 -1
- package/dist/model/BlockedFriendship.js +1 -1
- package/dist/model/BlockedFriendshipPage.js +1 -1
- package/dist/model/CallHook200Response.js +1 -1
- package/dist/model/CallHookRequest.js +1 -1
- package/dist/model/CancelPartyInviteRequest.js +1 -1
- package/dist/model/{ListChatMessages200ResponseDataInner.js → ChatMessage.js} +87 -41
- package/dist/model/{ListNotifications200Response.js → ChatMessagePage.js} +57 -34
- package/dist/model/{ListTournaments200Response.js → ChatMessageResponse.js} +45 -40
- package/dist/model/{ListGroupMutes200ResponseDataInner.js → ChatMuteRecord.js} +71 -29
- package/dist/model/ChatMuteRecordPage.js +147 -0
- package/dist/model/{ListRecordsAroundUser200Response.js → ChatMuteRecordResponse.js} +45 -40
- package/dist/model/ChatReadCursor.js +151 -0
- package/dist/model/ChatReadCursorResponse.js +115 -0
- package/dist/model/ChatUnread.js +109 -0
- package/dist/model/ChatUnreadResponse.js +115 -0
- package/dist/model/ClaimQuest200Response.js +1 -1
- package/dist/model/ClaimQuest200ResponseData.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/ClientLogResult.js +1 -1
- package/dist/model/ClientLogSession.js +1 -1
- package/dist/model/CreateCurrentUserAvatarUploadUrlRequest.js +1 -1
- package/dist/model/CreateFriendRequestRequest.js +1 -1
- package/dist/model/CreateGroupIconUploadUrlRequest.js +112 -0
- package/dist/model/CreateGroupRequest.js +1 -1
- package/dist/model/CreateLobbyRequest.js +1 -1
- package/dist/model/CreatePartyRequest.js +1 -1
- package/dist/model/CurrentUser.js +1 -1
- package/dist/model/CurrentUserResponse.js +115 -0
- package/dist/model/DeclinePartyInviteRequest.js +1 -1
- package/dist/model/DeleteNotificationsRequest.js +1 -1
- package/dist/model/DeletedCount.js +109 -0
- package/dist/model/DeletedCountResponse.js +115 -0
- package/dist/model/DemoteGroupMemberRequest.js +1 -1
- package/dist/model/DeviceLoginRequest.js +1 -1
- package/dist/model/ErrorResponse.js +4 -26
- package/dist/model/Friend.js +1 -1
- package/dist/model/FriendPage.js +1 -1
- package/dist/model/FriendRequest.js +1 -1
- package/dist/model/FriendRequestLists.js +1 -1
- package/dist/model/FriendRequestMeta.js +1 -1
- package/dist/model/FriendRequestResponse.js +115 -0
- package/dist/model/FriendRequestsResponse.js +1 -1
- package/dist/model/GetCurrentUserInventory200Response.js +1 -1
- package/dist/model/GetKv200Response.js +1 -1
- package/dist/model/GetMyReadyCheck200Response.js +1 -1
- package/dist/model/GetMyReadyCheck200ResponseLobby.js +1 -1
- package/dist/model/GetMyReadyCheck200ResponseParty.js +1 -1
- package/dist/model/GetServerTime200Response.js +1 -1
- package/dist/model/GetStats200Response.js +1 -1
- package/dist/model/GetStats200ResponseData.js +1 -1
- package/dist/model/Group.js +1 -1
- package/dist/model/GroupInvite.js +13 -14
- package/dist/model/GroupInviteOutcome.js +132 -0
- package/dist/model/GroupInviteOutcomeResponse.js +115 -0
- package/dist/model/GroupInvitePage.js +1 -1
- package/dist/model/GroupJoinRequest.js +1 -1
- package/dist/model/GroupJoinRequestPage.js +1 -1
- package/dist/model/GroupJoinRequestResponse.js +115 -0
- package/dist/model/GroupMember.js +1 -1
- package/dist/model/GroupMemberPage.js +1 -1
- package/dist/model/GroupMemberResponse.js +115 -0
- package/dist/model/GroupPage.js +1 -1
- package/dist/model/GroupResponse.js +115 -0
- package/dist/model/HealthResponse.js +1 -1
- package/dist/model/InviteToGroupRequest.js +1 -1
- package/dist/model/InviteToPartyRequest.js +1 -1
- package/dist/model/{ChatUnreadCount200ResponseData.js → JoinLobbyRequest.js} +26 -21
- package/dist/model/KickGroupMemberRequest.js +1 -1
- package/dist/model/KickPartyMemberRequest.js +1 -1
- package/dist/model/KickUserRequest.js +113 -0
- package/dist/model/{ResolveLeaderboardSlugs200ResponseDataValue.js → Leaderboard.js} +90 -45
- package/dist/model/{ListGroupMutes200Response.js → LeaderboardPage.js} +57 -34
- package/dist/model/{GetMyRecord200ResponseData.js → LeaderboardRecord.js} +66 -31
- package/dist/model/LeaderboardRecordPage.js +147 -0
- package/dist/model/{ListPushTokens200Response.js → LeaderboardRecordResponse.js} +44 -47
- package/dist/model/LeaderboardResponse.js +115 -0
- package/dist/model/LeaderboardsBySlugResponse.js +113 -0
- package/dist/model/LinkDeviceRequest.js +1 -1
- package/dist/model/LinkedProviders.js +1 -1
- package/dist/model/ListCurrentUserLedger200Response.js +1 -1
- package/dist/model/ListCurrentUserLedger200ResponseDataInner.js +1 -1
- package/dist/model/Lobby.js +1 -1
- package/dist/model/LobbyPage.js +1 -1
- package/dist/model/LobbyResponse.js +6 -49
- package/dist/model/LobbyStats.js +1 -1
- package/dist/model/LobbyStatsResponse.js +1 -1
- package/dist/model/LoginRequest.js +1 -1
- package/dist/model/MarkChatReadRequest.js +1 -1
- package/dist/model/MatchmakingCancel200Response.js +1 -1
- package/dist/model/MatchmakingJoin201Response.js +1 -1
- package/dist/model/MatchmakingJoin201ResponseData.js +1 -1
- package/dist/model/MatchmakingJoinRequest.js +1 -1
- package/dist/model/MatchmakingMyTicket200Response.js +1 -1
- package/dist/model/MatchmakingMyTicket200ResponseData.js +1 -1
- package/dist/model/MatchmakingStats200Response.js +1 -1
- package/dist/model/MatchmakingStats200ResponseData.js +1 -1
- package/dist/model/MatchmakingStats200ResponseDataQueuesInner.js +1 -1
- package/dist/model/MuteGroupMemberRequest.js +1 -1
- package/dist/model/{ProfileUpdate.js → MuteLobbyMemberRequest.js} +41 -56
- package/dist/model/MutePartyMemberRequest.js +135 -0
- package/dist/model/{ListNotifications200ResponseDataInner.js → Notification.js} +70 -37
- package/dist/model/NotificationPage.js +147 -0
- package/dist/model/NotificationResponse.js +115 -0
- package/dist/model/OAuthAuthorization.js +1 -1
- package/dist/model/OAuthAuthorizationResponse.js +115 -0
- package/dist/model/OAuthResult.js +1 -1
- package/dist/model/OAuthResultResponse.js +1 -1
- package/dist/model/OAuthSessionData.js +1 -1
- package/dist/model/OAuthSessionDataDetails.js +1 -1
- package/dist/model/OAuthSessionStatus.js +21 -21
- package/dist/model/OAuthSessionStatusResponse.js +115 -0
- package/dist/model/OauthApiCallbackRequest.js +1 -1
- package/dist/model/OauthCallbackApiAppleIosRequest.js +1 -1
- package/dist/model/OauthGoogleIdTokenRequest.js +1 -1
- package/dist/model/{AvatarUpdate.js → OkResponse.js} +22 -37
- package/dist/model/OpenLobbyReadyCheck201Response.js +1 -1
- package/dist/model/OpenLobbyReadyCheckRequest.js +1 -1
- package/dist/model/{ChatUnreadCount200Response.js → OpenPartyReadyCheckRequest.js} +31 -27
- package/dist/model/PageMeta.js +1 -1
- package/dist/model/Party.js +1 -1
- package/dist/model/PartyCreateLobbyRequest.js +1 -1
- package/dist/model/PartyInvite.js +1 -1
- package/dist/model/PartyInvitePage.js +147 -0
- package/dist/model/PartyJoinLobbyRequest.js +1 -1
- package/dist/model/PartyResponse.js +115 -0
- package/dist/model/PartyStats.js +1 -1
- package/dist/model/PartyStatsResponse.js +1 -1
- package/dist/model/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/PublicUser.js +1 -1
- package/dist/model/PublicUserPage.js +1 -1
- package/dist/model/PublicUserResponse.js +115 -0
- package/dist/model/{DeletePushToken200Response.js → PushToken.js} +74 -71
- package/dist/model/{ListLeaderboardRecords200Response.js → PushTokenPage.js} +57 -34
- package/dist/model/PushTokenResponse.js +115 -0
- package/dist/model/QuestStats200Response.js +1 -1
- package/dist/model/QuestStats200ResponseData.js +1 -1
- package/dist/model/QuickJoinRequest.js +1 -1
- package/dist/model/RefreshTokenRequest.js +1 -1
- package/dist/model/RegisterPushTokenRequest.js +1 -1
- package/dist/model/ReportChatMessageRequest.js +1 -1
- package/dist/model/ResolveLeaderboardSlugsRequest.js +1 -1
- package/dist/model/RespondReadyCheckRequest.js +1 -1
- package/dist/model/SendChatMessageRequest.js +1 -1
- package/dist/model/SendNotificationRequest.js +1 -1
- package/dist/model/Session.js +1 -1
- package/dist/model/SessionResponse.js +1 -1
- package/dist/model/SetCurrentUserAvatarRequest.js +112 -0
- package/dist/model/{StatusResponse.js → SetGroupIconRequest.js} +28 -29
- package/dist/model/SetLobbyStateRequest.js +1 -1
- package/dist/model/SignalingStats200Response.js +1 -1
- package/dist/model/SignalingStats200ResponseData.js +1 -1
- package/dist/model/Tournament.js +341 -0
- package/dist/model/TournamentBracket.js +186 -0
- package/dist/model/TournamentBracketPage.js +147 -0
- package/dist/model/TournamentEntry.js +211 -0
- package/dist/model/TournamentEntryPage.js +147 -0
- package/dist/model/TournamentEntryResponse.js +115 -0
- package/dist/model/{TournamentMyMatch200Response.js → TournamentMatch.js} +100 -28
- package/dist/model/TournamentMatchResponse.js +115 -0
- package/dist/model/{ListLeaderboards200Response.js → TournamentPage.js} +57 -34
- package/dist/model/TournamentPlacement.js +200 -0
- package/dist/model/TournamentResponse.js +115 -0
- package/dist/model/TournamentStandings.js +163 -0
- package/dist/model/{ListChatMessages200Response.js → TournamentStandingsResponse.js} +44 -47
- package/dist/model/UnmuteGroupMemberRequest.js +113 -0
- package/dist/model/UnmuteLobbyMemberRequest.js +1 -1
- package/dist/model/UnmutePartyMemberRequest.js +113 -0
- package/dist/model/UpdateChatMessageRequest.js +1 -1
- package/dist/model/UpdateCurrentUserDisplayNameRequest.js +1 -1
- package/dist/model/UpdateCurrentUserPasswordRequest.js +1 -1
- package/dist/model/UpdateCurrentUserUsernameRequest.js +1 -1
- package/dist/model/UpdateGroupRequest.js +1 -1
- package/dist/model/UpdateLobbyRequest.js +1 -1
- package/dist/model/UpdatePartyRequest.js +1 -1
- package/dist/model/UploadTicket.js +1 -1
- package/dist/model/UploadTicketResponse.js +115 -0
- package/dist/model/UserBrief.js +1 -1
- package/dist/model/UserBriefPage.js +1 -1
- package/dist/model/UserQuests200Response.js +1 -1
- package/dist/model/UserQuests200ResponseDataInner.js +1 -1
- package/dist/model/UserQuests200ResponseDataInnerObjectivesInner.js +1 -1
- package/dist/model/UserQuests200ResponseDataInnerProgress.js +1 -1
- package/dist/model/UserQuests200ResponseDataInnerRewardsInner.js +1 -1
- package/dist/model/UserQuests200ResponseMeta.js +1 -1
- package/package.json +1 -1
- package/dist/model/DeleteNotifications200Response.js +0 -91
- package/dist/model/DeleteNotifications200ResponseData.js +0 -86
- package/dist/model/GetMyRecord200Response.js +0 -91
- package/dist/model/ListGroupMutes200ResponseMeta.js +0 -109
- package/dist/model/ResolveLeaderboardSlugs200Response.js +0 -89
|
@@ -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
|
|
9
|
-
var
|
|
10
|
-
var
|
|
11
|
-
var
|
|
8
|
+
var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
|
|
9
|
+
var _OkResponse = _interopRequireDefault(require("../model/OkResponse"));
|
|
10
|
+
var _TournamentBracketPage = _interopRequireDefault(require("../model/TournamentBracketPage"));
|
|
11
|
+
var _TournamentEntryPage = _interopRequireDefault(require("../model/TournamentEntryPage"));
|
|
12
|
+
var _TournamentEntryResponse = _interopRequireDefault(require("../model/TournamentEntryResponse"));
|
|
13
|
+
var _TournamentMatchResponse = _interopRequireDefault(require("../model/TournamentMatchResponse"));
|
|
14
|
+
var _TournamentPage = _interopRequireDefault(require("../model/TournamentPage"));
|
|
15
|
+
var _TournamentResponse = _interopRequireDefault(require("../model/TournamentResponse"));
|
|
16
|
+
var _TournamentStandingsResponse = _interopRequireDefault(require("../model/TournamentStandingsResponse"));
|
|
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.1241
|
|
23
28
|
*
|
|
24
29
|
*
|
|
25
30
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -47,8 +52,8 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
47
52
|
|
|
48
53
|
/**
|
|
49
54
|
* Tournament details (with the caller's participation when authenticated)
|
|
50
|
-
* @param {String} id
|
|
51
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
55
|
+
* @param {String} id Tournament id, or a slug for its current occurrence
|
|
56
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TournamentResponse} and HTTP response
|
|
52
57
|
*/
|
|
53
58
|
return _createClass(TournamentsApi, [{
|
|
54
59
|
key: "getTournamentWithHttpInfo",
|
|
@@ -67,14 +72,14 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
67
72
|
var authNames = ['authorization'];
|
|
68
73
|
var contentTypes = [];
|
|
69
74
|
var accepts = ['application/json'];
|
|
70
|
-
var returnType =
|
|
75
|
+
var returnType = _TournamentResponse["default"];
|
|
71
76
|
return this.apiClient.callApi('/api/v1/tournaments/{id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
72
77
|
}
|
|
73
78
|
|
|
74
79
|
/**
|
|
75
80
|
* Tournament details (with the caller's participation when authenticated)
|
|
76
|
-
* @param {String} id
|
|
77
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
81
|
+
* @param {String} id Tournament id, or a slug for its current occurrence
|
|
82
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TournamentResponse}
|
|
78
83
|
*/
|
|
79
84
|
}, {
|
|
80
85
|
key: "getTournament",
|
|
@@ -86,8 +91,9 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
86
91
|
|
|
87
92
|
/**
|
|
88
93
|
* Register as an entry leader
|
|
89
|
-
*
|
|
90
|
-
* @
|
|
94
|
+
* Answers the new entry. Refusals: `registration_closed`, `tournament_full` or a game hook's `rejected` (403), `already_registered` (409).
|
|
95
|
+
* @param {String} id Tournament id, or a slug for its current occurrence
|
|
96
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TournamentEntryResponse} and HTTP response
|
|
91
97
|
*/
|
|
92
98
|
}, {
|
|
93
99
|
key: "joinTournamentWithHttpInfo",
|
|
@@ -106,14 +112,15 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
106
112
|
var authNames = ['authorization'];
|
|
107
113
|
var contentTypes = [];
|
|
108
114
|
var accepts = ['application/json'];
|
|
109
|
-
var returnType =
|
|
115
|
+
var returnType = _TournamentEntryResponse["default"];
|
|
110
116
|
return this.apiClient.callApi('/api/v1/tournaments/{id}/join', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
111
117
|
}
|
|
112
118
|
|
|
113
119
|
/**
|
|
114
120
|
* Register as an entry leader
|
|
115
|
-
*
|
|
116
|
-
* @
|
|
121
|
+
* Answers the new entry. Refusals: `registration_closed`, `tournament_full` or a game hook's `rejected` (403), `already_registered` (409).
|
|
122
|
+
* @param {String} id Tournament id, or a slug for its current occurrence
|
|
123
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TournamentEntryResponse}
|
|
117
124
|
*/
|
|
118
125
|
}, {
|
|
119
126
|
key: "joinTournament",
|
|
@@ -125,8 +132,9 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
125
132
|
|
|
126
133
|
/**
|
|
127
134
|
* Withdraw the caller's entry (before the draw)
|
|
128
|
-
*
|
|
129
|
-
* @
|
|
135
|
+
* Refusals: `not_registered` (404), `already_drawn` (409), a game hook's `rejected` (403).
|
|
136
|
+
* @param {String} id Tournament id, or a slug for its current occurrence
|
|
137
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OkResponse} and HTTP response
|
|
130
138
|
*/
|
|
131
139
|
}, {
|
|
132
140
|
key: "leaveTournamentWithHttpInfo",
|
|
@@ -145,14 +153,15 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
145
153
|
var authNames = ['authorization'];
|
|
146
154
|
var contentTypes = [];
|
|
147
155
|
var accepts = ['application/json'];
|
|
148
|
-
var returnType =
|
|
156
|
+
var returnType = _OkResponse["default"];
|
|
149
157
|
return this.apiClient.callApi('/api/v1/tournaments/{id}/join', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
150
158
|
}
|
|
151
159
|
|
|
152
160
|
/**
|
|
153
161
|
* Withdraw the caller's entry (before the draw)
|
|
154
|
-
*
|
|
155
|
-
* @
|
|
162
|
+
* Refusals: `not_registered` (404), `already_drawn` (409), a game hook's `rejected` (403).
|
|
163
|
+
* @param {String} id Tournament id, or a slug for its current occurrence
|
|
164
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OkResponse}
|
|
156
165
|
*/
|
|
157
166
|
}, {
|
|
158
167
|
key: "leaveTournament",
|
|
@@ -169,7 +178,7 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
169
178
|
* @param {String} [slug] Occurrence history
|
|
170
179
|
* @param {Number} [page = 1)]
|
|
171
180
|
* @param {Number} [pageSize = 25)]
|
|
172
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
181
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TournamentPage} and HTTP response
|
|
173
182
|
*/
|
|
174
183
|
}, {
|
|
175
184
|
key: "listTournamentsWithHttpInfo",
|
|
@@ -188,7 +197,7 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
188
197
|
var authNames = [];
|
|
189
198
|
var contentTypes = [];
|
|
190
199
|
var accepts = ['application/json'];
|
|
191
|
-
var returnType =
|
|
200
|
+
var returnType = _TournamentPage["default"];
|
|
192
201
|
return this.apiClient.callApi('/api/v1/tournaments', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
193
202
|
}
|
|
194
203
|
|
|
@@ -199,7 +208,7 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
199
208
|
* @param {String} opts.slug Occurrence history
|
|
200
209
|
* @param {Number} opts.page (default to 1)
|
|
201
210
|
* @param {Number} opts.pageSize (default to 25)
|
|
202
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
211
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TournamentPage}
|
|
203
212
|
*/
|
|
204
213
|
}, {
|
|
205
214
|
key: "listTournaments",
|
|
@@ -211,12 +220,13 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
211
220
|
|
|
212
221
|
/**
|
|
213
222
|
* Brackets and their matches (paginated by bracket)
|
|
214
|
-
*
|
|
223
|
+
* A page of brackets, each with its matches and the entries they name. With `index`, a page holding that one bracket.
|
|
224
|
+
* @param {String} id Tournament id, or a slug for its current occurrence
|
|
215
225
|
* @param {Object} opts Optional parameters
|
|
216
226
|
* @param {Number} [index] Return only this bracket
|
|
217
227
|
* @param {Number} [page = 1)]
|
|
218
228
|
* @param {Number} [pageSize = 10)]
|
|
219
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
229
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TournamentBracketPage} and HTTP response
|
|
220
230
|
*/
|
|
221
231
|
}, {
|
|
222
232
|
key: "tournamentBracketWithHttpInfo",
|
|
@@ -240,18 +250,19 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
240
250
|
var authNames = [];
|
|
241
251
|
var contentTypes = [];
|
|
242
252
|
var accepts = ['application/json'];
|
|
243
|
-
var returnType =
|
|
253
|
+
var returnType = _TournamentBracketPage["default"];
|
|
244
254
|
return this.apiClient.callApi('/api/v1/tournaments/{id}/bracket', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
245
255
|
}
|
|
246
256
|
|
|
247
257
|
/**
|
|
248
258
|
* Brackets and their matches (paginated by bracket)
|
|
249
|
-
*
|
|
259
|
+
* A page of brackets, each with its matches and the entries they name. With `index`, a page holding that one bracket.
|
|
260
|
+
* @param {String} id Tournament id, or a slug for its current occurrence
|
|
250
261
|
* @param {Object} opts Optional parameters
|
|
251
262
|
* @param {Number} opts.index Return only this bracket
|
|
252
263
|
* @param {Number} opts.page (default to 1)
|
|
253
264
|
* @param {Number} opts.pageSize (default to 10)
|
|
254
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
265
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TournamentBracketPage}
|
|
255
266
|
*/
|
|
256
267
|
}, {
|
|
257
268
|
key: "tournamentBracket",
|
|
@@ -263,12 +274,12 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
263
274
|
|
|
264
275
|
/**
|
|
265
276
|
* Registered entries (paginated)
|
|
266
|
-
* @param {String} id
|
|
277
|
+
* @param {String} id Tournament id, or a slug for its current occurrence
|
|
267
278
|
* @param {Object} opts Optional parameters
|
|
268
279
|
* @param {module:model/String} [state]
|
|
269
280
|
* @param {Number} [page = 1)]
|
|
270
281
|
* @param {Number} [pageSize = 25)]
|
|
271
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
282
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TournamentEntryPage} and HTTP response
|
|
272
283
|
*/
|
|
273
284
|
}, {
|
|
274
285
|
key: "tournamentEntriesWithHttpInfo",
|
|
@@ -292,18 +303,18 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
292
303
|
var authNames = [];
|
|
293
304
|
var contentTypes = [];
|
|
294
305
|
var accepts = ['application/json'];
|
|
295
|
-
var returnType =
|
|
306
|
+
var returnType = _TournamentEntryPage["default"];
|
|
296
307
|
return this.apiClient.callApi('/api/v1/tournaments/{id}/entries', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
297
308
|
}
|
|
298
309
|
|
|
299
310
|
/**
|
|
300
311
|
* Registered entries (paginated)
|
|
301
|
-
* @param {String} id
|
|
312
|
+
* @param {String} id Tournament id, or a slug for its current occurrence
|
|
302
313
|
* @param {Object} opts Optional parameters
|
|
303
314
|
* @param {module:model/String} opts.state
|
|
304
315
|
* @param {Number} opts.page (default to 1)
|
|
305
316
|
* @param {Number} opts.pageSize (default to 25)
|
|
306
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
317
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TournamentEntryPage}
|
|
307
318
|
*/
|
|
308
319
|
}, {
|
|
309
320
|
key: "tournamentEntries",
|
|
@@ -314,9 +325,10 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
314
325
|
}
|
|
315
326
|
|
|
316
327
|
/**
|
|
317
|
-
* The caller's current unresolved match
|
|
318
|
-
*
|
|
319
|
-
* @
|
|
328
|
+
* The caller's current unresolved match
|
|
329
|
+
* 404 `no_current_match` when the caller has no entry, or no match waiting (between rounds, eliminated, or the tournament is over).
|
|
330
|
+
* @param {String} id Tournament id, or a slug for its current occurrence
|
|
331
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TournamentMatchResponse} and HTTP response
|
|
320
332
|
*/
|
|
321
333
|
}, {
|
|
322
334
|
key: "tournamentMyMatchWithHttpInfo",
|
|
@@ -335,14 +347,15 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
335
347
|
var authNames = ['authorization'];
|
|
336
348
|
var contentTypes = [];
|
|
337
349
|
var accepts = ['application/json'];
|
|
338
|
-
var returnType =
|
|
350
|
+
var returnType = _TournamentMatchResponse["default"];
|
|
339
351
|
return this.apiClient.callApi('/api/v1/tournaments/{id}/my_match', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
340
352
|
}
|
|
341
353
|
|
|
342
354
|
/**
|
|
343
|
-
* The caller's current unresolved match
|
|
344
|
-
*
|
|
345
|
-
* @
|
|
355
|
+
* The caller's current unresolved match
|
|
356
|
+
* 404 `no_current_match` when the caller has no entry, or no match waiting (between rounds, eliminated, or the tournament is over).
|
|
357
|
+
* @param {String} id Tournament id, or a slug for its current occurrence
|
|
358
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TournamentMatchResponse}
|
|
346
359
|
*/
|
|
347
360
|
}, {
|
|
348
361
|
key: "tournamentMyMatch",
|
|
@@ -354,8 +367,8 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
354
367
|
|
|
355
368
|
/**
|
|
356
369
|
* Placements, wins and champions
|
|
357
|
-
* @param {String} id
|
|
358
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
370
|
+
* @param {String} id Tournament id, or a slug for its current occurrence
|
|
371
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/TournamentStandingsResponse} and HTTP response
|
|
359
372
|
*/
|
|
360
373
|
}, {
|
|
361
374
|
key: "tournamentStandingsWithHttpInfo",
|
|
@@ -374,14 +387,14 @@ var TournamentsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
374
387
|
var authNames = [];
|
|
375
388
|
var contentTypes = [];
|
|
376
389
|
var accepts = ['application/json'];
|
|
377
|
-
var returnType =
|
|
390
|
+
var returnType = _TournamentStandingsResponse["default"];
|
|
378
391
|
return this.apiClient.callApi('/api/v1/tournaments/{id}/standings', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
379
392
|
}
|
|
380
393
|
|
|
381
394
|
/**
|
|
382
395
|
* Placements, wins and champions
|
|
383
|
-
* @param {String} id
|
|
384
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
396
|
+
* @param {String} id Tournament id, or a slug for its current occurrence
|
|
397
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TournamentStandingsResponse}
|
|
385
398
|
*/
|
|
386
399
|
}, {
|
|
387
400
|
key: "tournamentStandings",
|
package/dist/api/UsersApi.js
CHANGED
|
@@ -5,19 +5,18 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
|
-
var _AdminSetQuestIconRequest = _interopRequireDefault(require("../model/AdminSetQuestIconRequest"));
|
|
9
|
-
var _AvatarUpdate = _interopRequireDefault(require("../model/AvatarUpdate"));
|
|
10
8
|
var _CreateCurrentUserAvatarUploadUrlRequest = _interopRequireDefault(require("../model/CreateCurrentUserAvatarUploadUrlRequest"));
|
|
11
|
-
var
|
|
9
|
+
var _CurrentUserResponse = _interopRequireDefault(require("../model/CurrentUserResponse"));
|
|
12
10
|
var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
|
|
11
|
+
var _OkResponse = _interopRequireDefault(require("../model/OkResponse"));
|
|
13
12
|
var _PlayerStatsResponse = _interopRequireDefault(require("../model/PlayerStatsResponse"));
|
|
14
|
-
var _ProfileUpdate = _interopRequireDefault(require("../model/ProfileUpdate"));
|
|
15
|
-
var _PublicUser = _interopRequireDefault(require("../model/PublicUser"));
|
|
16
13
|
var _PublicUserPage = _interopRequireDefault(require("../model/PublicUserPage"));
|
|
14
|
+
var _PublicUserResponse = _interopRequireDefault(require("../model/PublicUserResponse"));
|
|
15
|
+
var _SetCurrentUserAvatarRequest = _interopRequireDefault(require("../model/SetCurrentUserAvatarRequest"));
|
|
17
16
|
var _UpdateCurrentUserDisplayNameRequest = _interopRequireDefault(require("../model/UpdateCurrentUserDisplayNameRequest"));
|
|
18
17
|
var _UpdateCurrentUserPasswordRequest = _interopRequireDefault(require("../model/UpdateCurrentUserPasswordRequest"));
|
|
19
18
|
var _UpdateCurrentUserUsernameRequest = _interopRequireDefault(require("../model/UpdateCurrentUserUsernameRequest"));
|
|
20
|
-
var
|
|
19
|
+
var _UploadTicketResponse = _interopRequireDefault(require("../model/UploadTicketResponse"));
|
|
21
20
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
22
21
|
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); }
|
|
23
22
|
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
@@ -28,7 +27,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
28
27
|
* Gamend API
|
|
29
28
|
* 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 })) ```
|
|
30
29
|
*
|
|
31
|
-
* The version of the OpenAPI document: 1.0.
|
|
30
|
+
* The version of the OpenAPI document: 1.0.1241
|
|
32
31
|
*
|
|
33
32
|
*
|
|
34
33
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -59,7 +58,7 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
59
58
|
* Returns an upload ticket. Upload the image bytes to `url` with `method`/`headers`, then confirm with `POST /me/avatar` using the returned `key`.
|
|
60
59
|
* @param {Object} opts Optional parameters
|
|
61
60
|
* @param {module:model/CreateCurrentUserAvatarUploadUrlRequest} [createCurrentUserAvatarUploadUrlRequest] Upload metadata
|
|
62
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
61
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UploadTicketResponse} and HTTP response
|
|
63
62
|
*/
|
|
64
63
|
return _createClass(UsersApi, [{
|
|
65
64
|
key: "createCurrentUserAvatarUploadUrlWithHttpInfo",
|
|
@@ -73,7 +72,7 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
73
72
|
var authNames = ['authorization'];
|
|
74
73
|
var contentTypes = ['application/json'];
|
|
75
74
|
var accepts = ['application/json'];
|
|
76
|
-
var returnType =
|
|
75
|
+
var returnType = _UploadTicketResponse["default"];
|
|
77
76
|
return this.apiClient.callApi('/api/v1/me/avatar/upload_url', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
78
77
|
}
|
|
79
78
|
|
|
@@ -82,7 +81,7 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
82
81
|
* Returns an upload ticket. Upload the image bytes to `url` with `method`/`headers`, then confirm with `POST /me/avatar` using the returned `key`.
|
|
83
82
|
* @param {Object} opts Optional parameters
|
|
84
83
|
* @param {module:model/CreateCurrentUserAvatarUploadUrlRequest} opts.createCurrentUserAvatarUploadUrlRequest Upload metadata
|
|
85
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
84
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UploadTicketResponse}
|
|
86
85
|
*/
|
|
87
86
|
}, {
|
|
88
87
|
key: "createCurrentUserAvatarUploadUrl",
|
|
@@ -95,7 +94,7 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
95
94
|
/**
|
|
96
95
|
* Delete current user
|
|
97
96
|
* Deletes the authenticated user's account
|
|
98
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link
|
|
97
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OkResponse} and HTTP response
|
|
99
98
|
*/
|
|
100
99
|
}, {
|
|
101
100
|
key: "deleteCurrentUserWithHttpInfo",
|
|
@@ -108,14 +107,14 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
108
107
|
var authNames = ['authorization'];
|
|
109
108
|
var contentTypes = [];
|
|
110
109
|
var accepts = ['application/json'];
|
|
111
|
-
var returnType =
|
|
110
|
+
var returnType = _OkResponse["default"];
|
|
112
111
|
return this.apiClient.callApi('/api/v1/me', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
113
112
|
}
|
|
114
113
|
|
|
115
114
|
/**
|
|
116
115
|
* Delete current user
|
|
117
116
|
* Deletes the authenticated user's account
|
|
118
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link
|
|
117
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OkResponse}
|
|
119
118
|
*/
|
|
120
119
|
}, {
|
|
121
120
|
key: "deleteCurrentUser",
|
|
@@ -128,7 +127,7 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
128
127
|
/**
|
|
129
128
|
* Return current user info
|
|
130
129
|
* Returns the current authenticated user's basic information.
|
|
131
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
130
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CurrentUserResponse} and HTTP response
|
|
132
131
|
*/
|
|
133
132
|
}, {
|
|
134
133
|
key: "getCurrentUserWithHttpInfo",
|
|
@@ -141,14 +140,14 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
141
140
|
var authNames = ['authorization'];
|
|
142
141
|
var contentTypes = [];
|
|
143
142
|
var accepts = ['application/json'];
|
|
144
|
-
var returnType =
|
|
143
|
+
var returnType = _CurrentUserResponse["default"];
|
|
145
144
|
return this.apiClient.callApi('/api/v1/me', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
146
145
|
}
|
|
147
146
|
|
|
148
147
|
/**
|
|
149
148
|
* Return current user info
|
|
150
149
|
* Returns the current authenticated user's basic information.
|
|
151
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
150
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CurrentUserResponse}
|
|
152
151
|
*/
|
|
153
152
|
}, {
|
|
154
153
|
key: "getCurrentUser",
|
|
@@ -161,7 +160,7 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
161
160
|
/**
|
|
162
161
|
* Get a user by id
|
|
163
162
|
* @param {String} id
|
|
164
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
163
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PublicUserResponse} and HTTP response
|
|
165
164
|
*/
|
|
166
165
|
}, {
|
|
167
166
|
key: "getUserWithHttpInfo",
|
|
@@ -180,14 +179,14 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
180
179
|
var authNames = [];
|
|
181
180
|
var contentTypes = [];
|
|
182
181
|
var accepts = ['application/json'];
|
|
183
|
-
var returnType =
|
|
182
|
+
var returnType = _PublicUserResponse["default"];
|
|
184
183
|
return this.apiClient.callApi('/api/v1/users/{id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
185
184
|
}
|
|
186
185
|
|
|
187
186
|
/**
|
|
188
187
|
* Get a user by id
|
|
189
188
|
* @param {String} id
|
|
190
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
189
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PublicUserResponse}
|
|
191
190
|
*/
|
|
192
191
|
}, {
|
|
193
192
|
key: "getUser",
|
|
@@ -245,14 +244,14 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
245
244
|
* Confirm an uploaded avatar
|
|
246
245
|
* Records a previously uploaded object (`key`) as the user's avatar.
|
|
247
246
|
* @param {Object} opts Optional parameters
|
|
248
|
-
* @param {module:model/
|
|
249
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
247
|
+
* @param {module:model/SetCurrentUserAvatarRequest} [setCurrentUserAvatarRequest] Uploaded object key
|
|
248
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CurrentUserResponse} and HTTP response
|
|
250
249
|
*/
|
|
251
250
|
}, {
|
|
252
251
|
key: "setCurrentUserAvatarWithHttpInfo",
|
|
253
252
|
value: function setCurrentUserAvatarWithHttpInfo(opts) {
|
|
254
253
|
opts = opts || {};
|
|
255
|
-
var postBody = opts['
|
|
254
|
+
var postBody = opts['setCurrentUserAvatarRequest'];
|
|
256
255
|
var pathParams = {};
|
|
257
256
|
var queryParams = {};
|
|
258
257
|
var headerParams = {};
|
|
@@ -260,7 +259,7 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
260
259
|
var authNames = ['authorization'];
|
|
261
260
|
var contentTypes = ['application/json'];
|
|
262
261
|
var accepts = ['application/json'];
|
|
263
|
-
var returnType =
|
|
262
|
+
var returnType = _CurrentUserResponse["default"];
|
|
264
263
|
return this.apiClient.callApi('/api/v1/me/avatar', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
265
264
|
}
|
|
266
265
|
|
|
@@ -268,8 +267,8 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
268
267
|
* Confirm an uploaded avatar
|
|
269
268
|
* Records a previously uploaded object (`key`) as the user's avatar.
|
|
270
269
|
* @param {Object} opts Optional parameters
|
|
271
|
-
* @param {module:model/
|
|
272
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
270
|
+
* @param {module:model/SetCurrentUserAvatarRequest} opts.setCurrentUserAvatarRequest Uploaded object key
|
|
271
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CurrentUserResponse}
|
|
273
272
|
*/
|
|
274
273
|
}, {
|
|
275
274
|
key: "setCurrentUserAvatar",
|
|
@@ -283,7 +282,7 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
283
282
|
* Update current user's display name
|
|
284
283
|
* @param {Object} opts Optional parameters
|
|
285
284
|
* @param {module:model/UpdateCurrentUserDisplayNameRequest} [updateCurrentUserDisplayNameRequest] Display name payload
|
|
286
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
285
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CurrentUserResponse} and HTTP response
|
|
287
286
|
*/
|
|
288
287
|
}, {
|
|
289
288
|
key: "updateCurrentUserDisplayNameWithHttpInfo",
|
|
@@ -297,7 +296,7 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
297
296
|
var authNames = ['authorization'];
|
|
298
297
|
var contentTypes = ['application/json'];
|
|
299
298
|
var accepts = ['application/json'];
|
|
300
|
-
var returnType =
|
|
299
|
+
var returnType = _CurrentUserResponse["default"];
|
|
301
300
|
return this.apiClient.callApi('/api/v1/me/display_name', 'PATCH', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
302
301
|
}
|
|
303
302
|
|
|
@@ -305,7 +304,7 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
305
304
|
* Update current user's display name
|
|
306
305
|
* @param {Object} opts Optional parameters
|
|
307
306
|
* @param {module:model/UpdateCurrentUserDisplayNameRequest} opts.updateCurrentUserDisplayNameRequest Display name payload
|
|
308
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
307
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CurrentUserResponse}
|
|
309
308
|
*/
|
|
310
309
|
}, {
|
|
311
310
|
key: "updateCurrentUserDisplayName",
|
|
@@ -319,7 +318,7 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
319
318
|
* Update current user password
|
|
320
319
|
* @param {Object} opts Optional parameters
|
|
321
320
|
* @param {module:model/UpdateCurrentUserPasswordRequest} [updateCurrentUserPasswordRequest] New password payload
|
|
322
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
321
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CurrentUserResponse} and HTTP response
|
|
323
322
|
*/
|
|
324
323
|
}, {
|
|
325
324
|
key: "updateCurrentUserPasswordWithHttpInfo",
|
|
@@ -333,7 +332,7 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
333
332
|
var authNames = ['authorization'];
|
|
334
333
|
var contentTypes = ['application/json'];
|
|
335
334
|
var accepts = ['application/json'];
|
|
336
|
-
var returnType =
|
|
335
|
+
var returnType = _CurrentUserResponse["default"];
|
|
337
336
|
return this.apiClient.callApi('/api/v1/me/password', 'PATCH', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
338
337
|
}
|
|
339
338
|
|
|
@@ -341,7 +340,7 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
341
340
|
* Update current user password
|
|
342
341
|
* @param {Object} opts Optional parameters
|
|
343
342
|
* @param {module:model/UpdateCurrentUserPasswordRequest} opts.updateCurrentUserPasswordRequest New password payload
|
|
344
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
343
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CurrentUserResponse}
|
|
345
344
|
*/
|
|
346
345
|
}, {
|
|
347
346
|
key: "updateCurrentUserPassword",
|
|
@@ -353,10 +352,10 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
353
352
|
|
|
354
353
|
/**
|
|
355
354
|
* Update current user's username
|
|
356
|
-
* Sets the unique username handle. Lowercased on save; 3-32 chars of a-z, 0-9 and non-consecutive . _ - separators, starting and ending alphanumeric.
|
|
355
|
+
* Sets the unique username handle. Lowercased on save; 3-32 chars of a-z, 0-9 and non-consecutive . _ - separators, starting and ending alphanumeric. Answers 422 validation_failed when the username is malformed or already taken.
|
|
357
356
|
* @param {Object} opts Optional parameters
|
|
358
357
|
* @param {module:model/UpdateCurrentUserUsernameRequest} [updateCurrentUserUsernameRequest] Username payload
|
|
359
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/
|
|
358
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CurrentUserResponse} and HTTP response
|
|
360
359
|
*/
|
|
361
360
|
}, {
|
|
362
361
|
key: "updateCurrentUserUsernameWithHttpInfo",
|
|
@@ -370,16 +369,16 @@ var UsersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
370
369
|
var authNames = ['authorization'];
|
|
371
370
|
var contentTypes = ['application/json'];
|
|
372
371
|
var accepts = ['application/json'];
|
|
373
|
-
var returnType =
|
|
372
|
+
var returnType = _CurrentUserResponse["default"];
|
|
374
373
|
return this.apiClient.callApi('/api/v1/me/username', 'PATCH', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
375
374
|
}
|
|
376
375
|
|
|
377
376
|
/**
|
|
378
377
|
* Update current user's username
|
|
379
|
-
* Sets the unique username handle. Lowercased on save; 3-32 chars of a-z, 0-9 and non-consecutive . _ - separators, starting and ending alphanumeric.
|
|
378
|
+
* Sets the unique username handle. Lowercased on save; 3-32 chars of a-z, 0-9 and non-consecutive . _ - separators, starting and ending alphanumeric. Answers 422 validation_failed when the username is malformed or already taken.
|
|
380
379
|
* @param {Object} opts Optional parameters
|
|
381
380
|
* @param {module:model/UpdateCurrentUserUsernameRequest} opts.updateCurrentUserUsernameRequest Username payload
|
|
382
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/
|
|
381
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CurrentUserResponse}
|
|
383
382
|
*/
|
|
384
383
|
}, {
|
|
385
384
|
key: "updateCurrentUserUsername",
|