@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
|
@@ -7,6 +7,9 @@ exports["default"] = void 0;
|
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
8
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
9
9
|
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); }
|
|
10
|
+
function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
|
|
11
|
+
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
|
|
12
|
+
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
|
|
10
13
|
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
11
14
|
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
|
|
12
15
|
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
|
|
@@ -15,7 +18,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
15
18
|
* Gamend API
|
|
16
19
|
* 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 })) ```
|
|
17
20
|
*
|
|
18
|
-
* The version of the OpenAPI document: 1.0.
|
|
21
|
+
* The version of the OpenAPI document: 1.0.1241
|
|
19
22
|
*
|
|
20
23
|
*
|
|
21
24
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -24,18 +27,32 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
24
27
|
*
|
|
25
28
|
*/
|
|
26
29
|
/**
|
|
27
|
-
* The
|
|
28
|
-
* @module model/
|
|
30
|
+
* The Leaderboard model module.
|
|
31
|
+
* @module model/Leaderboard
|
|
29
32
|
* @version 1.0.0
|
|
30
33
|
*/
|
|
31
|
-
var
|
|
34
|
+
var Leaderboard = /*#__PURE__*/function () {
|
|
32
35
|
/**
|
|
33
|
-
* Constructs a new <code>
|
|
34
|
-
*
|
|
36
|
+
* Constructs a new <code>Leaderboard</code>.
|
|
37
|
+
* A leaderboard (one season of a slug)
|
|
38
|
+
* @alias module:model/Leaderboard
|
|
39
|
+
* @param description {String}
|
|
40
|
+
* @param endsAt {Date} Null for a permanent leaderboard
|
|
41
|
+
* @param iconUrl {String} Empty when unset (the client applies its own default)
|
|
42
|
+
* @param id {String}
|
|
43
|
+
* @param insertedAt {Date}
|
|
44
|
+
* @param isActive {Boolean} Still accepting scores
|
|
45
|
+
* @param metadata {Object}
|
|
46
|
+
* @param operator {module:model/Leaderboard.OperatorEnum} How a submitted score combines with the stored one
|
|
47
|
+
* @param slug {String} Human-readable identifier, shared by every season
|
|
48
|
+
* @param sortOrder {module:model/Leaderboard.SortOrderEnum} `desc`: higher is better; `asc`: lower is better
|
|
49
|
+
* @param startsAt {Date}
|
|
50
|
+
* @param title {String}
|
|
51
|
+
* @param updatedAt {Date}
|
|
35
52
|
*/
|
|
36
|
-
function
|
|
37
|
-
_classCallCheck(this,
|
|
38
|
-
|
|
53
|
+
function Leaderboard(description, endsAt, iconUrl, id, insertedAt, isActive, metadata, operator, slug, sortOrder, startsAt, title, updatedAt) {
|
|
54
|
+
_classCallCheck(this, Leaderboard);
|
|
55
|
+
Leaderboard.initialize(this, description, endsAt, iconUrl, id, insertedAt, isActive, metadata, operator, slug, sortOrder, startsAt, title, updatedAt);
|
|
39
56
|
}
|
|
40
57
|
|
|
41
58
|
/**
|
|
@@ -43,22 +60,36 @@ var ResolveLeaderboardSlugs200ResponseDataValue = /*#__PURE__*/function () {
|
|
|
43
60
|
* This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
|
|
44
61
|
* Only for internal use.
|
|
45
62
|
*/
|
|
46
|
-
return _createClass(
|
|
63
|
+
return _createClass(Leaderboard, null, [{
|
|
47
64
|
key: "initialize",
|
|
48
|
-
value: function initialize(obj) {
|
|
65
|
+
value: function initialize(obj, description, endsAt, iconUrl, id, insertedAt, isActive, metadata, operator, slug, sortOrder, startsAt, title, updatedAt) {
|
|
66
|
+
obj['description'] = description;
|
|
67
|
+
obj['ends_at'] = endsAt;
|
|
68
|
+
obj['icon_url'] = iconUrl;
|
|
69
|
+
obj['id'] = id;
|
|
70
|
+
obj['inserted_at'] = insertedAt;
|
|
71
|
+
obj['is_active'] = isActive;
|
|
72
|
+
obj['metadata'] = metadata;
|
|
73
|
+
obj['operator'] = operator;
|
|
74
|
+
obj['slug'] = slug;
|
|
75
|
+
obj['sort_order'] = sortOrder;
|
|
76
|
+
obj['starts_at'] = startsAt;
|
|
77
|
+
obj['title'] = title;
|
|
78
|
+
obj['updated_at'] = updatedAt;
|
|
79
|
+
}
|
|
49
80
|
|
|
50
81
|
/**
|
|
51
|
-
* Constructs a <code>
|
|
82
|
+
* Constructs a <code>Leaderboard</code> from a plain JavaScript object, optionally creating a new instance.
|
|
52
83
|
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
|
|
53
84
|
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
54
|
-
* @param {module:model/
|
|
55
|
-
* @return {module:model/
|
|
85
|
+
* @param {module:model/Leaderboard} obj Optional instance to populate.
|
|
86
|
+
* @return {module:model/Leaderboard} The populated <code>Leaderboard</code> instance.
|
|
56
87
|
*/
|
|
57
88
|
}, {
|
|
58
89
|
key: "constructFromObject",
|
|
59
90
|
value: function constructFromObject(data, obj) {
|
|
60
91
|
if (data) {
|
|
61
|
-
obj = obj || new
|
|
92
|
+
obj = obj || new Leaderboard();
|
|
62
93
|
if (data.hasOwnProperty('description')) {
|
|
63
94
|
obj['description'] = _ApiClient["default"].convertToType(data['description'], 'String');
|
|
64
95
|
}
|
|
@@ -103,14 +134,29 @@ var ResolveLeaderboardSlugs200ResponseDataValue = /*#__PURE__*/function () {
|
|
|
103
134
|
}
|
|
104
135
|
|
|
105
136
|
/**
|
|
106
|
-
* Validates the JSON data with respect to <code>
|
|
137
|
+
* Validates the JSON data with respect to <code>Leaderboard</code>.
|
|
107
138
|
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
108
|
-
* @return {boolean} to indicate whether the JSON data is valid with respect to <code>
|
|
139
|
+
* @return {boolean} to indicate whether the JSON data is valid with respect to <code>Leaderboard</code>.
|
|
109
140
|
*/
|
|
110
141
|
}, {
|
|
111
142
|
key: "validateJSON",
|
|
112
143
|
value: function validateJSON(data) {
|
|
113
|
-
//
|
|
144
|
+
// check to make sure all required properties are present in the JSON string
|
|
145
|
+
var _iterator = _createForOfIteratorHelper(Leaderboard.RequiredProperties),
|
|
146
|
+
_step;
|
|
147
|
+
try {
|
|
148
|
+
for (_iterator.s(); !(_step = _iterator.n()).done;) {
|
|
149
|
+
var property = _step.value;
|
|
150
|
+
if (!data.hasOwnProperty(property)) {
|
|
151
|
+
throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
// ensure the json data is a string
|
|
155
|
+
} catch (err) {
|
|
156
|
+
_iterator.e(err);
|
|
157
|
+
} finally {
|
|
158
|
+
_iterator.f();
|
|
159
|
+
}
|
|
114
160
|
if (data['description'] && !(typeof data['description'] === 'string' || data['description'] instanceof String)) {
|
|
115
161
|
throw new Error("Expected the field `description` to be a primitive type in the JSON string but got " + data['description']);
|
|
116
162
|
}
|
|
@@ -142,86 +188,85 @@ var ResolveLeaderboardSlugs200ResponseDataValue = /*#__PURE__*/function () {
|
|
|
142
188
|
}
|
|
143
189
|
}]);
|
|
144
190
|
}();
|
|
191
|
+
Leaderboard.RequiredProperties = ["description", "ends_at", "icon_url", "id", "inserted_at", "is_active", "metadata", "operator", "slug", "sort_order", "starts_at", "title", "updated_at"];
|
|
192
|
+
|
|
145
193
|
/**
|
|
146
|
-
* Description
|
|
147
194
|
* @member {String} description
|
|
148
195
|
*/
|
|
149
|
-
|
|
196
|
+
Leaderboard.prototype['description'] = undefined;
|
|
150
197
|
|
|
151
198
|
/**
|
|
199
|
+
* Null for a permanent leaderboard
|
|
152
200
|
* @member {Date} ends_at
|
|
153
201
|
*/
|
|
154
|
-
|
|
202
|
+
Leaderboard.prototype['ends_at'] = undefined;
|
|
155
203
|
|
|
156
204
|
/**
|
|
157
|
-
*
|
|
205
|
+
* Empty when unset (the client applies its own default)
|
|
158
206
|
* @member {String} icon_url
|
|
159
207
|
*/
|
|
160
|
-
|
|
208
|
+
Leaderboard.prototype['icon_url'] = undefined;
|
|
161
209
|
|
|
162
210
|
/**
|
|
163
|
-
* Leaderboard ID
|
|
164
211
|
* @member {String} id
|
|
165
212
|
*/
|
|
166
|
-
|
|
213
|
+
Leaderboard.prototype['id'] = undefined;
|
|
167
214
|
|
|
168
215
|
/**
|
|
169
216
|
* @member {Date} inserted_at
|
|
170
217
|
*/
|
|
171
|
-
|
|
218
|
+
Leaderboard.prototype['inserted_at'] = undefined;
|
|
172
219
|
|
|
173
220
|
/**
|
|
174
|
-
*
|
|
221
|
+
* Still accepting scores
|
|
175
222
|
* @member {Boolean} is_active
|
|
176
223
|
*/
|
|
177
|
-
|
|
224
|
+
Leaderboard.prototype['is_active'] = undefined;
|
|
178
225
|
|
|
179
226
|
/**
|
|
180
|
-
* Arbitrary metadata
|
|
181
227
|
* @member {Object} metadata
|
|
182
228
|
*/
|
|
183
|
-
|
|
229
|
+
Leaderboard.prototype['metadata'] = undefined;
|
|
184
230
|
|
|
185
231
|
/**
|
|
186
|
-
*
|
|
187
|
-
* @member {module:model/
|
|
232
|
+
* How a submitted score combines with the stored one
|
|
233
|
+
* @member {module:model/Leaderboard.OperatorEnum} operator
|
|
188
234
|
*/
|
|
189
|
-
|
|
235
|
+
Leaderboard.prototype['operator'] = undefined;
|
|
190
236
|
|
|
191
237
|
/**
|
|
192
|
-
* Human-readable identifier
|
|
238
|
+
* Human-readable identifier, shared by every season
|
|
193
239
|
* @member {String} slug
|
|
194
240
|
*/
|
|
195
|
-
|
|
241
|
+
Leaderboard.prototype['slug'] = undefined;
|
|
196
242
|
|
|
197
243
|
/**
|
|
198
|
-
*
|
|
199
|
-
* @member {module:model/
|
|
244
|
+
* `desc`: higher is better; `asc`: lower is better
|
|
245
|
+
* @member {module:model/Leaderboard.SortOrderEnum} sort_order
|
|
200
246
|
*/
|
|
201
|
-
|
|
247
|
+
Leaderboard.prototype['sort_order'] = undefined;
|
|
202
248
|
|
|
203
249
|
/**
|
|
204
250
|
* @member {Date} starts_at
|
|
205
251
|
*/
|
|
206
|
-
|
|
252
|
+
Leaderboard.prototype['starts_at'] = undefined;
|
|
207
253
|
|
|
208
254
|
/**
|
|
209
|
-
* Display title
|
|
210
255
|
* @member {String} title
|
|
211
256
|
*/
|
|
212
|
-
|
|
257
|
+
Leaderboard.prototype['title'] = undefined;
|
|
213
258
|
|
|
214
259
|
/**
|
|
215
260
|
* @member {Date} updated_at
|
|
216
261
|
*/
|
|
217
|
-
|
|
262
|
+
Leaderboard.prototype['updated_at'] = undefined;
|
|
218
263
|
|
|
219
264
|
/**
|
|
220
265
|
* Allowed values for the <code>operator</code> property.
|
|
221
266
|
* @enum {String}
|
|
222
267
|
* @readonly
|
|
223
268
|
*/
|
|
224
|
-
|
|
269
|
+
Leaderboard['OperatorEnum'] = {
|
|
225
270
|
/**
|
|
226
271
|
* value: "set"
|
|
227
272
|
* @const
|
|
@@ -249,7 +294,7 @@ ResolveLeaderboardSlugs200ResponseDataValue['OperatorEnum'] = {
|
|
|
249
294
|
* @enum {String}
|
|
250
295
|
* @readonly
|
|
251
296
|
*/
|
|
252
|
-
|
|
297
|
+
Leaderboard['SortOrderEnum'] = {
|
|
253
298
|
/**
|
|
254
299
|
* value: "desc"
|
|
255
300
|
* @const
|
|
@@ -261,4 +306,4 @@ ResolveLeaderboardSlugs200ResponseDataValue['SortOrderEnum'] = {
|
|
|
261
306
|
*/
|
|
262
307
|
"asc": "asc"
|
|
263
308
|
};
|
|
264
|
-
var _default = exports["default"] =
|
|
309
|
+
var _default = exports["default"] = Leaderboard;
|
|
@@ -5,8 +5,8 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
|
-
var
|
|
9
|
-
var
|
|
8
|
+
var _Leaderboard = _interopRequireDefault(require("./Leaderboard"));
|
|
9
|
+
var _PageMeta = _interopRequireDefault(require("./PageMeta"));
|
|
10
10
|
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
11
11
|
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
|
|
12
12
|
function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
|
|
@@ -20,7 +20,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
20
20
|
* Gamend API
|
|
21
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 })) ```
|
|
22
22
|
*
|
|
23
|
-
* The version of the OpenAPI document: 1.0.
|
|
23
|
+
* The version of the OpenAPI document: 1.0.1241
|
|
24
24
|
*
|
|
25
25
|
*
|
|
26
26
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -29,18 +29,21 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
29
29
|
*
|
|
30
30
|
*/
|
|
31
31
|
/**
|
|
32
|
-
* The
|
|
33
|
-
* @module model/
|
|
32
|
+
* The LeaderboardPage model module.
|
|
33
|
+
* @module model/LeaderboardPage
|
|
34
34
|
* @version 1.0.0
|
|
35
35
|
*/
|
|
36
|
-
var
|
|
36
|
+
var LeaderboardPage = /*#__PURE__*/function () {
|
|
37
37
|
/**
|
|
38
|
-
* Constructs a new <code>
|
|
39
|
-
*
|
|
38
|
+
* Constructs a new <code>LeaderboardPage</code>.
|
|
39
|
+
* A page of Leaderboard rows
|
|
40
|
+
* @alias module:model/LeaderboardPage
|
|
41
|
+
* @param data {Array.<module:model/Leaderboard>}
|
|
42
|
+
* @param meta {module:model/PageMeta}
|
|
40
43
|
*/
|
|
41
|
-
function
|
|
42
|
-
_classCallCheck(this,
|
|
43
|
-
|
|
44
|
+
function LeaderboardPage(data, meta) {
|
|
45
|
+
_classCallCheck(this, LeaderboardPage);
|
|
46
|
+
LeaderboardPage.initialize(this, data, meta);
|
|
44
47
|
}
|
|
45
48
|
|
|
46
49
|
/**
|
|
@@ -48,40 +51,58 @@ var ListGroupMutes200Response = /*#__PURE__*/function () {
|
|
|
48
51
|
* This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
|
|
49
52
|
* Only for internal use.
|
|
50
53
|
*/
|
|
51
|
-
return _createClass(
|
|
54
|
+
return _createClass(LeaderboardPage, null, [{
|
|
52
55
|
key: "initialize",
|
|
53
|
-
value: function initialize(obj) {
|
|
56
|
+
value: function initialize(obj, data, meta) {
|
|
57
|
+
obj['data'] = data;
|
|
58
|
+
obj['meta'] = meta;
|
|
59
|
+
}
|
|
54
60
|
|
|
55
61
|
/**
|
|
56
|
-
* Constructs a <code>
|
|
62
|
+
* Constructs a <code>LeaderboardPage</code> from a plain JavaScript object, optionally creating a new instance.
|
|
57
63
|
* Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
|
|
58
64
|
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
59
|
-
* @param {module:model/
|
|
60
|
-
* @return {module:model/
|
|
65
|
+
* @param {module:model/LeaderboardPage} obj Optional instance to populate.
|
|
66
|
+
* @return {module:model/LeaderboardPage} The populated <code>LeaderboardPage</code> instance.
|
|
61
67
|
*/
|
|
62
68
|
}, {
|
|
63
69
|
key: "constructFromObject",
|
|
64
70
|
value: function constructFromObject(data, obj) {
|
|
65
71
|
if (data) {
|
|
66
|
-
obj = obj || new
|
|
72
|
+
obj = obj || new LeaderboardPage();
|
|
67
73
|
if (data.hasOwnProperty('data')) {
|
|
68
|
-
obj['data'] = _ApiClient["default"].convertToType(data['data'], [
|
|
74
|
+
obj['data'] = _ApiClient["default"].convertToType(data['data'], [_Leaderboard["default"]]);
|
|
69
75
|
}
|
|
70
76
|
if (data.hasOwnProperty('meta')) {
|
|
71
|
-
obj['meta'] =
|
|
77
|
+
obj['meta'] = _PageMeta["default"].constructFromObject(data['meta']);
|
|
72
78
|
}
|
|
73
79
|
}
|
|
74
80
|
return obj;
|
|
75
81
|
}
|
|
76
82
|
|
|
77
83
|
/**
|
|
78
|
-
* Validates the JSON data with respect to <code>
|
|
84
|
+
* Validates the JSON data with respect to <code>LeaderboardPage</code>.
|
|
79
85
|
* @param {Object} data The plain JavaScript object bearing properties of interest.
|
|
80
|
-
* @return {boolean} to indicate whether the JSON data is valid with respect to <code>
|
|
86
|
+
* @return {boolean} to indicate whether the JSON data is valid with respect to <code>LeaderboardPage</code>.
|
|
81
87
|
*/
|
|
82
88
|
}, {
|
|
83
89
|
key: "validateJSON",
|
|
84
90
|
value: function validateJSON(data) {
|
|
91
|
+
// check to make sure all required properties are present in the JSON string
|
|
92
|
+
var _iterator = _createForOfIteratorHelper(LeaderboardPage.RequiredProperties),
|
|
93
|
+
_step;
|
|
94
|
+
try {
|
|
95
|
+
for (_iterator.s(); !(_step = _iterator.n()).done;) {
|
|
96
|
+
var property = _step.value;
|
|
97
|
+
if (!data.hasOwnProperty(property)) {
|
|
98
|
+
throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
} catch (err) {
|
|
102
|
+
_iterator.e(err);
|
|
103
|
+
} finally {
|
|
104
|
+
_iterator.f();
|
|
105
|
+
}
|
|
85
106
|
if (data['data']) {
|
|
86
107
|
// data not null
|
|
87
108
|
// ensure the json data is an array
|
|
@@ -89,36 +110,38 @@ var ListGroupMutes200Response = /*#__PURE__*/function () {
|
|
|
89
110
|
throw new Error("Expected the field `data` to be an array in the JSON data but got " + data['data']);
|
|
90
111
|
}
|
|
91
112
|
// validate the optional field `data` (array)
|
|
92
|
-
var
|
|
93
|
-
|
|
113
|
+
var _iterator2 = _createForOfIteratorHelper(data['data']),
|
|
114
|
+
_step2;
|
|
94
115
|
try {
|
|
95
|
-
for (
|
|
96
|
-
var item =
|
|
97
|
-
|
|
116
|
+
for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
|
|
117
|
+
var item = _step2.value;
|
|
118
|
+
_Leaderboard["default"].validateJSON(item);
|
|
98
119
|
}
|
|
99
120
|
} catch (err) {
|
|
100
|
-
|
|
121
|
+
_iterator2.e(err);
|
|
101
122
|
} finally {
|
|
102
|
-
|
|
123
|
+
_iterator2.f();
|
|
103
124
|
}
|
|
104
125
|
;
|
|
105
126
|
}
|
|
106
127
|
// validate the optional field `meta`
|
|
107
128
|
if (data['meta']) {
|
|
108
129
|
// data not null
|
|
109
|
-
|
|
130
|
+
_PageMeta["default"].validateJSON(data['meta']);
|
|
110
131
|
}
|
|
111
132
|
return true;
|
|
112
133
|
}
|
|
113
134
|
}]);
|
|
114
135
|
}();
|
|
136
|
+
LeaderboardPage.RequiredProperties = ["data", "meta"];
|
|
137
|
+
|
|
115
138
|
/**
|
|
116
|
-
* @member {Array.<module:model/
|
|
139
|
+
* @member {Array.<module:model/Leaderboard>} data
|
|
117
140
|
*/
|
|
118
|
-
|
|
141
|
+
LeaderboardPage.prototype['data'] = undefined;
|
|
119
142
|
|
|
120
143
|
/**
|
|
121
|
-
* @member {module:model/
|
|
144
|
+
* @member {module:model/PageMeta} meta
|
|
122
145
|
*/
|
|
123
|
-
|
|
124
|
-
var _default = exports["default"] =
|
|
146
|
+
LeaderboardPage.prototype['meta'] = undefined;
|
|
147
|
+
var _default = exports["default"] = LeaderboardPage;
|