@ughuuu/gamend 1.0.1241 → 1.0.1251

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (435) hide show
  1. package/README.md +155 -108
  2. package/dist/ApiClient.js +1 -1
  3. package/dist/api/AdminAnalyticsApi.js +22 -21
  4. package/dist/api/AdminChatApi.js +97 -63
  5. package/dist/api/AdminEconomyApi.js +28 -23
  6. package/dist/api/AdminGroupsApi.js +14 -13
  7. package/dist/api/AdminKVApi.js +23 -22
  8. package/dist/api/AdminLeaderboardsApi.js +36 -34
  9. package/dist/api/AdminLobbiesApi.js +14 -13
  10. package/dist/api/AdminMatchmakingApi.js +14 -14
  11. package/dist/api/AdminNotificationsApi.js +14 -13
  12. package/dist/api/AdminPushApi.js +13 -14
  13. package/dist/api/AdminQuestsApi.js +43 -39
  14. package/dist/api/AdminReadyChecksApi.js +14 -13
  15. package/dist/api/AdminRetentionApi.js +9 -9
  16. package/dist/api/AdminSessionsApi.js +13 -12
  17. package/dist/api/AdminStorageApi.js +53 -12
  18. package/dist/api/AdminTournamentsApi.js +36 -33
  19. package/dist/api/AdminUsersApi.js +10 -9
  20. package/dist/api/AuthenticationApi.js +293 -46
  21. package/dist/api/ChatApi.js +1 -1
  22. package/dist/api/ClientLogsApi.js +9 -9
  23. package/dist/api/EconomyApi.js +14 -13
  24. package/dist/api/FriendsApi.js +1 -1
  25. package/dist/api/GroupsApi.js +1 -1
  26. package/dist/api/HealthApi.js +1 -1
  27. package/dist/api/HooksApi.js +28 -13
  28. package/dist/api/KVApi.js +6 -6
  29. package/dist/api/LeaderboardsApi.js +1 -1
  30. package/dist/api/LobbiesApi.js +1 -1
  31. package/dist/api/MatchmakingApi.js +21 -22
  32. package/dist/api/NotificationsApi.js +1 -1
  33. package/dist/api/PartiesApi.js +1 -1
  34. package/dist/api/PaymentsApi.js +57 -34
  35. package/dist/api/PushApi.js +1 -1
  36. package/dist/api/QuestsApi.js +22 -21
  37. package/dist/api/ReadyChecksApi.js +25 -24
  38. package/dist/api/SignalingApi.js +5 -5
  39. package/dist/api/StatsApi.js +5 -5
  40. package/dist/api/TimeApi.js +5 -5
  41. package/dist/api/TournamentsApi.js +1 -1
  42. package/dist/api/UsersApi.js +14 -8
  43. package/dist/index.js +803 -530
  44. package/dist/model/AcceptPartyInviteRequest.js +1 -1
  45. package/dist/model/ActivityStats.js +159 -0
  46. package/dist/model/{AdminListChatMutes200ResponseDataInner.js → AdminChatMute.js} +77 -32
  47. package/dist/model/AdminChatMutePage.js +147 -0
  48. package/dist/model/{UserQuests200Response.js → AdminChatMuteResponse.js} +42 -51
  49. package/dist/model/AdminClaimQuestRequest.js +1 -1
  50. package/dist/model/AdminCreateChatFilterWordRequest.js +1 -1
  51. package/dist/model/AdminCreateChatMuteRequest.js +1 -1
  52. package/dist/model/AdminCreateKvEntryRequest.js +3 -1
  53. package/dist/model/AdminCreateLeaderboardRequest.js +1 -1
  54. package/dist/model/AdminCreateNotificationRequest.js +1 -1
  55. package/dist/model/AdminCreateQuestRequest.js +1 -1
  56. package/dist/model/AdminCreateQuestRequestObjectivesInner.js +1 -1
  57. package/dist/model/AdminCreateQuestRequestRewardsInner.js +1 -1
  58. package/dist/model/AdminCreateTournamentRequest.js +1 -1
  59. package/dist/model/AdminGrantCurrencyRequest.js +1 -1
  60. package/dist/model/AdminGrantItemRequest.js +1 -1
  61. package/dist/model/AdminGrantQuestRequest.js +1 -1
  62. package/dist/model/AdminImportChatFilterWordsRequest.js +1 -1
  63. package/dist/model/AdminInventoryItem.js +161 -0
  64. package/dist/model/AdminInventoryItemPage.js +147 -0
  65. package/dist/model/AdminKvEntry.js +197 -0
  66. package/dist/model/{AdminListChatMutes200Response.js → AdminKvEntryPage.js} +57 -34
  67. package/dist/model/AdminKvEntryResponse.js +115 -0
  68. package/dist/model/AdminLeaderboardIconUploadUrlRequest.js +1 -1
  69. package/dist/model/{AdminUpdateLeaderboardRecord200ResponseData.js → AdminLeaderboardRecord.js} +71 -28
  70. package/dist/model/{AdminListPushTokens200Response.js → AdminLeaderboardRecordResponse.js} +44 -47
  71. package/dist/model/AdminLedgerEntry.js +195 -0
  72. package/dist/model/AdminLedgerEntryPage.js +147 -0
  73. package/dist/model/AdminMatchmakingStats.js +161 -0
  74. package/dist/model/AdminMatchmakingStatsResponse.js +115 -0
  75. package/dist/model/{AdminListMatchmakingTickets200ResponseDataInner.js → AdminMatchmakingTicket.js} +78 -33
  76. package/dist/model/{AdminListGroups200Response.js → AdminMatchmakingTicketPage.js} +57 -34
  77. package/dist/model/AdminMatchmakingTicketResponse.js +115 -0
  78. package/dist/model/{AdminListPushTokens200ResponseDataInner.js → AdminPushToken.js} +76 -50
  79. package/dist/model/AdminPushTokenPage.js +147 -0
  80. package/dist/model/{UserQuests200ResponseDataInner.js → AdminQuest.js} +146 -106
  81. package/dist/model/{AdminListStorageObjects200Response.js → AdminQuestClaim.js} +66 -51
  82. package/dist/model/AdminQuestClaimResponse.js +115 -0
  83. package/dist/model/AdminQuestIconUploadUrlRequest.js +1 -1
  84. package/dist/model/{AdminListNotifications200Response.js → AdminQuestPage.js} +57 -34
  85. package/dist/model/{AdminListQuestProgress200ResponseDataInner.js → AdminQuestProgress.js} +80 -34
  86. package/dist/model/AdminQuestProgressPage.js +147 -0
  87. package/dist/model/AdminQuestProgressResponse.js +115 -0
  88. package/dist/model/AdminQuestResponse.js +115 -0
  89. package/dist/model/{OpenLobbyReadyCheck201Response.js → AdminReadyCheck.js} +115 -63
  90. package/dist/model/AdminReadyCheckPage.js +147 -0
  91. package/dist/model/AdminReadyCheckResponse.js +115 -0
  92. package/dist/model/AdminResetQuestRequest.js +1 -1
  93. package/dist/model/AdminResolveChatReportRequest.js +1 -1
  94. package/dist/model/AdminResolveTournamentMatchRequest.js +1 -1
  95. package/dist/model/AdminSendPushRequest.js +1 -1
  96. package/dist/model/{AdminListSessions200ResponseDataInner.js → AdminSession.js} +87 -25
  97. package/dist/model/AdminSessionPage.js +147 -0
  98. package/dist/model/AdminSetLeaderboardIconRequest.js +1 -1
  99. package/dist/model/AdminSetQuestIconRequest.js +1 -1
  100. package/dist/model/AdminSetTournamentIconRequest.js +1 -1
  101. package/dist/model/AdminSpendCurrencyRequest.js +1 -1
  102. package/dist/model/AdminSubmitLeaderboardScoreRequest.js +1 -1
  103. package/dist/model/AdminTestChatPhraseRequest.js +1 -1
  104. package/dist/model/{AdminDrawTournament200ResponseData.js → AdminTournament.js} +101 -42
  105. package/dist/model/AdminTournamentIconUploadUrlRequest.js +1 -1
  106. package/dist/model/AdminTournamentResponse.js +115 -0
  107. package/dist/model/AdminUpdateChatFilterWordRequest.js +1 -1
  108. package/dist/model/AdminUpdateGroupRequest.js +1 -1
  109. package/dist/model/AdminUpdateKvEntryRequest.js +3 -1
  110. package/dist/model/AdminUpdateLeaderboardRecordRequest.js +1 -1
  111. package/dist/model/AdminUpdateLeaderboardRequest.js +1 -1
  112. package/dist/model/AdminUpdateLobbyRequest.js +1 -1
  113. package/dist/model/AdminUpdateQuestRequest.js +1 -1
  114. package/dist/model/AdminUpdateTournamentRequest.js +1 -1
  115. package/dist/model/AdminUpdateUserRequest.js +1 -1
  116. package/dist/model/AdminUpsertKvRequest.js +3 -1
  117. package/dist/model/{AdminUpdateUser200ResponseData.js → AdminUser.js} +94 -31
  118. package/dist/model/AdminUserResponse.js +115 -0
  119. package/dist/model/AdminWallet.js +151 -0
  120. package/dist/model/{AdminListLobbies200Response.js → AdminWalletPage.js} +57 -34
  121. package/dist/model/{AdminGetAnalyticsCounts200Response.js → AnalyticsCounts.js} +62 -34
  122. package/dist/model/AnalyticsCountsResponse.js +115 -0
  123. package/dist/model/{AdminGetAnalyticsDaily200Response.js → AnalyticsDaily.js} +53 -31
  124. package/dist/model/AnalyticsDailyResponse.js +115 -0
  125. package/dist/model/AnalyticsDay.js +159 -0
  126. package/dist/model/{AdminGetAnalyticsEconomy200Response.js → AnalyticsEconomy.js} +66 -43
  127. package/dist/model/AnalyticsEconomyResponse.js +115 -0
  128. package/dist/model/{AdminGetAnalyticsSummary200Response.js → AnalyticsSummary.js} +81 -36
  129. package/dist/model/{ListCurrentUserLedger200Response.js → AnalyticsSummaryResponse.js} +44 -47
  130. package/dist/model/AuthProvidersResponse.js +1 -1
  131. package/dist/model/BlockedFriendship.js +1 -1
  132. package/dist/model/BlockedFriendshipPage.js +1 -1
  133. package/dist/model/CallHookRequest.js +1 -1
  134. package/dist/model/CancelPartyInviteRequest.js +1 -1
  135. package/dist/model/CancelledCount.js +109 -0
  136. package/dist/model/CancelledCountResponse.js +115 -0
  137. package/dist/model/{AdminUpdateChatFilterWord200ResponseData.js → ChatFilterHit.js} +52 -65
  138. package/dist/model/ChatFilterLanguages.js +114 -0
  139. package/dist/model/ChatFilterLanguagesResponse.js +115 -0
  140. package/dist/model/{AdminTestChatPhrase200ResponseData.js → ChatFilterTest.js} +65 -36
  141. package/dist/model/ChatFilterTestResponse.js +115 -0
  142. package/dist/model/ChatFilterWord.js +231 -0
  143. package/dist/model/ChatFilterWordPage.js +147 -0
  144. package/dist/model/ChatFilterWordResponse.js +115 -0
  145. package/dist/model/ChatMessage.js +1 -1
  146. package/dist/model/ChatMessagePage.js +1 -1
  147. package/dist/model/ChatMessageResponse.js +1 -1
  148. package/dist/model/ChatMuteRecord.js +1 -1
  149. package/dist/model/ChatMuteRecordPage.js +1 -1
  150. package/dist/model/ChatMuteRecordResponse.js +1 -1
  151. package/dist/model/ChatReadCursor.js +1 -1
  152. package/dist/model/ChatReadCursorResponse.js +1 -1
  153. package/dist/model/{AdminResolveChatReport200ResponseData.js → ChatReport.js} +89 -36
  154. package/dist/model/{AdminListMatchmakingTickets200Response.js → ChatReportPage.js} +57 -34
  155. package/dist/model/ChatReportResponse.js +115 -0
  156. package/dist/model/ChatUnread.js +1 -1
  157. package/dist/model/ChatUnreadResponse.js +1 -1
  158. package/dist/model/ClientLogBatch.js +1 -1
  159. package/dist/model/ClientLogEntry.js +1 -1
  160. package/dist/model/ClientLogPolicy.js +1 -1
  161. package/dist/model/ClientLogPolicyResponse.js +115 -0
  162. package/dist/model/ClientLogResult.js +1 -1
  163. package/dist/model/ClientLogResultResponse.js +115 -0
  164. package/dist/model/ClientLogSession.js +1 -1
  165. package/dist/model/CounterTotal.js +123 -0
  166. package/dist/model/CreateCurrentUserAvatarUploadUrlRequest.js +1 -1
  167. package/dist/model/CreateFriendRequestRequest.js +1 -1
  168. package/dist/model/CreateGroupIconUploadUrlRequest.js +1 -1
  169. package/dist/model/CreateGroupRequest.js +1 -1
  170. package/dist/model/CreateLobbyRequest.js +1 -1
  171. package/dist/model/CreatePartyRequest.js +1 -1
  172. package/dist/model/CurrentUser.js +1 -1
  173. package/dist/model/CurrentUserResponse.js +1 -1
  174. package/dist/model/DeclinePartyInviteRequest.js +1 -1
  175. package/dist/model/{AdminSendPush200Response.js → DeleteCurrentUserRequest.js} +24 -23
  176. package/dist/model/DeleteNotificationsRequest.js +1 -1
  177. package/dist/model/DeletedCount.js +1 -1
  178. package/dist/model/DeletedCountResponse.js +1 -1
  179. package/dist/model/DemoteGroupMemberRequest.js +1 -1
  180. package/dist/model/DeviceLoginRequest.js +1 -1
  181. package/dist/model/{AdminGetAnalyticsEconomy200ResponseFlowInner.js → EconomyFlowDay.js} +59 -25
  182. package/dist/model/{AdminGetAnalyticsEconomy200ResponseTotalsInner.js → EconomyTotal.js} +59 -25
  183. package/dist/model/Entitlement.js +213 -0
  184. package/dist/model/{AdminListChatReports200Response.js → EntitlementPage.js} +57 -34
  185. package/dist/model/ErrorResponse.js +1 -1
  186. package/dist/model/Friend.js +1 -1
  187. package/dist/model/FriendPage.js +1 -1
  188. package/dist/model/FriendRequest.js +1 -1
  189. package/dist/model/FriendRequestLists.js +1 -1
  190. package/dist/model/FriendRequestMeta.js +1 -1
  191. package/dist/model/FriendRequestResponse.js +1 -1
  192. package/dist/model/FriendRequestsResponse.js +1 -1
  193. package/dist/model/Group.js +1 -1
  194. package/dist/model/GroupInvite.js +1 -1
  195. package/dist/model/GroupInviteOutcome.js +1 -1
  196. package/dist/model/GroupInviteOutcomeResponse.js +1 -1
  197. package/dist/model/GroupInvitePage.js +1 -1
  198. package/dist/model/GroupJoinRequest.js +1 -1
  199. package/dist/model/GroupJoinRequestPage.js +1 -1
  200. package/dist/model/GroupJoinRequestResponse.js +1 -1
  201. package/dist/model/GroupMember.js +1 -1
  202. package/dist/model/GroupMemberPage.js +1 -1
  203. package/dist/model/GroupMemberResponse.js +1 -1
  204. package/dist/model/GroupPage.js +1 -1
  205. package/dist/model/GroupResponse.js +1 -1
  206. package/dist/model/Health.js +125 -0
  207. package/dist/model/HealthResponse.js +17 -31
  208. package/dist/model/HookCallResponse.js +110 -0
  209. package/dist/model/HookFunction.js +196 -0
  210. package/dist/model/HookFunctionPage.js +147 -0
  211. package/dist/model/HookSignature.js +154 -0
  212. package/dist/model/ImportedCount.js +109 -0
  213. package/dist/model/ImportedCountResponse.js +115 -0
  214. package/dist/model/InventoryResponse.js +112 -0
  215. package/dist/model/InviteToGroupRequest.js +1 -1
  216. package/dist/model/InviteToPartyRequest.js +1 -1
  217. package/dist/model/ItemQuantity.js +137 -0
  218. package/dist/model/ItemQuantityResponse.js +115 -0
  219. package/dist/model/JoinLobbyRequest.js +1 -1
  220. package/dist/model/KickGroupMemberRequest.js +1 -1
  221. package/dist/model/KickPartyMemberRequest.js +1 -1
  222. package/dist/model/KickUserRequest.js +1 -1
  223. package/dist/model/{AdminUpsertKv200ResponseData.js → KvEntry.js} +58 -53
  224. package/dist/model/KvEntryResponse.js +115 -0
  225. package/dist/model/Leaderboard.js +1 -1
  226. package/dist/model/LeaderboardPage.js +1 -1
  227. package/dist/model/LeaderboardRecord.js +1 -1
  228. package/dist/model/LeaderboardRecordPage.js +1 -1
  229. package/dist/model/LeaderboardRecordResponse.js +1 -1
  230. package/dist/model/LeaderboardResponse.js +1 -1
  231. package/dist/model/LeaderboardsBySlugResponse.js +1 -1
  232. package/dist/model/{ListCurrentUserLedger200ResponseDataInner.js → LedgerEntry.js} +65 -26
  233. package/dist/model/LedgerEntryPage.js +147 -0
  234. package/dist/model/LinkAppleIosRequest.js +113 -0
  235. package/dist/model/LinkDeviceRequest.js +1 -1
  236. package/dist/model/LinkGoogleIdTokenRequest.js +113 -0
  237. package/dist/model/LinkProviderRequest.js +113 -0
  238. package/dist/model/LinkedProviders.js +1 -1
  239. package/dist/model/Lobby.js +1 -1
  240. package/dist/model/LobbyPage.js +1 -1
  241. package/dist/model/LobbyResponse.js +1 -1
  242. package/dist/model/LobbyStats.js +1 -1
  243. package/dist/model/LobbyStatsResponse.js +1 -1
  244. package/dist/model/LoginRequest.js +1 -1
  245. package/dist/model/MarkChatReadRequest.js +1 -1
  246. package/dist/model/MatchmakingJoinRequest.js +1 -1
  247. package/dist/model/MatchmakingQueue.js +121 -0
  248. package/dist/model/{MatchmakingStats200ResponseData.js → MatchmakingStats.js} +53 -30
  249. package/dist/model/MatchmakingStatsResponse.js +115 -0
  250. package/dist/model/{MatchmakingJoin201ResponseData.js → MatchmakingTicket.js} +75 -33
  251. package/dist/model/MatchmakingTicketResponse.js +115 -0
  252. package/dist/model/MuteGroupMemberRequest.js +1 -1
  253. package/dist/model/MuteLobbyMemberRequest.js +1 -1
  254. package/dist/model/MutePartyMemberRequest.js +1 -1
  255. package/dist/model/{AdminListSessions200Response.js → MyReadyChecks.js} +57 -49
  256. package/dist/model/MyReadyChecksResponse.js +115 -0
  257. package/dist/model/Notification.js +1 -1
  258. package/dist/model/NotificationPage.js +1 -1
  259. package/dist/model/NotificationResponse.js +1 -1
  260. package/dist/model/OAuthAuthorization.js +1 -1
  261. package/dist/model/OAuthAuthorizationResponse.js +1 -1
  262. package/dist/model/OAuthSessionStatus.js +37 -26
  263. package/dist/model/OAuthSessionStatusResponse.js +1 -1
  264. package/dist/model/OauthApiCallbackRequest.js +29 -6
  265. package/dist/model/OauthCallbackApiAppleIosRequest.js +1 -1
  266. package/dist/model/OauthGoogleIdTokenRequest.js +1 -1
  267. package/dist/model/OkResponse.js +1 -1
  268. package/dist/model/OpenLobbyReadyCheckRequest.js +1 -1
  269. package/dist/model/OpenPartyReadyCheckRequest.js +1 -1
  270. package/dist/model/PageMeta.js +1 -1
  271. package/dist/model/Party.js +1 -1
  272. package/dist/model/PartyCreateLobbyRequest.js +1 -1
  273. package/dist/model/PartyInvite.js +1 -1
  274. package/dist/model/PartyInvitePage.js +1 -1
  275. package/dist/model/PartyJoinLobbyRequest.js +1 -1
  276. package/dist/model/PartyResponse.js +1 -1
  277. package/dist/model/PartyStats.js +1 -1
  278. package/dist/model/PartyStatsResponse.js +1 -1
  279. package/dist/model/PaymentCatalogEntry.js +195 -0
  280. package/dist/model/{AdminListChatFilterWords200Response.js → PaymentCatalogEntryPage.js} +56 -45
  281. package/dist/model/{AdminUpdateGroup200Response.js → PaymentProduct.js} +72 -91
  282. package/dist/model/{AdminListKvEntries200Response.js → PaymentWebhookReceipt.js} +64 -51
  283. package/dist/model/PaymentWebhookReceiptResponse.js +115 -0
  284. package/dist/model/PaymentsSteamCheckoutRequest.js +1 -1
  285. package/dist/model/PaymentsSteamFinalizeRequest.js +1 -1
  286. package/dist/model/PaymentsStripeCheckoutRequest.js +1 -1
  287. package/dist/model/PlayerStats.js +1 -1
  288. package/dist/model/PlayerStatsResponse.js +1 -1
  289. package/dist/model/PromoteGroupMemberRequest.js +1 -1
  290. package/dist/model/ProviderLinkStatus.js +181 -0
  291. package/dist/model/ProviderLinkStatusResponse.js +115 -0
  292. package/dist/model/PublicUser.js +5 -35
  293. package/dist/model/PublicUserPage.js +1 -1
  294. package/dist/model/PublicUserResponse.js +1 -1
  295. package/dist/model/Purchase.js +279 -0
  296. package/dist/model/PurchaseResponse.js +115 -0
  297. package/dist/model/PurchaseValidation.js +126 -0
  298. package/dist/model/PurchaseValidationResponse.js +115 -0
  299. package/dist/model/PushToken.js +1 -1
  300. package/dist/model/PushTokenPage.js +1 -1
  301. package/dist/model/PushTokenResponse.js +1 -1
  302. package/dist/model/{AdminListQuests200ResponseDataInner.js → Quest.js} +194 -73
  303. package/dist/model/{ClaimQuest200ResponseData.js → QuestClaim.js} +58 -35
  304. package/dist/model/QuestClaimResponse.js +115 -0
  305. package/dist/model/QuestFunnelResponse.js +112 -0
  306. package/dist/model/QuestObjective.js +136 -0
  307. package/dist/model/{AdminListChatMessages200Response.js → QuestPage.js} +57 -34
  308. package/dist/model/{UserQuests200ResponseDataInnerProgress.js → QuestProgress.js} +67 -31
  309. package/dist/model/QuestReward.js +157 -0
  310. package/dist/model/QuestStats.js +129 -0
  311. package/dist/model/QuestStatsResponse.js +115 -0
  312. package/dist/model/QuickJoinRequest.js +1 -1
  313. package/dist/model/{AdminListQuests200Response.js → ReadyCheckOutcomesResponse.js} +41 -47
  314. package/dist/model/ReadyCheckParticipant.js +179 -0
  315. package/dist/model/{GetMyReadyCheck200ResponseParty.js → ReadyCheckState.js} +119 -42
  316. package/dist/model/ReadyCheckStateResponse.js +115 -0
  317. package/dist/model/RefreshTokenRequest.js +1 -1
  318. package/dist/model/RegisterPushTokenRequest.js +1 -1
  319. package/dist/model/RegisterRequest.js +141 -0
  320. package/dist/model/ReportChatMessageRequest.js +1 -1
  321. package/dist/model/ResolveLeaderboardSlugsRequest.js +1 -1
  322. package/dist/model/RespondReadyCheckRequest.js +1 -1
  323. package/dist/model/RetentionStatus.js +133 -0
  324. package/dist/model/{AdminListQuestProgress200Response.js → RetentionStatusResponse.js} +44 -47
  325. package/dist/model/SendChatMessageRequest.js +1 -1
  326. package/dist/model/SendNotificationRequest.js +1 -1
  327. package/dist/model/ServerStats.js +227 -0
  328. package/dist/model/{OAuthResultResponse.js → ServerStatsResponse.js} +26 -26
  329. package/dist/model/ServerTime.js +110 -0
  330. package/dist/model/ServerTimeResponse.js +115 -0
  331. package/dist/model/Session.js +1 -1
  332. package/dist/model/SessionResponse.js +1 -1
  333. package/dist/model/SetCurrentUserAvatarRequest.js +1 -1
  334. package/dist/model/SetGroupIconRequest.js +1 -1
  335. package/dist/model/SetLobbyStateRequest.js +1 -1
  336. package/dist/model/SignalingStats.js +131 -0
  337. package/dist/model/SignalingStatsResponse.js +115 -0
  338. package/dist/model/SteamCheckout.js +144 -0
  339. package/dist/model/SteamCheckoutResponse.js +115 -0
  340. package/dist/model/StorageObject.js +134 -0
  341. package/dist/model/StorageObjectPage.js +147 -0
  342. package/dist/model/StorageObjectResponse.js +115 -0
  343. package/dist/model/StorageUsage.js +119 -0
  344. package/dist/model/StorageUsageResponse.js +115 -0
  345. package/dist/model/StripeCheckout.js +143 -0
  346. package/dist/model/StripeCheckoutResponse.js +115 -0
  347. package/dist/model/Tournament.js +1 -1
  348. package/dist/model/TournamentBracket.js +1 -1
  349. package/dist/model/TournamentBracketPage.js +1 -1
  350. package/dist/model/TournamentEntry.js +1 -1
  351. package/dist/model/TournamentEntryPage.js +1 -1
  352. package/dist/model/TournamentEntryResponse.js +1 -1
  353. package/dist/model/TournamentMatch.js +11 -6
  354. package/dist/model/TournamentMatchCounts.js +129 -0
  355. package/dist/model/TournamentMatchResponse.js +1 -1
  356. package/dist/model/TournamentPage.js +1 -1
  357. package/dist/model/TournamentPlacement.js +1 -1
  358. package/dist/model/TournamentResponse.js +1 -1
  359. package/dist/model/TournamentStandings.js +1 -1
  360. package/dist/model/TournamentStandingsResponse.js +1 -1
  361. package/dist/model/TournamentStats.js +141 -0
  362. package/dist/model/UnmuteGroupMemberRequest.js +1 -1
  363. package/dist/model/UnmuteLobbyMemberRequest.js +1 -1
  364. package/dist/model/UnmutePartyMemberRequest.js +1 -1
  365. package/dist/model/UpdateChatMessageRequest.js +1 -1
  366. package/dist/model/UpdateCurrentUserDisplayNameRequest.js +1 -1
  367. package/dist/model/UpdateCurrentUserPasswordRequest.js +1 -1
  368. package/dist/model/UpdateCurrentUserUsernameRequest.js +1 -1
  369. package/dist/model/UpdateGroupRequest.js +1 -1
  370. package/dist/model/UpdateLobbyRequest.js +1 -1
  371. package/dist/model/UpdatePartyRequest.js +1 -1
  372. package/dist/model/UploadTicket.js +1 -1
  373. package/dist/model/UploadTicketResponse.js +1 -1
  374. package/dist/model/UserBrief.js +1 -1
  375. package/dist/model/UserBriefPage.js +1 -1
  376. package/dist/model/WalletBalance.js +137 -0
  377. package/dist/model/WalletBalanceResponse.js +115 -0
  378. package/dist/model/WalletBalancesResponse.js +112 -0
  379. package/package.json +1 -1
  380. package/dist/model/AdminCancelMatchmakingTicket200Response.js +0 -91
  381. package/dist/model/AdminCancelReadyCheck200Response.js +0 -91
  382. package/dist/model/AdminCancelReadyCheck200ResponseData.js +0 -223
  383. package/dist/model/AdminConsumeItem400Response.js +0 -89
  384. package/dist/model/AdminCreateChatMute200Response.js +0 -91
  385. package/dist/model/AdminCreateLeaderboard200Response.js +0 -91
  386. package/dist/model/AdminCreateLeaderboard200ResponseData.js +0 -248
  387. package/dist/model/AdminDeleteChatConversation200Response.js +0 -91
  388. package/dist/model/AdminDeleteChatConversation200ResponseData.js +0 -85
  389. package/dist/model/AdminDeleteChatFilterWordsByLang200Response.js +0 -93
  390. package/dist/model/AdminDrawTournament200Response.js +0 -91
  391. package/dist/model/AdminGetAnalyticsCounts200ResponseTotalsInner.js +0 -97
  392. package/dist/model/AdminGetAnalyticsDaily200ResponseSeriesInner.js +0 -128
  393. package/dist/model/AdminImportChatFilterWords200Response.js +0 -93
  394. package/dist/model/AdminListChatMessages200ResponseDataInner.js +0 -213
  395. package/dist/model/AdminListLobbies200ResponseDataInner.js +0 -191
  396. package/dist/model/AdminListNotifications200ResponseDataInner.js +0 -173
  397. package/dist/model/AdminListReadyChecks200Response.js +0 -124
  398. package/dist/model/AdminListStorageObjects200ResponseDataInner.js +0 -105
  399. package/dist/model/AdminListStorageObjects200ResponseUsage.js +0 -93
  400. package/dist/model/AdminMatchmakingStats200Response.js +0 -91
  401. package/dist/model/AdminMatchmakingStats200ResponseData.js +0 -113
  402. package/dist/model/AdminResolveChatReport200Response.js +0 -91
  403. package/dist/model/AdminRunRetention200Response.js +0 -104
  404. package/dist/model/AdminTestChatPhrase200Response.js +0 -91
  405. package/dist/model/AdminTestChatPhrase200ResponseDataHitsInner.js +0 -113
  406. package/dist/model/AdminUpdateChatFilterWord200Response.js +0 -91
  407. package/dist/model/AdminUpdateLeaderboardRecord200Response.js +0 -91
  408. package/dist/model/AdminUpdateLobby200Response.js +0 -91
  409. package/dist/model/AdminUpdateUser200Response.js +0 -91
  410. package/dist/model/AdminUpsertKv200Response.js +0 -91
  411. package/dist/model/CallHook200Response.js +0 -88
  412. package/dist/model/ClaimQuest200Response.js +0 -91
  413. package/dist/model/GetCurrentUserInventory200Response.js +0 -87
  414. package/dist/model/GetKv200Response.js +0 -93
  415. package/dist/model/GetMyReadyCheck200Response.js +0 -105
  416. package/dist/model/GetMyReadyCheck200ResponseLobby.js +0 -257
  417. package/dist/model/GetServerTime200Response.js +0 -86
  418. package/dist/model/GetStats200Response.js +0 -91
  419. package/dist/model/GetStats200ResponseData.js +0 -151
  420. package/dist/model/MatchmakingCancel200Response.js +0 -85
  421. package/dist/model/MatchmakingJoin201Response.js +0 -91
  422. package/dist/model/MatchmakingMyTicket200Response.js +0 -91
  423. package/dist/model/MatchmakingMyTicket200ResponseData.js +0 -186
  424. package/dist/model/MatchmakingStats200Response.js +0 -91
  425. package/dist/model/MatchmakingStats200ResponseDataQueuesInner.js +0 -93
  426. package/dist/model/OAuthResult.js +0 -148
  427. package/dist/model/OAuthSessionData.js +0 -153
  428. package/dist/model/OAuthSessionDataDetails.js +0 -128
  429. package/dist/model/QuestStats200Response.js +0 -91
  430. package/dist/model/QuestStats200ResponseData.js +0 -101
  431. package/dist/model/SignalingStats200Response.js +0 -91
  432. package/dist/model/SignalingStats200ResponseData.js +0 -101
  433. package/dist/model/UserQuests200ResponseDataInnerObjectivesInner.js +0 -108
  434. package/dist/model/UserQuests200ResponseDataInnerRewardsInner.js +0 -130
  435. package/dist/model/UserQuests200ResponseMeta.js +0 -125
@@ -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.1241
21
+ * The version of the OpenAPI document: 1.0.1251
19
22
  *
20
23
  *
21
24
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -24,18 +27,34 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
24
27
  *
25
28
  */
26
29
  /**
27
- * The AdminResolveChatReport200ResponseData model module.
28
- * @module model/AdminResolveChatReport200ResponseData
30
+ * The ChatReport model module.
31
+ * @module model/ChatReport
29
32
  * @version 1.0.0
30
33
  */
31
- var AdminResolveChatReport200ResponseData = /*#__PURE__*/function () {
34
+ var ChatReport = /*#__PURE__*/function () {
32
35
  /**
33
- * Constructs a new <code>AdminResolveChatReport200ResponseData</code>.
34
- * @alias module:model/AdminResolveChatReport200ResponseData
36
+ * Constructs a new <code>ChatReport</code>.
37
+ * A chat report
38
+ * @alias module:model/ChatReport
39
+ * @param contentSnapshot {String}
40
+ * @param id {String}
41
+ * @param insertedAt {Date}
42
+ * @param messageId {String}
43
+ * @param reason {String}
44
+ * @param reportedUserId {String}
45
+ * @param reportedUserName {String}
46
+ * @param reporterId {String} Empty when the word filter filed it
47
+ * @param reporterName {String}
48
+ * @param resolutionNote {String}
49
+ * @param resolvedAt {Date}
50
+ * @param resolvedBy {String} Empty until resolved
51
+ * @param resolvedByName {String}
52
+ * @param status {module:model/ChatReport.StatusEnum}
53
+ * @param updatedAt {Date}
35
54
  */
36
- function AdminResolveChatReport200ResponseData() {
37
- _classCallCheck(this, AdminResolveChatReport200ResponseData);
38
- AdminResolveChatReport200ResponseData.initialize(this);
55
+ function ChatReport(contentSnapshot, id, insertedAt, messageId, reason, reportedUserId, reportedUserName, reporterId, reporterName, resolutionNote, resolvedAt, resolvedBy, resolvedByName, status, updatedAt) {
56
+ _classCallCheck(this, ChatReport);
57
+ ChatReport.initialize(this, contentSnapshot, id, insertedAt, messageId, reason, reportedUserId, reportedUserName, reporterId, reporterName, resolutionNote, resolvedAt, resolvedBy, resolvedByName, status, updatedAt);
39
58
  }
40
59
 
41
60
  /**
@@ -43,22 +62,38 @@ var AdminResolveChatReport200ResponseData = /*#__PURE__*/function () {
43
62
  * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
44
63
  * Only for internal use.
45
64
  */
46
- return _createClass(AdminResolveChatReport200ResponseData, null, [{
65
+ return _createClass(ChatReport, null, [{
47
66
  key: "initialize",
48
- value: function initialize(obj) {}
67
+ value: function initialize(obj, contentSnapshot, id, insertedAt, messageId, reason, reportedUserId, reportedUserName, reporterId, reporterName, resolutionNote, resolvedAt, resolvedBy, resolvedByName, status, updatedAt) {
68
+ obj['content_snapshot'] = contentSnapshot;
69
+ obj['id'] = id;
70
+ obj['inserted_at'] = insertedAt;
71
+ obj['message_id'] = messageId;
72
+ obj['reason'] = reason;
73
+ obj['reported_user_id'] = reportedUserId;
74
+ obj['reported_user_name'] = reportedUserName;
75
+ obj['reporter_id'] = reporterId;
76
+ obj['reporter_name'] = reporterName;
77
+ obj['resolution_note'] = resolutionNote;
78
+ obj['resolved_at'] = resolvedAt;
79
+ obj['resolved_by'] = resolvedBy;
80
+ obj['resolved_by_name'] = resolvedByName;
81
+ obj['status'] = status;
82
+ obj['updated_at'] = updatedAt;
83
+ }
49
84
 
50
85
  /**
51
- * Constructs a <code>AdminResolveChatReport200ResponseData</code> from a plain JavaScript object, optionally creating a new instance.
86
+ * Constructs a <code>ChatReport</code> from a plain JavaScript object, optionally creating a new instance.
52
87
  * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
53
88
  * @param {Object} data The plain JavaScript object bearing properties of interest.
54
- * @param {module:model/AdminResolveChatReport200ResponseData} obj Optional instance to populate.
55
- * @return {module:model/AdminResolveChatReport200ResponseData} The populated <code>AdminResolveChatReport200ResponseData</code> instance.
89
+ * @param {module:model/ChatReport} obj Optional instance to populate.
90
+ * @return {module:model/ChatReport} The populated <code>ChatReport</code> instance.
56
91
  */
57
92
  }, {
58
93
  key: "constructFromObject",
59
94
  value: function constructFromObject(data, obj) {
60
95
  if (data) {
61
- obj = obj || new AdminResolveChatReport200ResponseData();
96
+ obj = obj || new ChatReport();
62
97
  if (data.hasOwnProperty('content_snapshot')) {
63
98
  obj['content_snapshot'] = _ApiClient["default"].convertToType(data['content_snapshot'], 'String');
64
99
  }
@@ -109,14 +144,29 @@ var AdminResolveChatReport200ResponseData = /*#__PURE__*/function () {
109
144
  }
110
145
 
111
146
  /**
112
- * Validates the JSON data with respect to <code>AdminResolveChatReport200ResponseData</code>.
147
+ * Validates the JSON data with respect to <code>ChatReport</code>.
113
148
  * @param {Object} data The plain JavaScript object bearing properties of interest.
114
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>AdminResolveChatReport200ResponseData</code>.
149
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>ChatReport</code>.
115
150
  */
116
151
  }, {
117
152
  key: "validateJSON",
118
153
  value: function validateJSON(data) {
119
- // ensure the json data is a string
154
+ // check to make sure all required properties are present in the JSON string
155
+ var _iterator = _createForOfIteratorHelper(ChatReport.RequiredProperties),
156
+ _step;
157
+ try {
158
+ for (_iterator.s(); !(_step = _iterator.n()).done;) {
159
+ var property = _step.value;
160
+ if (!data.hasOwnProperty(property)) {
161
+ throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
162
+ }
163
+ }
164
+ // ensure the json data is a string
165
+ } catch (err) {
166
+ _iterator.e(err);
167
+ } finally {
168
+ _iterator.f();
169
+ }
120
170
  if (data['content_snapshot'] && !(typeof data['content_snapshot'] === 'string' || data['content_snapshot'] instanceof String)) {
121
171
  throw new Error("Expected the field `content_snapshot` to be a primitive type in the JSON string but got " + data['content_snapshot']);
122
172
  }
@@ -168,88 +218,91 @@ var AdminResolveChatReport200ResponseData = /*#__PURE__*/function () {
168
218
  }
169
219
  }]);
170
220
  }();
221
+ ChatReport.RequiredProperties = ["content_snapshot", "id", "inserted_at", "message_id", "reason", "reported_user_id", "reported_user_name", "reporter_id", "reporter_name", "resolution_note", "resolved_at", "resolved_by", "resolved_by_name", "status", "updated_at"];
222
+
171
223
  /**
172
224
  * @member {String} content_snapshot
173
225
  */
174
- AdminResolveChatReport200ResponseData.prototype['content_snapshot'] = undefined;
226
+ ChatReport.prototype['content_snapshot'] = undefined;
175
227
 
176
228
  /**
177
229
  * @member {String} id
178
230
  */
179
- AdminResolveChatReport200ResponseData.prototype['id'] = undefined;
231
+ ChatReport.prototype['id'] = undefined;
180
232
 
181
233
  /**
182
234
  * @member {Date} inserted_at
183
235
  */
184
- AdminResolveChatReport200ResponseData.prototype['inserted_at'] = undefined;
236
+ ChatReport.prototype['inserted_at'] = undefined;
185
237
 
186
238
  /**
187
239
  * @member {String} message_id
188
240
  */
189
- AdminResolveChatReport200ResponseData.prototype['message_id'] = undefined;
241
+ ChatReport.prototype['message_id'] = undefined;
190
242
 
191
243
  /**
192
244
  * @member {String} reason
193
245
  */
194
- AdminResolveChatReport200ResponseData.prototype['reason'] = undefined;
246
+ ChatReport.prototype['reason'] = undefined;
195
247
 
196
248
  /**
197
249
  * @member {String} reported_user_id
198
250
  */
199
- AdminResolveChatReport200ResponseData.prototype['reported_user_id'] = undefined;
251
+ ChatReport.prototype['reported_user_id'] = undefined;
200
252
 
201
253
  /**
202
254
  * @member {String} reported_user_name
203
255
  */
204
- AdminResolveChatReport200ResponseData.prototype['reported_user_name'] = undefined;
256
+ ChatReport.prototype['reported_user_name'] = undefined;
205
257
 
206
258
  /**
207
259
  * Empty when the word filter filed it
208
260
  * @member {String} reporter_id
209
261
  */
210
- AdminResolveChatReport200ResponseData.prototype['reporter_id'] = undefined;
262
+ ChatReport.prototype['reporter_id'] = undefined;
211
263
 
212
264
  /**
213
265
  * @member {String} reporter_name
214
266
  */
215
- AdminResolveChatReport200ResponseData.prototype['reporter_name'] = undefined;
267
+ ChatReport.prototype['reporter_name'] = undefined;
216
268
 
217
269
  /**
218
270
  * @member {String} resolution_note
219
271
  */
220
- AdminResolveChatReport200ResponseData.prototype['resolution_note'] = undefined;
272
+ ChatReport.prototype['resolution_note'] = undefined;
221
273
 
222
274
  /**
223
275
  * @member {Date} resolved_at
224
276
  */
225
- AdminResolveChatReport200ResponseData.prototype['resolved_at'] = undefined;
277
+ ChatReport.prototype['resolved_at'] = undefined;
226
278
 
227
279
  /**
280
+ * Empty until resolved
228
281
  * @member {String} resolved_by
229
282
  */
230
- AdminResolveChatReport200ResponseData.prototype['resolved_by'] = undefined;
283
+ ChatReport.prototype['resolved_by'] = undefined;
231
284
 
232
285
  /**
233
286
  * @member {String} resolved_by_name
234
287
  */
235
- AdminResolveChatReport200ResponseData.prototype['resolved_by_name'] = undefined;
288
+ ChatReport.prototype['resolved_by_name'] = undefined;
236
289
 
237
290
  /**
238
- * @member {module:model/AdminResolveChatReport200ResponseData.StatusEnum} status
291
+ * @member {module:model/ChatReport.StatusEnum} status
239
292
  */
240
- AdminResolveChatReport200ResponseData.prototype['status'] = undefined;
293
+ ChatReport.prototype['status'] = undefined;
241
294
 
242
295
  /**
243
296
  * @member {Date} updated_at
244
297
  */
245
- AdminResolveChatReport200ResponseData.prototype['updated_at'] = undefined;
298
+ ChatReport.prototype['updated_at'] = undefined;
246
299
 
247
300
  /**
248
301
  * Allowed values for the <code>status</code> property.
249
302
  * @enum {String}
250
303
  * @readonly
251
304
  */
252
- AdminResolveChatReport200ResponseData['StatusEnum'] = {
305
+ ChatReport['StatusEnum'] = {
253
306
  /**
254
307
  * value: "open"
255
308
  * @const
@@ -271,4 +324,4 @@ AdminResolveChatReport200ResponseData['StatusEnum'] = {
271
324
  */
272
325
  "dismissed": "dismissed"
273
326
  };
274
- var _default = exports["default"] = AdminResolveChatReport200ResponseData;
327
+ var _default = exports["default"] = ChatReport;
@@ -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 _AdminListMatchmakingTickets200ResponseDataInner = _interopRequireDefault(require("./AdminListMatchmakingTickets200ResponseDataInner"));
9
- var _UserQuests200ResponseMeta = _interopRequireDefault(require("./UserQuests200ResponseMeta"));
8
+ var _ChatReport = _interopRequireDefault(require("./ChatReport"));
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.1241
23
+ * The version of the OpenAPI document: 1.0.1251
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 AdminListMatchmakingTickets200Response model module.
33
- * @module model/AdminListMatchmakingTickets200Response
32
+ * The ChatReportPage model module.
33
+ * @module model/ChatReportPage
34
34
  * @version 1.0.0
35
35
  */
36
- var AdminListMatchmakingTickets200Response = /*#__PURE__*/function () {
36
+ var ChatReportPage = /*#__PURE__*/function () {
37
37
  /**
38
- * Constructs a new <code>AdminListMatchmakingTickets200Response</code>.
39
- * @alias module:model/AdminListMatchmakingTickets200Response
38
+ * Constructs a new <code>ChatReportPage</code>.
39
+ * A page of ChatReport rows
40
+ * @alias module:model/ChatReportPage
41
+ * @param data {Array.<module:model/ChatReport>}
42
+ * @param meta {module:model/PageMeta}
40
43
  */
41
- function AdminListMatchmakingTickets200Response() {
42
- _classCallCheck(this, AdminListMatchmakingTickets200Response);
43
- AdminListMatchmakingTickets200Response.initialize(this);
44
+ function ChatReportPage(data, meta) {
45
+ _classCallCheck(this, ChatReportPage);
46
+ ChatReportPage.initialize(this, data, meta);
44
47
  }
45
48
 
46
49
  /**
@@ -48,40 +51,58 @@ var AdminListMatchmakingTickets200Response = /*#__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(AdminListMatchmakingTickets200Response, null, [{
54
+ return _createClass(ChatReportPage, 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>AdminListMatchmakingTickets200Response</code> from a plain JavaScript object, optionally creating a new instance.
62
+ * Constructs a <code>ChatReportPage</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/AdminListMatchmakingTickets200Response} obj Optional instance to populate.
60
- * @return {module:model/AdminListMatchmakingTickets200Response} The populated <code>AdminListMatchmakingTickets200Response</code> instance.
65
+ * @param {module:model/ChatReportPage} obj Optional instance to populate.
66
+ * @return {module:model/ChatReportPage} The populated <code>ChatReportPage</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 AdminListMatchmakingTickets200Response();
72
+ obj = obj || new ChatReportPage();
67
73
  if (data.hasOwnProperty('data')) {
68
- obj['data'] = _ApiClient["default"].convertToType(data['data'], [_AdminListMatchmakingTickets200ResponseDataInner["default"]]);
74
+ obj['data'] = _ApiClient["default"].convertToType(data['data'], [_ChatReport["default"]]);
69
75
  }
70
76
  if (data.hasOwnProperty('meta')) {
71
- obj['meta'] = _UserQuests200ResponseMeta["default"].constructFromObject(data['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>AdminListMatchmakingTickets200Response</code>.
84
+ * Validates the JSON data with respect to <code>ChatReportPage</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>AdminListMatchmakingTickets200Response</code>.
86
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>ChatReportPage</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(ChatReportPage.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 AdminListMatchmakingTickets200Response = /*#__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 _iterator = _createForOfIteratorHelper(data['data']),
93
- _step;
113
+ var _iterator2 = _createForOfIteratorHelper(data['data']),
114
+ _step2;
94
115
  try {
95
- for (_iterator.s(); !(_step = _iterator.n()).done;) {
96
- var item = _step.value;
97
- _AdminListMatchmakingTickets200ResponseDataInner["default"].validateJSON(item);
116
+ for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
117
+ var item = _step2.value;
118
+ _ChatReport["default"].validateJSON(item);
98
119
  }
99
120
  } catch (err) {
100
- _iterator.e(err);
121
+ _iterator2.e(err);
101
122
  } finally {
102
- _iterator.f();
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
- _UserQuests200ResponseMeta["default"].validateJSON(data['meta']);
130
+ _PageMeta["default"].validateJSON(data['meta']);
110
131
  }
111
132
  return true;
112
133
  }
113
134
  }]);
114
135
  }();
136
+ ChatReportPage.RequiredProperties = ["data", "meta"];
137
+
115
138
  /**
116
- * @member {Array.<module:model/AdminListMatchmakingTickets200ResponseDataInner>} data
139
+ * @member {Array.<module:model/ChatReport>} data
117
140
  */
118
- AdminListMatchmakingTickets200Response.prototype['data'] = undefined;
141
+ ChatReportPage.prototype['data'] = undefined;
119
142
 
120
143
  /**
121
- * @member {module:model/UserQuests200ResponseMeta} meta
144
+ * @member {module:model/PageMeta} meta
122
145
  */
123
- AdminListMatchmakingTickets200Response.prototype['meta'] = undefined;
124
- var _default = exports["default"] = AdminListMatchmakingTickets200Response;
146
+ ChatReportPage.prototype['meta'] = undefined;
147
+ var _default = exports["default"] = ChatReportPage;