@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.
Files changed (345) hide show
  1. package/README.md +74 -28
  2. package/dist/ApiClient.js +1 -1
  3. package/dist/api/AdminAnalyticsApi.js +1 -1
  4. package/dist/api/AdminChatApi.js +1 -1
  5. package/dist/api/AdminEconomyApi.js +5 -4
  6. package/dist/api/AdminGroupsApi.js +1 -1
  7. package/dist/api/AdminKVApi.js +5 -4
  8. package/dist/api/AdminLeaderboardsApi.js +9 -9
  9. package/dist/api/AdminLobbiesApi.js +1 -1
  10. package/dist/api/AdminMatchmakingApi.js +1 -1
  11. package/dist/api/AdminNotificationsApi.js +1 -1
  12. package/dist/api/AdminPushApi.js +1 -1
  13. package/dist/api/AdminQuestsApi.js +17 -14
  14. package/dist/api/AdminReadyChecksApi.js +1 -1
  15. package/dist/api/AdminRetentionApi.js +1 -1
  16. package/dist/api/AdminSessionsApi.js +1 -1
  17. package/dist/api/AdminStorageApi.js +1 -1
  18. package/dist/api/AdminTournamentsApi.js +9 -8
  19. package/dist/api/AdminUsersApi.js +1 -1
  20. package/dist/api/AuthenticationApi.js +22 -21
  21. package/dist/api/ChatApi.js +77 -69
  22. package/dist/api/ClientLogsApi.js +1 -1
  23. package/dist/api/EconomyApi.js +1 -1
  24. package/dist/api/FriendsApi.js +27 -25
  25. package/dist/api/GroupsApi.js +66 -65
  26. package/dist/api/HealthApi.js +1 -1
  27. package/dist/api/HooksApi.js +1 -1
  28. package/dist/api/KVApi.js +1 -1
  29. package/dist/api/LeaderboardsApi.js +31 -32
  30. package/dist/api/LobbiesApi.js +34 -34
  31. package/dist/api/MatchmakingApi.js +1 -1
  32. package/dist/api/NotificationsApi.js +14 -14
  33. package/dist/api/PartiesApi.js +75 -54
  34. package/dist/api/PaymentsApi.js +1 -1
  35. package/dist/api/PushApi.js +13 -13
  36. package/dist/api/QuestsApi.js +1 -1
  37. package/dist/api/ReadyChecksApi.js +5 -4
  38. package/dist/api/SignalingApi.js +1 -1
  39. package/dist/api/StatsApi.js +1 -1
  40. package/dist/api/TimeApi.js +1 -1
  41. package/dist/api/TournamentsApi.js +58 -45
  42. package/dist/api/UsersApi.js +35 -36
  43. package/dist/index.js +460 -138
  44. package/dist/model/AcceptPartyInviteRequest.js +1 -1
  45. package/dist/model/AdminCancelMatchmakingTicket200Response.js +1 -1
  46. package/dist/model/AdminCancelReadyCheck200Response.js +1 -1
  47. package/dist/model/AdminCancelReadyCheck200ResponseData.js +1 -1
  48. package/dist/model/AdminClaimQuestRequest.js +127 -0
  49. package/dist/model/AdminConsumeItem400Response.js +1 -1
  50. package/dist/model/AdminCreateChatFilterWordRequest.js +1 -1
  51. package/dist/model/AdminCreateChatMute200Response.js +1 -1
  52. package/dist/model/AdminCreateChatMuteRequest.js +1 -1
  53. package/dist/model/AdminCreateKvEntryRequest.js +154 -0
  54. package/dist/model/AdminCreateLeaderboard200Response.js +1 -1
  55. package/dist/model/AdminCreateLeaderboard200ResponseData.js +1 -1
  56. package/dist/model/AdminCreateLeaderboardRequest.js +1 -1
  57. package/dist/model/AdminCreateNotificationRequest.js +1 -1
  58. package/dist/model/AdminCreateQuestRequest.js +1 -1
  59. package/dist/model/AdminCreateQuestRequestObjectivesInner.js +1 -1
  60. package/dist/model/AdminCreateQuestRequestRewardsInner.js +1 -1
  61. package/dist/model/{ListTournaments200ResponseDataInner.js → AdminCreateTournamentRequest.js} +80 -85
  62. package/dist/model/AdminDeleteChatConversation200Response.js +1 -1
  63. package/dist/model/AdminDeleteChatConversation200ResponseData.js +1 -1
  64. package/dist/model/AdminDeleteChatFilterWordsByLang200Response.js +1 -1
  65. package/dist/model/AdminDrawTournament200Response.js +1 -1
  66. package/dist/model/AdminDrawTournament200ResponseData.js +1 -1
  67. package/dist/model/AdminGetAnalyticsCounts200Response.js +1 -1
  68. package/dist/model/AdminGetAnalyticsCounts200ResponseTotalsInner.js +1 -1
  69. package/dist/model/AdminGetAnalyticsDaily200Response.js +1 -1
  70. package/dist/model/AdminGetAnalyticsDaily200ResponseSeriesInner.js +1 -1
  71. package/dist/model/AdminGetAnalyticsEconomy200Response.js +1 -1
  72. package/dist/model/AdminGetAnalyticsEconomy200ResponseFlowInner.js +1 -1
  73. package/dist/model/AdminGetAnalyticsEconomy200ResponseTotalsInner.js +1 -1
  74. package/dist/model/AdminGetAnalyticsSummary200Response.js +1 -1
  75. package/dist/model/AdminGrantCurrencyRequest.js +160 -0
  76. package/dist/model/AdminGrantItemRequest.js +1 -1
  77. package/dist/model/AdminGrantQuestRequest.js +127 -0
  78. package/dist/model/AdminImportChatFilterWords200Response.js +1 -1
  79. package/dist/model/AdminImportChatFilterWordsRequest.js +1 -1
  80. package/dist/model/AdminLeaderboardIconUploadUrlRequest.js +112 -0
  81. package/dist/model/AdminListChatFilterWords200Response.js +1 -1
  82. package/dist/model/AdminListChatMessages200Response.js +1 -1
  83. package/dist/model/AdminListChatMessages200ResponseDataInner.js +1 -1
  84. package/dist/model/AdminListChatMutes200Response.js +1 -1
  85. package/dist/model/AdminListChatMutes200ResponseDataInner.js +1 -1
  86. package/dist/model/AdminListChatReports200Response.js +1 -1
  87. package/dist/model/AdminListGroups200Response.js +1 -1
  88. package/dist/model/AdminListKvEntries200Response.js +1 -1
  89. package/dist/model/AdminListLobbies200Response.js +1 -1
  90. package/dist/model/AdminListLobbies200ResponseDataInner.js +1 -1
  91. package/dist/model/AdminListMatchmakingTickets200Response.js +1 -1
  92. package/dist/model/AdminListMatchmakingTickets200ResponseDataInner.js +1 -1
  93. package/dist/model/AdminListNotifications200Response.js +1 -1
  94. package/dist/model/AdminListNotifications200ResponseDataInner.js +1 -1
  95. package/dist/model/AdminListPushTokens200Response.js +1 -1
  96. package/dist/model/AdminListPushTokens200ResponseDataInner.js +1 -1
  97. package/dist/model/AdminListQuestProgress200Response.js +1 -1
  98. package/dist/model/AdminListQuestProgress200ResponseDataInner.js +1 -1
  99. package/dist/model/AdminListQuests200Response.js +1 -1
  100. package/dist/model/AdminListQuests200ResponseDataInner.js +1 -1
  101. package/dist/model/AdminListReadyChecks200Response.js +1 -1
  102. package/dist/model/AdminListSessions200Response.js +1 -1
  103. package/dist/model/AdminListSessions200ResponseDataInner.js +1 -1
  104. package/dist/model/AdminListStorageObjects200Response.js +1 -1
  105. package/dist/model/AdminListStorageObjects200ResponseDataInner.js +1 -1
  106. package/dist/model/AdminListStorageObjects200ResponseUsage.js +1 -1
  107. package/dist/model/AdminMatchmakingStats200Response.js +1 -1
  108. package/dist/model/AdminMatchmakingStats200ResponseData.js +1 -1
  109. package/dist/model/AdminQuestIconUploadUrlRequest.js +112 -0
  110. package/dist/model/AdminResetQuestRequest.js +1 -1
  111. package/dist/model/AdminResolveChatReport200Response.js +1 -1
  112. package/dist/model/AdminResolveChatReport200ResponseData.js +1 -1
  113. package/dist/model/AdminResolveChatReportRequest.js +1 -1
  114. package/dist/model/AdminResolveTournamentMatchRequest.js +1 -1
  115. package/dist/model/AdminRunRetention200Response.js +1 -1
  116. package/dist/model/AdminSendPush200Response.js +1 -1
  117. package/dist/model/AdminSendPushRequest.js +1 -1
  118. package/dist/model/AdminSetLeaderboardIconRequest.js +112 -0
  119. package/dist/model/AdminSetQuestIconRequest.js +1 -1
  120. package/dist/model/AdminSetTournamentIconRequest.js +112 -0
  121. package/dist/model/AdminSpendCurrencyRequest.js +1 -1
  122. package/dist/model/AdminSubmitLeaderboardScoreRequest.js +1 -1
  123. package/dist/model/AdminTestChatPhrase200Response.js +1 -1
  124. package/dist/model/AdminTestChatPhrase200ResponseData.js +1 -1
  125. package/dist/model/AdminTestChatPhrase200ResponseDataHitsInner.js +1 -1
  126. package/dist/model/AdminTestChatPhraseRequest.js +1 -1
  127. package/dist/model/AdminTournamentIconUploadUrlRequest.js +1 -1
  128. package/dist/model/AdminUpdateChatFilterWord200Response.js +1 -1
  129. package/dist/model/AdminUpdateChatFilterWord200ResponseData.js +1 -1
  130. package/dist/model/AdminUpdateChatFilterWordRequest.js +1 -1
  131. package/dist/model/AdminUpdateGroup200Response.js +1 -1
  132. package/dist/model/AdminUpdateGroupRequest.js +1 -1
  133. package/dist/model/AdminUpdateKvEntryRequest.js +1 -1
  134. package/dist/model/AdminUpdateLeaderboardRecord200Response.js +1 -1
  135. package/dist/model/AdminUpdateLeaderboardRecord200ResponseData.js +1 -1
  136. package/dist/model/AdminUpdateLeaderboardRecordRequest.js +1 -1
  137. package/dist/model/AdminUpdateLeaderboardRequest.js +1 -1
  138. package/dist/model/AdminUpdateLobby200Response.js +1 -1
  139. package/dist/model/AdminUpdateLobbyRequest.js +1 -1
  140. package/dist/model/AdminUpdateQuestRequest.js +350 -0
  141. package/dist/model/AdminUpdateTournamentRequest.js +1 -1
  142. package/dist/model/AdminUpdateUser200Response.js +1 -1
  143. package/dist/model/AdminUpdateUser200ResponseData.js +1 -1
  144. package/dist/model/AdminUpdateUserRequest.js +1 -1
  145. package/dist/model/AdminUpsertKv200Response.js +1 -1
  146. package/dist/model/AdminUpsertKv200ResponseData.js +1 -1
  147. package/dist/model/AdminUpsertKvRequest.js +1 -1
  148. package/dist/model/AuthProvidersResponse.js +1 -1
  149. package/dist/model/BlockedFriendship.js +1 -1
  150. package/dist/model/BlockedFriendshipPage.js +1 -1
  151. package/dist/model/CallHook200Response.js +1 -1
  152. package/dist/model/CallHookRequest.js +1 -1
  153. package/dist/model/CancelPartyInviteRequest.js +1 -1
  154. package/dist/model/{ListChatMessages200ResponseDataInner.js → ChatMessage.js} +87 -41
  155. package/dist/model/{ListNotifications200Response.js → ChatMessagePage.js} +57 -34
  156. package/dist/model/{ListTournaments200Response.js → ChatMessageResponse.js} +45 -40
  157. package/dist/model/{ListGroupMutes200ResponseDataInner.js → ChatMuteRecord.js} +71 -29
  158. package/dist/model/ChatMuteRecordPage.js +147 -0
  159. package/dist/model/{ListRecordsAroundUser200Response.js → ChatMuteRecordResponse.js} +45 -40
  160. package/dist/model/ChatReadCursor.js +151 -0
  161. package/dist/model/ChatReadCursorResponse.js +115 -0
  162. package/dist/model/ChatUnread.js +109 -0
  163. package/dist/model/ChatUnreadResponse.js +115 -0
  164. package/dist/model/ClaimQuest200Response.js +1 -1
  165. package/dist/model/ClaimQuest200ResponseData.js +1 -1
  166. package/dist/model/ClientLogBatch.js +1 -1
  167. package/dist/model/ClientLogEntry.js +1 -1
  168. package/dist/model/ClientLogPolicy.js +1 -1
  169. package/dist/model/ClientLogResult.js +1 -1
  170. package/dist/model/ClientLogSession.js +1 -1
  171. package/dist/model/CreateCurrentUserAvatarUploadUrlRequest.js +1 -1
  172. package/dist/model/CreateFriendRequestRequest.js +1 -1
  173. package/dist/model/CreateGroupIconUploadUrlRequest.js +112 -0
  174. package/dist/model/CreateGroupRequest.js +1 -1
  175. package/dist/model/CreateLobbyRequest.js +1 -1
  176. package/dist/model/CreatePartyRequest.js +1 -1
  177. package/dist/model/CurrentUser.js +1 -1
  178. package/dist/model/CurrentUserResponse.js +115 -0
  179. package/dist/model/DeclinePartyInviteRequest.js +1 -1
  180. package/dist/model/DeleteNotificationsRequest.js +1 -1
  181. package/dist/model/DeletedCount.js +109 -0
  182. package/dist/model/DeletedCountResponse.js +115 -0
  183. package/dist/model/DemoteGroupMemberRequest.js +1 -1
  184. package/dist/model/DeviceLoginRequest.js +1 -1
  185. package/dist/model/ErrorResponse.js +4 -26
  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 +115 -0
  192. package/dist/model/FriendRequestsResponse.js +1 -1
  193. package/dist/model/GetCurrentUserInventory200Response.js +1 -1
  194. package/dist/model/GetKv200Response.js +1 -1
  195. package/dist/model/GetMyReadyCheck200Response.js +1 -1
  196. package/dist/model/GetMyReadyCheck200ResponseLobby.js +1 -1
  197. package/dist/model/GetMyReadyCheck200ResponseParty.js +1 -1
  198. package/dist/model/GetServerTime200Response.js +1 -1
  199. package/dist/model/GetStats200Response.js +1 -1
  200. package/dist/model/GetStats200ResponseData.js +1 -1
  201. package/dist/model/Group.js +1 -1
  202. package/dist/model/GroupInvite.js +13 -14
  203. package/dist/model/GroupInviteOutcome.js +132 -0
  204. package/dist/model/GroupInviteOutcomeResponse.js +115 -0
  205. package/dist/model/GroupInvitePage.js +1 -1
  206. package/dist/model/GroupJoinRequest.js +1 -1
  207. package/dist/model/GroupJoinRequestPage.js +1 -1
  208. package/dist/model/GroupJoinRequestResponse.js +115 -0
  209. package/dist/model/GroupMember.js +1 -1
  210. package/dist/model/GroupMemberPage.js +1 -1
  211. package/dist/model/GroupMemberResponse.js +115 -0
  212. package/dist/model/GroupPage.js +1 -1
  213. package/dist/model/GroupResponse.js +115 -0
  214. package/dist/model/HealthResponse.js +1 -1
  215. package/dist/model/InviteToGroupRequest.js +1 -1
  216. package/dist/model/InviteToPartyRequest.js +1 -1
  217. package/dist/model/{ChatUnreadCount200ResponseData.js → JoinLobbyRequest.js} +26 -21
  218. package/dist/model/KickGroupMemberRequest.js +1 -1
  219. package/dist/model/KickPartyMemberRequest.js +1 -1
  220. package/dist/model/KickUserRequest.js +113 -0
  221. package/dist/model/{ResolveLeaderboardSlugs200ResponseDataValue.js → Leaderboard.js} +90 -45
  222. package/dist/model/{ListGroupMutes200Response.js → LeaderboardPage.js} +57 -34
  223. package/dist/model/{GetMyRecord200ResponseData.js → LeaderboardRecord.js} +66 -31
  224. package/dist/model/LeaderboardRecordPage.js +147 -0
  225. package/dist/model/{ListPushTokens200Response.js → LeaderboardRecordResponse.js} +44 -47
  226. package/dist/model/LeaderboardResponse.js +115 -0
  227. package/dist/model/LeaderboardsBySlugResponse.js +113 -0
  228. package/dist/model/LinkDeviceRequest.js +1 -1
  229. package/dist/model/LinkedProviders.js +1 -1
  230. package/dist/model/ListCurrentUserLedger200Response.js +1 -1
  231. package/dist/model/ListCurrentUserLedger200ResponseDataInner.js +1 -1
  232. package/dist/model/Lobby.js +1 -1
  233. package/dist/model/LobbyPage.js +1 -1
  234. package/dist/model/LobbyResponse.js +6 -49
  235. package/dist/model/LobbyStats.js +1 -1
  236. package/dist/model/LobbyStatsResponse.js +1 -1
  237. package/dist/model/LoginRequest.js +1 -1
  238. package/dist/model/MarkChatReadRequest.js +1 -1
  239. package/dist/model/MatchmakingCancel200Response.js +1 -1
  240. package/dist/model/MatchmakingJoin201Response.js +1 -1
  241. package/dist/model/MatchmakingJoin201ResponseData.js +1 -1
  242. package/dist/model/MatchmakingJoinRequest.js +1 -1
  243. package/dist/model/MatchmakingMyTicket200Response.js +1 -1
  244. package/dist/model/MatchmakingMyTicket200ResponseData.js +1 -1
  245. package/dist/model/MatchmakingStats200Response.js +1 -1
  246. package/dist/model/MatchmakingStats200ResponseData.js +1 -1
  247. package/dist/model/MatchmakingStats200ResponseDataQueuesInner.js +1 -1
  248. package/dist/model/MuteGroupMemberRequest.js +1 -1
  249. package/dist/model/{ProfileUpdate.js → MuteLobbyMemberRequest.js} +41 -56
  250. package/dist/model/MutePartyMemberRequest.js +135 -0
  251. package/dist/model/{ListNotifications200ResponseDataInner.js → Notification.js} +70 -37
  252. package/dist/model/NotificationPage.js +147 -0
  253. package/dist/model/NotificationResponse.js +115 -0
  254. package/dist/model/OAuthAuthorization.js +1 -1
  255. package/dist/model/OAuthAuthorizationResponse.js +115 -0
  256. package/dist/model/OAuthResult.js +1 -1
  257. package/dist/model/OAuthResultResponse.js +1 -1
  258. package/dist/model/OAuthSessionData.js +1 -1
  259. package/dist/model/OAuthSessionDataDetails.js +1 -1
  260. package/dist/model/OAuthSessionStatus.js +21 -21
  261. package/dist/model/OAuthSessionStatusResponse.js +115 -0
  262. package/dist/model/OauthApiCallbackRequest.js +1 -1
  263. package/dist/model/OauthCallbackApiAppleIosRequest.js +1 -1
  264. package/dist/model/OauthGoogleIdTokenRequest.js +1 -1
  265. package/dist/model/{AvatarUpdate.js → OkResponse.js} +22 -37
  266. package/dist/model/OpenLobbyReadyCheck201Response.js +1 -1
  267. package/dist/model/OpenLobbyReadyCheckRequest.js +1 -1
  268. package/dist/model/{ChatUnreadCount200Response.js → OpenPartyReadyCheckRequest.js} +31 -27
  269. package/dist/model/PageMeta.js +1 -1
  270. package/dist/model/Party.js +1 -1
  271. package/dist/model/PartyCreateLobbyRequest.js +1 -1
  272. package/dist/model/PartyInvite.js +1 -1
  273. package/dist/model/PartyInvitePage.js +147 -0
  274. package/dist/model/PartyJoinLobbyRequest.js +1 -1
  275. package/dist/model/PartyResponse.js +115 -0
  276. package/dist/model/PartyStats.js +1 -1
  277. package/dist/model/PartyStatsResponse.js +1 -1
  278. package/dist/model/PaymentsSteamCheckoutRequest.js +1 -1
  279. package/dist/model/PaymentsSteamFinalizeRequest.js +1 -1
  280. package/dist/model/PaymentsStripeCheckoutRequest.js +1 -1
  281. package/dist/model/PlayerStats.js +1 -1
  282. package/dist/model/PlayerStatsResponse.js +1 -1
  283. package/dist/model/PromoteGroupMemberRequest.js +1 -1
  284. package/dist/model/PublicUser.js +1 -1
  285. package/dist/model/PublicUserPage.js +1 -1
  286. package/dist/model/PublicUserResponse.js +115 -0
  287. package/dist/model/{DeletePushToken200Response.js → PushToken.js} +74 -71
  288. package/dist/model/{ListLeaderboardRecords200Response.js → PushTokenPage.js} +57 -34
  289. package/dist/model/PushTokenResponse.js +115 -0
  290. package/dist/model/QuestStats200Response.js +1 -1
  291. package/dist/model/QuestStats200ResponseData.js +1 -1
  292. package/dist/model/QuickJoinRequest.js +1 -1
  293. package/dist/model/RefreshTokenRequest.js +1 -1
  294. package/dist/model/RegisterPushTokenRequest.js +1 -1
  295. package/dist/model/ReportChatMessageRequest.js +1 -1
  296. package/dist/model/ResolveLeaderboardSlugsRequest.js +1 -1
  297. package/dist/model/RespondReadyCheckRequest.js +1 -1
  298. package/dist/model/SendChatMessageRequest.js +1 -1
  299. package/dist/model/SendNotificationRequest.js +1 -1
  300. package/dist/model/Session.js +1 -1
  301. package/dist/model/SessionResponse.js +1 -1
  302. package/dist/model/SetCurrentUserAvatarRequest.js +112 -0
  303. package/dist/model/{StatusResponse.js → SetGroupIconRequest.js} +28 -29
  304. package/dist/model/SetLobbyStateRequest.js +1 -1
  305. package/dist/model/SignalingStats200Response.js +1 -1
  306. package/dist/model/SignalingStats200ResponseData.js +1 -1
  307. package/dist/model/Tournament.js +341 -0
  308. package/dist/model/TournamentBracket.js +186 -0
  309. package/dist/model/TournamentBracketPage.js +147 -0
  310. package/dist/model/TournamentEntry.js +211 -0
  311. package/dist/model/TournamentEntryPage.js +147 -0
  312. package/dist/model/TournamentEntryResponse.js +115 -0
  313. package/dist/model/{TournamentMyMatch200Response.js → TournamentMatch.js} +100 -28
  314. package/dist/model/TournamentMatchResponse.js +115 -0
  315. package/dist/model/{ListLeaderboards200Response.js → TournamentPage.js} +57 -34
  316. package/dist/model/TournamentPlacement.js +200 -0
  317. package/dist/model/TournamentResponse.js +115 -0
  318. package/dist/model/TournamentStandings.js +163 -0
  319. package/dist/model/{ListChatMessages200Response.js → TournamentStandingsResponse.js} +44 -47
  320. package/dist/model/UnmuteGroupMemberRequest.js +113 -0
  321. package/dist/model/UnmuteLobbyMemberRequest.js +1 -1
  322. package/dist/model/UnmutePartyMemberRequest.js +113 -0
  323. package/dist/model/UpdateChatMessageRequest.js +1 -1
  324. package/dist/model/UpdateCurrentUserDisplayNameRequest.js +1 -1
  325. package/dist/model/UpdateCurrentUserPasswordRequest.js +1 -1
  326. package/dist/model/UpdateCurrentUserUsernameRequest.js +1 -1
  327. package/dist/model/UpdateGroupRequest.js +1 -1
  328. package/dist/model/UpdateLobbyRequest.js +1 -1
  329. package/dist/model/UpdatePartyRequest.js +1 -1
  330. package/dist/model/UploadTicket.js +1 -1
  331. package/dist/model/UploadTicketResponse.js +115 -0
  332. package/dist/model/UserBrief.js +1 -1
  333. package/dist/model/UserBriefPage.js +1 -1
  334. package/dist/model/UserQuests200Response.js +1 -1
  335. package/dist/model/UserQuests200ResponseDataInner.js +1 -1
  336. package/dist/model/UserQuests200ResponseDataInnerObjectivesInner.js +1 -1
  337. package/dist/model/UserQuests200ResponseDataInnerProgress.js +1 -1
  338. package/dist/model/UserQuests200ResponseDataInnerRewardsInner.js +1 -1
  339. package/dist/model/UserQuests200ResponseMeta.js +1 -1
  340. package/package.json +1 -1
  341. package/dist/model/DeleteNotifications200Response.js +0 -91
  342. package/dist/model/DeleteNotifications200ResponseData.js +0 -86
  343. package/dist/model/GetMyRecord200Response.js +0 -91
  344. package/dist/model/ListGroupMutes200ResponseMeta.js +0 -109
  345. package/dist/model/ResolveLeaderboardSlugs200Response.js +0 -89
package/README.md CHANGED
@@ -220,7 +220,7 @@ webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 }))
220
220
 
221
221
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
222
222
 
223
- - API version: 1.0.1239
223
+ - API version: 1.0.1241
224
224
  - Package version: 1.0.0
225
225
  - Generator version: 7.25.0
226
226
  - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
@@ -581,7 +581,7 @@ Class | Method | HTTP request | Description
581
581
  *UghuuuGamend.TournamentsApi* | [**listTournaments**](docs/TournamentsApi.md#listTournaments) | **GET** /api/v1/tournaments | List tournaments
582
582
  *UghuuuGamend.TournamentsApi* | [**tournamentBracket**](docs/TournamentsApi.md#tournamentBracket) | **GET** /api/v1/tournaments/{id}/bracket | Brackets and their matches (paginated by bracket)
583
583
  *UghuuuGamend.TournamentsApi* | [**tournamentEntries**](docs/TournamentsApi.md#tournamentEntries) | **GET** /api/v1/tournaments/{id}/entries | Registered entries (paginated)
584
- *UghuuuGamend.TournamentsApi* | [**tournamentMyMatch**](docs/TournamentsApi.md#tournamentMyMatch) | **GET** /api/v1/tournaments/{id}/my_match | The caller's current unresolved match, if any
584
+ *UghuuuGamend.TournamentsApi* | [**tournamentMyMatch**](docs/TournamentsApi.md#tournamentMyMatch) | **GET** /api/v1/tournaments/{id}/my_match | The caller's current unresolved match
585
585
  *UghuuuGamend.TournamentsApi* | [**tournamentStandings**](docs/TournamentsApi.md#tournamentStandings) | **GET** /api/v1/tournaments/{id}/standings | Placements, wins and champions
586
586
  *UghuuuGamend.UsersApi* | [**createCurrentUserAvatarUploadUrl**](docs/UsersApi.md#createCurrentUserAvatarUploadUrl) | **POST** /api/v1/me/avatar/upload_url | Request an avatar upload ticket
587
587
  *UghuuuGamend.UsersApi* | [**deleteCurrentUser**](docs/UsersApi.md#deleteCurrentUser) | **DELETE** /api/v1/me | Delete current user
@@ -601,10 +601,12 @@ Class | Method | HTTP request | Description
601
601
  - [UghuuuGamend.AdminCancelMatchmakingTicket200Response](docs/AdminCancelMatchmakingTicket200Response.md)
602
602
  - [UghuuuGamend.AdminCancelReadyCheck200Response](docs/AdminCancelReadyCheck200Response.md)
603
603
  - [UghuuuGamend.AdminCancelReadyCheck200ResponseData](docs/AdminCancelReadyCheck200ResponseData.md)
604
+ - [UghuuuGamend.AdminClaimQuestRequest](docs/AdminClaimQuestRequest.md)
604
605
  - [UghuuuGamend.AdminConsumeItem400Response](docs/AdminConsumeItem400Response.md)
605
606
  - [UghuuuGamend.AdminCreateChatFilterWordRequest](docs/AdminCreateChatFilterWordRequest.md)
606
607
  - [UghuuuGamend.AdminCreateChatMute200Response](docs/AdminCreateChatMute200Response.md)
607
608
  - [UghuuuGamend.AdminCreateChatMuteRequest](docs/AdminCreateChatMuteRequest.md)
609
+ - [UghuuuGamend.AdminCreateKvEntryRequest](docs/AdminCreateKvEntryRequest.md)
608
610
  - [UghuuuGamend.AdminCreateLeaderboard200Response](docs/AdminCreateLeaderboard200Response.md)
609
611
  - [UghuuuGamend.AdminCreateLeaderboard200ResponseData](docs/AdminCreateLeaderboard200ResponseData.md)
610
612
  - [UghuuuGamend.AdminCreateLeaderboardRequest](docs/AdminCreateLeaderboardRequest.md)
@@ -612,6 +614,7 @@ Class | Method | HTTP request | Description
612
614
  - [UghuuuGamend.AdminCreateQuestRequest](docs/AdminCreateQuestRequest.md)
613
615
  - [UghuuuGamend.AdminCreateQuestRequestObjectivesInner](docs/AdminCreateQuestRequestObjectivesInner.md)
614
616
  - [UghuuuGamend.AdminCreateQuestRequestRewardsInner](docs/AdminCreateQuestRequestRewardsInner.md)
617
+ - [UghuuuGamend.AdminCreateTournamentRequest](docs/AdminCreateTournamentRequest.md)
615
618
  - [UghuuuGamend.AdminDeleteChatConversation200Response](docs/AdminDeleteChatConversation200Response.md)
616
619
  - [UghuuuGamend.AdminDeleteChatConversation200ResponseData](docs/AdminDeleteChatConversation200ResponseData.md)
617
620
  - [UghuuuGamend.AdminDeleteChatFilterWordsByLang200Response](docs/AdminDeleteChatFilterWordsByLang200Response.md)
@@ -625,9 +628,12 @@ Class | Method | HTTP request | Description
625
628
  - [UghuuuGamend.AdminGetAnalyticsEconomy200ResponseFlowInner](docs/AdminGetAnalyticsEconomy200ResponseFlowInner.md)
626
629
  - [UghuuuGamend.AdminGetAnalyticsEconomy200ResponseTotalsInner](docs/AdminGetAnalyticsEconomy200ResponseTotalsInner.md)
627
630
  - [UghuuuGamend.AdminGetAnalyticsSummary200Response](docs/AdminGetAnalyticsSummary200Response.md)
631
+ - [UghuuuGamend.AdminGrantCurrencyRequest](docs/AdminGrantCurrencyRequest.md)
628
632
  - [UghuuuGamend.AdminGrantItemRequest](docs/AdminGrantItemRequest.md)
633
+ - [UghuuuGamend.AdminGrantQuestRequest](docs/AdminGrantQuestRequest.md)
629
634
  - [UghuuuGamend.AdminImportChatFilterWords200Response](docs/AdminImportChatFilterWords200Response.md)
630
635
  - [UghuuuGamend.AdminImportChatFilterWordsRequest](docs/AdminImportChatFilterWordsRequest.md)
636
+ - [UghuuuGamend.AdminLeaderboardIconUploadUrlRequest](docs/AdminLeaderboardIconUploadUrlRequest.md)
631
637
  - [UghuuuGamend.AdminListChatFilterWords200Response](docs/AdminListChatFilterWords200Response.md)
632
638
  - [UghuuuGamend.AdminListChatMessages200Response](docs/AdminListChatMessages200Response.md)
633
639
  - [UghuuuGamend.AdminListChatMessages200ResponseDataInner](docs/AdminListChatMessages200ResponseDataInner.md)
@@ -656,6 +662,7 @@ Class | Method | HTTP request | Description
656
662
  - [UghuuuGamend.AdminListStorageObjects200ResponseUsage](docs/AdminListStorageObjects200ResponseUsage.md)
657
663
  - [UghuuuGamend.AdminMatchmakingStats200Response](docs/AdminMatchmakingStats200Response.md)
658
664
  - [UghuuuGamend.AdminMatchmakingStats200ResponseData](docs/AdminMatchmakingStats200ResponseData.md)
665
+ - [UghuuuGamend.AdminQuestIconUploadUrlRequest](docs/AdminQuestIconUploadUrlRequest.md)
659
666
  - [UghuuuGamend.AdminResetQuestRequest](docs/AdminResetQuestRequest.md)
660
667
  - [UghuuuGamend.AdminResolveChatReport200Response](docs/AdminResolveChatReport200Response.md)
661
668
  - [UghuuuGamend.AdminResolveChatReport200ResponseData](docs/AdminResolveChatReport200ResponseData.md)
@@ -664,7 +671,9 @@ Class | Method | HTTP request | Description
664
671
  - [UghuuuGamend.AdminRunRetention200Response](docs/AdminRunRetention200Response.md)
665
672
  - [UghuuuGamend.AdminSendPush200Response](docs/AdminSendPush200Response.md)
666
673
  - [UghuuuGamend.AdminSendPushRequest](docs/AdminSendPushRequest.md)
674
+ - [UghuuuGamend.AdminSetLeaderboardIconRequest](docs/AdminSetLeaderboardIconRequest.md)
667
675
  - [UghuuuGamend.AdminSetQuestIconRequest](docs/AdminSetQuestIconRequest.md)
676
+ - [UghuuuGamend.AdminSetTournamentIconRequest](docs/AdminSetTournamentIconRequest.md)
668
677
  - [UghuuuGamend.AdminSpendCurrencyRequest](docs/AdminSpendCurrencyRequest.md)
669
678
  - [UghuuuGamend.AdminSubmitLeaderboardScoreRequest](docs/AdminSubmitLeaderboardScoreRequest.md)
670
679
  - [UghuuuGamend.AdminTestChatPhrase200Response](docs/AdminTestChatPhrase200Response.md)
@@ -684,6 +693,7 @@ Class | Method | HTTP request | Description
684
693
  - [UghuuuGamend.AdminUpdateLeaderboardRequest](docs/AdminUpdateLeaderboardRequest.md)
685
694
  - [UghuuuGamend.AdminUpdateLobby200Response](docs/AdminUpdateLobby200Response.md)
686
695
  - [UghuuuGamend.AdminUpdateLobbyRequest](docs/AdminUpdateLobbyRequest.md)
696
+ - [UghuuuGamend.AdminUpdateQuestRequest](docs/AdminUpdateQuestRequest.md)
687
697
  - [UghuuuGamend.AdminUpdateTournamentRequest](docs/AdminUpdateTournamentRequest.md)
688
698
  - [UghuuuGamend.AdminUpdateUser200Response](docs/AdminUpdateUser200Response.md)
689
699
  - [UghuuuGamend.AdminUpdateUser200ResponseData](docs/AdminUpdateUser200ResponseData.md)
@@ -692,14 +702,21 @@ Class | Method | HTTP request | Description
692
702
  - [UghuuuGamend.AdminUpsertKv200ResponseData](docs/AdminUpsertKv200ResponseData.md)
693
703
  - [UghuuuGamend.AdminUpsertKvRequest](docs/AdminUpsertKvRequest.md)
694
704
  - [UghuuuGamend.AuthProvidersResponse](docs/AuthProvidersResponse.md)
695
- - [UghuuuGamend.AvatarUpdate](docs/AvatarUpdate.md)
696
705
  - [UghuuuGamend.BlockedFriendship](docs/BlockedFriendship.md)
697
706
  - [UghuuuGamend.BlockedFriendshipPage](docs/BlockedFriendshipPage.md)
698
707
  - [UghuuuGamend.CallHook200Response](docs/CallHook200Response.md)
699
708
  - [UghuuuGamend.CallHookRequest](docs/CallHookRequest.md)
700
709
  - [UghuuuGamend.CancelPartyInviteRequest](docs/CancelPartyInviteRequest.md)
701
- - [UghuuuGamend.ChatUnreadCount200Response](docs/ChatUnreadCount200Response.md)
702
- - [UghuuuGamend.ChatUnreadCount200ResponseData](docs/ChatUnreadCount200ResponseData.md)
710
+ - [UghuuuGamend.ChatMessage](docs/ChatMessage.md)
711
+ - [UghuuuGamend.ChatMessagePage](docs/ChatMessagePage.md)
712
+ - [UghuuuGamend.ChatMessageResponse](docs/ChatMessageResponse.md)
713
+ - [UghuuuGamend.ChatMuteRecord](docs/ChatMuteRecord.md)
714
+ - [UghuuuGamend.ChatMuteRecordPage](docs/ChatMuteRecordPage.md)
715
+ - [UghuuuGamend.ChatMuteRecordResponse](docs/ChatMuteRecordResponse.md)
716
+ - [UghuuuGamend.ChatReadCursor](docs/ChatReadCursor.md)
717
+ - [UghuuuGamend.ChatReadCursorResponse](docs/ChatReadCursorResponse.md)
718
+ - [UghuuuGamend.ChatUnread](docs/ChatUnread.md)
719
+ - [UghuuuGamend.ChatUnreadResponse](docs/ChatUnreadResponse.md)
703
720
  - [UghuuuGamend.ClaimQuest200Response](docs/ClaimQuest200Response.md)
704
721
  - [UghuuuGamend.ClaimQuest200ResponseData](docs/ClaimQuest200ResponseData.md)
705
722
  - [UghuuuGamend.ClientLogBatch](docs/ClientLogBatch.md)
@@ -709,15 +726,16 @@ Class | Method | HTTP request | Description
709
726
  - [UghuuuGamend.ClientLogSession](docs/ClientLogSession.md)
710
727
  - [UghuuuGamend.CreateCurrentUserAvatarUploadUrlRequest](docs/CreateCurrentUserAvatarUploadUrlRequest.md)
711
728
  - [UghuuuGamend.CreateFriendRequestRequest](docs/CreateFriendRequestRequest.md)
729
+ - [UghuuuGamend.CreateGroupIconUploadUrlRequest](docs/CreateGroupIconUploadUrlRequest.md)
712
730
  - [UghuuuGamend.CreateGroupRequest](docs/CreateGroupRequest.md)
713
731
  - [UghuuuGamend.CreateLobbyRequest](docs/CreateLobbyRequest.md)
714
732
  - [UghuuuGamend.CreatePartyRequest](docs/CreatePartyRequest.md)
715
733
  - [UghuuuGamend.CurrentUser](docs/CurrentUser.md)
734
+ - [UghuuuGamend.CurrentUserResponse](docs/CurrentUserResponse.md)
716
735
  - [UghuuuGamend.DeclinePartyInviteRequest](docs/DeclinePartyInviteRequest.md)
717
- - [UghuuuGamend.DeleteNotifications200Response](docs/DeleteNotifications200Response.md)
718
- - [UghuuuGamend.DeleteNotifications200ResponseData](docs/DeleteNotifications200ResponseData.md)
719
736
  - [UghuuuGamend.DeleteNotificationsRequest](docs/DeleteNotificationsRequest.md)
720
- - [UghuuuGamend.DeletePushToken200Response](docs/DeletePushToken200Response.md)
737
+ - [UghuuuGamend.DeletedCount](docs/DeletedCount.md)
738
+ - [UghuuuGamend.DeletedCountResponse](docs/DeletedCountResponse.md)
721
739
  - [UghuuuGamend.DemoteGroupMemberRequest](docs/DemoteGroupMemberRequest.md)
722
740
  - [UghuuuGamend.DeviceLoginRequest](docs/DeviceLoginRequest.md)
723
741
  - [UghuuuGamend.ErrorResponse](docs/ErrorResponse.md)
@@ -726,47 +744,47 @@ Class | Method | HTTP request | Description
726
744
  - [UghuuuGamend.FriendRequest](docs/FriendRequest.md)
727
745
  - [UghuuuGamend.FriendRequestLists](docs/FriendRequestLists.md)
728
746
  - [UghuuuGamend.FriendRequestMeta](docs/FriendRequestMeta.md)
747
+ - [UghuuuGamend.FriendRequestResponse](docs/FriendRequestResponse.md)
729
748
  - [UghuuuGamend.FriendRequestsResponse](docs/FriendRequestsResponse.md)
730
749
  - [UghuuuGamend.GetCurrentUserInventory200Response](docs/GetCurrentUserInventory200Response.md)
731
750
  - [UghuuuGamend.GetKv200Response](docs/GetKv200Response.md)
732
751
  - [UghuuuGamend.GetMyReadyCheck200Response](docs/GetMyReadyCheck200Response.md)
733
752
  - [UghuuuGamend.GetMyReadyCheck200ResponseLobby](docs/GetMyReadyCheck200ResponseLobby.md)
734
753
  - [UghuuuGamend.GetMyReadyCheck200ResponseParty](docs/GetMyReadyCheck200ResponseParty.md)
735
- - [UghuuuGamend.GetMyRecord200Response](docs/GetMyRecord200Response.md)
736
- - [UghuuuGamend.GetMyRecord200ResponseData](docs/GetMyRecord200ResponseData.md)
737
754
  - [UghuuuGamend.GetServerTime200Response](docs/GetServerTime200Response.md)
738
755
  - [UghuuuGamend.GetStats200Response](docs/GetStats200Response.md)
739
756
  - [UghuuuGamend.GetStats200ResponseData](docs/GetStats200ResponseData.md)
740
757
  - [UghuuuGamend.Group](docs/Group.md)
741
758
  - [UghuuuGamend.GroupInvite](docs/GroupInvite.md)
759
+ - [UghuuuGamend.GroupInviteOutcome](docs/GroupInviteOutcome.md)
760
+ - [UghuuuGamend.GroupInviteOutcomeResponse](docs/GroupInviteOutcomeResponse.md)
742
761
  - [UghuuuGamend.GroupInvitePage](docs/GroupInvitePage.md)
743
762
  - [UghuuuGamend.GroupJoinRequest](docs/GroupJoinRequest.md)
744
763
  - [UghuuuGamend.GroupJoinRequestPage](docs/GroupJoinRequestPage.md)
764
+ - [UghuuuGamend.GroupJoinRequestResponse](docs/GroupJoinRequestResponse.md)
745
765
  - [UghuuuGamend.GroupMember](docs/GroupMember.md)
746
766
  - [UghuuuGamend.GroupMemberPage](docs/GroupMemberPage.md)
767
+ - [UghuuuGamend.GroupMemberResponse](docs/GroupMemberResponse.md)
747
768
  - [UghuuuGamend.GroupPage](docs/GroupPage.md)
769
+ - [UghuuuGamend.GroupResponse](docs/GroupResponse.md)
748
770
  - [UghuuuGamend.HealthResponse](docs/HealthResponse.md)
749
771
  - [UghuuuGamend.InviteToGroupRequest](docs/InviteToGroupRequest.md)
750
772
  - [UghuuuGamend.InviteToPartyRequest](docs/InviteToPartyRequest.md)
773
+ - [UghuuuGamend.JoinLobbyRequest](docs/JoinLobbyRequest.md)
751
774
  - [UghuuuGamend.KickGroupMemberRequest](docs/KickGroupMemberRequest.md)
752
775
  - [UghuuuGamend.KickPartyMemberRequest](docs/KickPartyMemberRequest.md)
776
+ - [UghuuuGamend.KickUserRequest](docs/KickUserRequest.md)
777
+ - [UghuuuGamend.Leaderboard](docs/Leaderboard.md)
778
+ - [UghuuuGamend.LeaderboardPage](docs/LeaderboardPage.md)
779
+ - [UghuuuGamend.LeaderboardRecord](docs/LeaderboardRecord.md)
780
+ - [UghuuuGamend.LeaderboardRecordPage](docs/LeaderboardRecordPage.md)
781
+ - [UghuuuGamend.LeaderboardRecordResponse](docs/LeaderboardRecordResponse.md)
782
+ - [UghuuuGamend.LeaderboardResponse](docs/LeaderboardResponse.md)
783
+ - [UghuuuGamend.LeaderboardsBySlugResponse](docs/LeaderboardsBySlugResponse.md)
753
784
  - [UghuuuGamend.LinkDeviceRequest](docs/LinkDeviceRequest.md)
754
785
  - [UghuuuGamend.LinkedProviders](docs/LinkedProviders.md)
755
- - [UghuuuGamend.ListChatMessages200Response](docs/ListChatMessages200Response.md)
756
- - [UghuuuGamend.ListChatMessages200ResponseDataInner](docs/ListChatMessages200ResponseDataInner.md)
757
786
  - [UghuuuGamend.ListCurrentUserLedger200Response](docs/ListCurrentUserLedger200Response.md)
758
787
  - [UghuuuGamend.ListCurrentUserLedger200ResponseDataInner](docs/ListCurrentUserLedger200ResponseDataInner.md)
759
- - [UghuuuGamend.ListGroupMutes200Response](docs/ListGroupMutes200Response.md)
760
- - [UghuuuGamend.ListGroupMutes200ResponseDataInner](docs/ListGroupMutes200ResponseDataInner.md)
761
- - [UghuuuGamend.ListGroupMutes200ResponseMeta](docs/ListGroupMutes200ResponseMeta.md)
762
- - [UghuuuGamend.ListLeaderboardRecords200Response](docs/ListLeaderboardRecords200Response.md)
763
- - [UghuuuGamend.ListLeaderboards200Response](docs/ListLeaderboards200Response.md)
764
- - [UghuuuGamend.ListNotifications200Response](docs/ListNotifications200Response.md)
765
- - [UghuuuGamend.ListNotifications200ResponseDataInner](docs/ListNotifications200ResponseDataInner.md)
766
- - [UghuuuGamend.ListPushTokens200Response](docs/ListPushTokens200Response.md)
767
- - [UghuuuGamend.ListRecordsAroundUser200Response](docs/ListRecordsAroundUser200Response.md)
768
- - [UghuuuGamend.ListTournaments200Response](docs/ListTournaments200Response.md)
769
- - [UghuuuGamend.ListTournaments200ResponseDataInner](docs/ListTournaments200ResponseDataInner.md)
770
788
  - [UghuuuGamend.Lobby](docs/Lobby.md)
771
789
  - [UghuuuGamend.LobbyPage](docs/LobbyPage.md)
772
790
  - [UghuuuGamend.LobbyResponse](docs/LobbyResponse.md)
@@ -784,22 +802,33 @@ Class | Method | HTTP request | Description
784
802
  - [UghuuuGamend.MatchmakingStats200ResponseData](docs/MatchmakingStats200ResponseData.md)
785
803
  - [UghuuuGamend.MatchmakingStats200ResponseDataQueuesInner](docs/MatchmakingStats200ResponseDataQueuesInner.md)
786
804
  - [UghuuuGamend.MuteGroupMemberRequest](docs/MuteGroupMemberRequest.md)
805
+ - [UghuuuGamend.MuteLobbyMemberRequest](docs/MuteLobbyMemberRequest.md)
806
+ - [UghuuuGamend.MutePartyMemberRequest](docs/MutePartyMemberRequest.md)
807
+ - [UghuuuGamend.Notification](docs/Notification.md)
808
+ - [UghuuuGamend.NotificationPage](docs/NotificationPage.md)
809
+ - [UghuuuGamend.NotificationResponse](docs/NotificationResponse.md)
787
810
  - [UghuuuGamend.OAuthAuthorization](docs/OAuthAuthorization.md)
811
+ - [UghuuuGamend.OAuthAuthorizationResponse](docs/OAuthAuthorizationResponse.md)
788
812
  - [UghuuuGamend.OAuthResult](docs/OAuthResult.md)
789
813
  - [UghuuuGamend.OAuthResultResponse](docs/OAuthResultResponse.md)
790
814
  - [UghuuuGamend.OAuthSessionData](docs/OAuthSessionData.md)
791
815
  - [UghuuuGamend.OAuthSessionDataDetails](docs/OAuthSessionDataDetails.md)
792
816
  - [UghuuuGamend.OAuthSessionStatus](docs/OAuthSessionStatus.md)
817
+ - [UghuuuGamend.OAuthSessionStatusResponse](docs/OAuthSessionStatusResponse.md)
793
818
  - [UghuuuGamend.OauthApiCallbackRequest](docs/OauthApiCallbackRequest.md)
794
819
  - [UghuuuGamend.OauthCallbackApiAppleIosRequest](docs/OauthCallbackApiAppleIosRequest.md)
795
820
  - [UghuuuGamend.OauthGoogleIdTokenRequest](docs/OauthGoogleIdTokenRequest.md)
821
+ - [UghuuuGamend.OkResponse](docs/OkResponse.md)
796
822
  - [UghuuuGamend.OpenLobbyReadyCheck201Response](docs/OpenLobbyReadyCheck201Response.md)
797
823
  - [UghuuuGamend.OpenLobbyReadyCheckRequest](docs/OpenLobbyReadyCheckRequest.md)
824
+ - [UghuuuGamend.OpenPartyReadyCheckRequest](docs/OpenPartyReadyCheckRequest.md)
798
825
  - [UghuuuGamend.PageMeta](docs/PageMeta.md)
799
826
  - [UghuuuGamend.Party](docs/Party.md)
800
827
  - [UghuuuGamend.PartyCreateLobbyRequest](docs/PartyCreateLobbyRequest.md)
801
828
  - [UghuuuGamend.PartyInvite](docs/PartyInvite.md)
829
+ - [UghuuuGamend.PartyInvitePage](docs/PartyInvitePage.md)
802
830
  - [UghuuuGamend.PartyJoinLobbyRequest](docs/PartyJoinLobbyRequest.md)
831
+ - [UghuuuGamend.PartyResponse](docs/PartyResponse.md)
803
832
  - [UghuuuGamend.PartyStats](docs/PartyStats.md)
804
833
  - [UghuuuGamend.PartyStatsResponse](docs/PartyStatsResponse.md)
805
834
  - [UghuuuGamend.PaymentsSteamCheckoutRequest](docs/PaymentsSteamCheckoutRequest.md)
@@ -807,30 +836,46 @@ Class | Method | HTTP request | Description
807
836
  - [UghuuuGamend.PaymentsStripeCheckoutRequest](docs/PaymentsStripeCheckoutRequest.md)
808
837
  - [UghuuuGamend.PlayerStats](docs/PlayerStats.md)
809
838
  - [UghuuuGamend.PlayerStatsResponse](docs/PlayerStatsResponse.md)
810
- - [UghuuuGamend.ProfileUpdate](docs/ProfileUpdate.md)
811
839
  - [UghuuuGamend.PromoteGroupMemberRequest](docs/PromoteGroupMemberRequest.md)
812
840
  - [UghuuuGamend.PublicUser](docs/PublicUser.md)
813
841
  - [UghuuuGamend.PublicUserPage](docs/PublicUserPage.md)
842
+ - [UghuuuGamend.PublicUserResponse](docs/PublicUserResponse.md)
843
+ - [UghuuuGamend.PushToken](docs/PushToken.md)
844
+ - [UghuuuGamend.PushTokenPage](docs/PushTokenPage.md)
845
+ - [UghuuuGamend.PushTokenResponse](docs/PushTokenResponse.md)
814
846
  - [UghuuuGamend.QuestStats200Response](docs/QuestStats200Response.md)
815
847
  - [UghuuuGamend.QuestStats200ResponseData](docs/QuestStats200ResponseData.md)
816
848
  - [UghuuuGamend.QuickJoinRequest](docs/QuickJoinRequest.md)
817
849
  - [UghuuuGamend.RefreshTokenRequest](docs/RefreshTokenRequest.md)
818
850
  - [UghuuuGamend.RegisterPushTokenRequest](docs/RegisterPushTokenRequest.md)
819
851
  - [UghuuuGamend.ReportChatMessageRequest](docs/ReportChatMessageRequest.md)
820
- - [UghuuuGamend.ResolveLeaderboardSlugs200Response](docs/ResolveLeaderboardSlugs200Response.md)
821
- - [UghuuuGamend.ResolveLeaderboardSlugs200ResponseDataValue](docs/ResolveLeaderboardSlugs200ResponseDataValue.md)
822
852
  - [UghuuuGamend.ResolveLeaderboardSlugsRequest](docs/ResolveLeaderboardSlugsRequest.md)
823
853
  - [UghuuuGamend.RespondReadyCheckRequest](docs/RespondReadyCheckRequest.md)
824
854
  - [UghuuuGamend.SendChatMessageRequest](docs/SendChatMessageRequest.md)
825
855
  - [UghuuuGamend.SendNotificationRequest](docs/SendNotificationRequest.md)
826
856
  - [UghuuuGamend.Session](docs/Session.md)
827
857
  - [UghuuuGamend.SessionResponse](docs/SessionResponse.md)
858
+ - [UghuuuGamend.SetCurrentUserAvatarRequest](docs/SetCurrentUserAvatarRequest.md)
859
+ - [UghuuuGamend.SetGroupIconRequest](docs/SetGroupIconRequest.md)
828
860
  - [UghuuuGamend.SetLobbyStateRequest](docs/SetLobbyStateRequest.md)
829
861
  - [UghuuuGamend.SignalingStats200Response](docs/SignalingStats200Response.md)
830
862
  - [UghuuuGamend.SignalingStats200ResponseData](docs/SignalingStats200ResponseData.md)
831
- - [UghuuuGamend.StatusResponse](docs/StatusResponse.md)
832
- - [UghuuuGamend.TournamentMyMatch200Response](docs/TournamentMyMatch200Response.md)
863
+ - [UghuuuGamend.Tournament](docs/Tournament.md)
864
+ - [UghuuuGamend.TournamentBracket](docs/TournamentBracket.md)
865
+ - [UghuuuGamend.TournamentBracketPage](docs/TournamentBracketPage.md)
866
+ - [UghuuuGamend.TournamentEntry](docs/TournamentEntry.md)
867
+ - [UghuuuGamend.TournamentEntryPage](docs/TournamentEntryPage.md)
868
+ - [UghuuuGamend.TournamentEntryResponse](docs/TournamentEntryResponse.md)
869
+ - [UghuuuGamend.TournamentMatch](docs/TournamentMatch.md)
870
+ - [UghuuuGamend.TournamentMatchResponse](docs/TournamentMatchResponse.md)
871
+ - [UghuuuGamend.TournamentPage](docs/TournamentPage.md)
872
+ - [UghuuuGamend.TournamentPlacement](docs/TournamentPlacement.md)
873
+ - [UghuuuGamend.TournamentResponse](docs/TournamentResponse.md)
874
+ - [UghuuuGamend.TournamentStandings](docs/TournamentStandings.md)
875
+ - [UghuuuGamend.TournamentStandingsResponse](docs/TournamentStandingsResponse.md)
876
+ - [UghuuuGamend.UnmuteGroupMemberRequest](docs/UnmuteGroupMemberRequest.md)
833
877
  - [UghuuuGamend.UnmuteLobbyMemberRequest](docs/UnmuteLobbyMemberRequest.md)
878
+ - [UghuuuGamend.UnmutePartyMemberRequest](docs/UnmutePartyMemberRequest.md)
834
879
  - [UghuuuGamend.UpdateChatMessageRequest](docs/UpdateChatMessageRequest.md)
835
880
  - [UghuuuGamend.UpdateCurrentUserDisplayNameRequest](docs/UpdateCurrentUserDisplayNameRequest.md)
836
881
  - [UghuuuGamend.UpdateCurrentUserPasswordRequest](docs/UpdateCurrentUserPasswordRequest.md)
@@ -839,6 +884,7 @@ Class | Method | HTTP request | Description
839
884
  - [UghuuuGamend.UpdateLobbyRequest](docs/UpdateLobbyRequest.md)
840
885
  - [UghuuuGamend.UpdatePartyRequest](docs/UpdatePartyRequest.md)
841
886
  - [UghuuuGamend.UploadTicket](docs/UploadTicket.md)
887
+ - [UghuuuGamend.UploadTicketResponse](docs/UploadTicketResponse.md)
842
888
  - [UghuuuGamend.UserBrief](docs/UserBrief.md)
843
889
  - [UghuuuGamend.UserBriefPage](docs/UserBriefPage.md)
844
890
  - [UghuuuGamend.UserQuests200Response](docs/UserQuests200Response.md)
package/dist/ApiClient.js CHANGED
@@ -15,7 +15,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
15
15
  * Gamend API
16
16
  * 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
17
  *
18
- * The version of the OpenAPI document: 1.0.1239
18
+ * The version of the OpenAPI document: 1.0.1241
19
19
  *
20
20
  *
21
21
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.1239
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).
@@ -33,7 +33,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
33
33
  * Gamend API
34
34
  * 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 })) ```
35
35
  *
36
- * The version of the OpenAPI document: 1.0.1239
36
+ * The version of the OpenAPI document: 1.0.1241
37
37
  *
38
38
  *
39
39
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
8
  var _AdminConsumeItem400Response = _interopRequireDefault(require("../model/AdminConsumeItem400Response"));
9
+ var _AdminGrantCurrencyRequest = _interopRequireDefault(require("../model/AdminGrantCurrencyRequest"));
9
10
  var _AdminGrantItemRequest = _interopRequireDefault(require("../model/AdminGrantItemRequest"));
10
11
  var _AdminSpendCurrencyRequest = _interopRequireDefault(require("../model/AdminSpendCurrencyRequest"));
11
12
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
@@ -18,7 +19,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
18
19
  * Gamend API
19
20
  * API for Gamend. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, quests, leaderboards, tournaments, matchmaking, payments, server scripting, and admin portal. ## **1. Authentication** This API uses JWT (JSON Web Tokens) with access and refresh tokens: ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ``` ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token. ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights: - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported ## **3. Friends** The Friends domain offers lightweight social features: - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights: - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated ## **5. Notifications** Persistent user-to-user notifications that survive across sessions: - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect - **Push delivery**: notifications also fan out to the recipient's registered mobile devices (see Push notifications) ## **5b. Push notifications** Mobile/web push delivery to registered devices (FCM for Android/Web, APNs-direct for iOS): - **Register device tokens** via `POST /me/push_tokens` (`token`, `platform`, optional `provider`/`device_id`); re-registering a `device_id` rotates its token in place - **List/remove own devices** via `GET /me/push_tokens` and `DELETE /me/push_tokens/:id` - **Server-authoritative sending** — no public send endpoint; pushes originate from server hooks (`Gamend.Push.send_to_user/2`) or the admin API - **Per-token routing**: each token's `provider` (\"fcm\" | \"apns\") selects the delivery backend; unconfigured backends log instead of sending (dev-friendly) - **Reliability**: delivery rides the durable job queue with retries; dead tokens reported by the provider are disabled automatically ## **6. Groups** Groups provide persistent community management for players: - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"` ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads): - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel ## **8. Chat** Real-time messaging across multiple conversation types: - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation is built in**: an admin-managed word filter (`block` / `mask` / `flag`, matched on a normalized form so leetspeak and padding do not slip through) and mutes are enforced before a message is stored or broadcast; the `before_chat_message` pipeline hook stays available for rules of your own - **Report a message**: `POST /chat/messages/:id/report` with an optional `reason` — one report per player per message, capped per day; reports the filter files itself have no reporter - **Scoped mutes** mirror kick: `POST /lobbies/mute` + `/lobbies/unmute` (lobby host), `POST /groups/:id/mute` + `/groups/:id/unmute` (group admin), `POST /parties/mute` + `/parties/unmute` (party leader), each with a paginated `.../mutes` listing for the same authority. Body is `{target_user_id, expires_at?, reason?}`; omitting `expires_at` mutes permanently - **Global mutes and the blocklist are server-authoritative** — no public endpoint; admin API (`/api/v1/admin/chat`) or a plugin calling `Gamend.Chat.mute_user/4` - **Real-time moderation events**: the muted player receives `chat_muted` / `chat_unmuted` on their user channel ## **9. Leaderboards** Server-managed ranked scoreboards: - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings: - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata ## **11. Quests / Progression** One event-driven progression engine covering achievements, daily/weekly quests, time-boxed event quests, chains, and groups: - **Kinds**: `achievement` (permanent one-shot — the replacement for the old achievements system), `daily`/`weekly` (reset per UTC period), `event` (starts_at/ends_at window), `chain` (requires a prerequisite quest) - **Objectives**: each quest lists objectives `{event, target, params}`; server-side `report_event` advances every matching active quest — there is **no public endpoint to advance progress** (server-authoritative) - **Rewards**: currencies (Economy) and items (Inventory), paid **exactly once** per period via idempotent grants; `auto_claim` quests pay on completion, others via `POST /me/quests/:key/claim` - **My quests**: `GET /me/quests` returns active quests, per-period progress, and a claimable flag; hidden quests appear once completed - **Groups**: quests sharing a `group_key` collapse to one entry carrying `group_size`; `?group=<key>` lists that group's members in full - **Catalog**: `GET /quests` and per-user completions `GET /quests/user/:user_id` (gated by `GAMEND_FEATURES_LIST_QUESTS`) - **Admin management**: definitions CRUD plus per-user grant/reset/force-claim under `/api/v1/admin/quests` ## **12. Tournaments** Single-elimination bracket tournaments, server-structured and game-judged: - **Registration window → seeded draw → timed rounds → champions**; recurring tournaments (cron) create one occurrence per cycle sharing a slug; a nil starts_at keeps registration open until an admin draws manually - **Join/leave** as an entry leader (`POST`/`DELETE /tournaments/:id/join`); team composition is game policy - **Browse**: list/filter tournaments, standings, full bracket view, and the caller's current match (`GET /tournaments/:id/my_match`) - **Match verdicts are server-side** (game hooks) — no public resolve endpoint; clients get `tournament_match_ready` / `tournament_match_resolved` / `tournament_updated` / `tournament_finished` on the user channel - **Admin management** over HTTP: create/update/delete, cancel, draw now, finish, and force match verdicts under `/api/v1/admin/tournaments` ## **13. Matchmaking** Ticket-based queueing that turns waiting players into hidden, locked lobbies: - **Join over HTTP** (`POST /matchmaking/tickets` with a `match_params` string map); only tickets with identical params match together — encode mode/map/skill band as parameter values - **A match forms** when a group reaches `max_players`, or has at least `min_players` and the oldest ticket outwaited the timeout; the server creates a hidden lobby, seats everyone and locks it - **The result is a push, not a poll**: matched players receive `match_found` (`lobby_id`, `match_params`) on their user channel; disconnecting cancels your tickets - **Inspect**: `GET /matchmaking/tickets/me` for your ticket, `GET /matchmaking/stats` for queue depths - **Admin management** over HTTP: list/filter tickets, force-cancel, and stats under `/api/v1/admin/matchmaking` ## **14. Ready checks** One primitive for \"everyone must answer before this proceeds\", with one client-facing surface: - **A player holds at most one check per lane** — the match lane (lobby ready-up or matchmaking accept) and the party lane (the party's standing board) — so answering needs no id: `GET /me/ready_check` returns `{\"lobby\": …, \"party\": …}` (each null when none) and `POST /me/ready_check` with `{\"ready\": true|false, \"scope\": \"lobby\"|\"party\"}` answers one (scope defaults to `lobby`) - **Two kinds.** `ready` (lobby/party board) is a toggle — a \"no\" just leaves the check open, and it lists every participant. `accept` (match confirmation) is final — one decline fails it for everyone — and returns counts plus your own state, so a pending match does not reveal who you were paired with - **Hosts open one** with `POST /lobbies/ready_check` (host-managed lobbies only; hostless matchmaking lobbies belong to the server), **party leaders** with `POST /parties/ready_check`; either call is a **reset** — it quietly replaces an already-open board with a fresh one over the current members, so the same endpoint serves \"ready check!\", \"force ready\" (with `timeout_ms`) and \"start over\". Call it off with `DELETE /lobbies/ready_check` / `DELETE /parties/ready_check`. The opener is pre-marked ready — clicking the button is their answer - **Failure does nothing on its own**: a declined or timed-out check kicks nobody, starts nothing, and moves no lobby state. It reports who did not answer, and the game (or the host, with the kick they already have) decides - **Live**: `ready_check_started` / `ready_check_updated` / `ready_check_passed` / `ready_check_failed` on the lobby channel, the party channel for a party board, or the user channel for an accept check - **Admin management** over HTTP: list/filter checks, force-cancel, and 24h outcome stats under `/api/v1/admin/ready_checks` ## **15. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates. ### **15.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ``` ### **15.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, quest progress/completions/claims, party/group invites, tournament events, chat mutes (`chat_muted` / `chat_unmuted`), KV subscriptions - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat ### **15.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/gamend' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` `phoenix` ships as a dependency of the package, so no extra install is needed. ## **16. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients). ### **16.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency ### **16.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **16.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/gamend' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, { onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ```
20
21
  *
21
- * The version of the OpenAPI document: 1.0.1239
22
+ * The version of the OpenAPI document: 1.0.1241
22
23
  *
23
24
  *
24
25
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -78,14 +79,14 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
78
79
  /**
79
80
  * Grant currency to a user (admin)
80
81
  * @param {Object} opts Optional parameters
81
- * @param {module:model/AdminSpendCurrencyRequest} [adminSpendCurrencyRequest] Wallet change
82
+ * @param {module:model/AdminGrantCurrencyRequest} [adminGrantCurrencyRequest] Wallet change
82
83
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
83
84
  */
84
85
  }, {
85
86
  key: "adminGrantCurrencyWithHttpInfo",
86
87
  value: function adminGrantCurrencyWithHttpInfo(opts) {
87
88
  opts = opts || {};
88
- var postBody = opts['adminSpendCurrencyRequest'];
89
+ var postBody = opts['adminGrantCurrencyRequest'];
89
90
  var pathParams = {};
90
91
  var queryParams = {};
91
92
  var headerParams = {};
@@ -100,7 +101,7 @@ var AdminEconomyApi = exports["default"] = /*#__PURE__*/function () {
100
101
  /**
101
102
  * Grant currency to a user (admin)
102
103
  * @param {Object} opts Optional parameters
103
- * @param {module:model/AdminSpendCurrencyRequest} opts.adminSpendCurrencyRequest Wallet change
104
+ * @param {module:model/AdminGrantCurrencyRequest} opts.adminGrantCurrencyRequest Wallet change
104
105
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
105
106
  */
106
107
  }, {
@@ -19,7 +19,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
19
19
  * Gamend API
20
20
  * API for Gamend. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, quests, leaderboards, tournaments, matchmaking, payments, server scripting, and admin portal. ## **1. Authentication** This API uses JWT (JSON Web Tokens) with access and refresh tokens: ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ``` ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token. ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights: - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported ## **3. Friends** The Friends domain offers lightweight social features: - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights: - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated ## **5. Notifications** Persistent user-to-user notifications that survive across sessions: - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect - **Push delivery**: notifications also fan out to the recipient's registered mobile devices (see Push notifications) ## **5b. Push notifications** Mobile/web push delivery to registered devices (FCM for Android/Web, APNs-direct for iOS): - **Register device tokens** via `POST /me/push_tokens` (`token`, `platform`, optional `provider`/`device_id`); re-registering a `device_id` rotates its token in place - **List/remove own devices** via `GET /me/push_tokens` and `DELETE /me/push_tokens/:id` - **Server-authoritative sending** — no public send endpoint; pushes originate from server hooks (`Gamend.Push.send_to_user/2`) or the admin API - **Per-token routing**: each token's `provider` (\"fcm\" | \"apns\") selects the delivery backend; unconfigured backends log instead of sending (dev-friendly) - **Reliability**: delivery rides the durable job queue with retries; dead tokens reported by the provider are disabled automatically ## **6. Groups** Groups provide persistent community management for players: - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"` ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads): - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel ## **8. Chat** Real-time messaging across multiple conversation types: - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation is built in**: an admin-managed word filter (`block` / `mask` / `flag`, matched on a normalized form so leetspeak and padding do not slip through) and mutes are enforced before a message is stored or broadcast; the `before_chat_message` pipeline hook stays available for rules of your own - **Report a message**: `POST /chat/messages/:id/report` with an optional `reason` — one report per player per message, capped per day; reports the filter files itself have no reporter - **Scoped mutes** mirror kick: `POST /lobbies/mute` + `/lobbies/unmute` (lobby host), `POST /groups/:id/mute` + `/groups/:id/unmute` (group admin), `POST /parties/mute` + `/parties/unmute` (party leader), each with a paginated `.../mutes` listing for the same authority. Body is `{target_user_id, expires_at?, reason?}`; omitting `expires_at` mutes permanently - **Global mutes and the blocklist are server-authoritative** — no public endpoint; admin API (`/api/v1/admin/chat`) or a plugin calling `Gamend.Chat.mute_user/4` - **Real-time moderation events**: the muted player receives `chat_muted` / `chat_unmuted` on their user channel ## **9. Leaderboards** Server-managed ranked scoreboards: - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings: - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata ## **11. Quests / Progression** One event-driven progression engine covering achievements, daily/weekly quests, time-boxed event quests, chains, and groups: - **Kinds**: `achievement` (permanent one-shot — the replacement for the old achievements system), `daily`/`weekly` (reset per UTC period), `event` (starts_at/ends_at window), `chain` (requires a prerequisite quest) - **Objectives**: each quest lists objectives `{event, target, params}`; server-side `report_event` advances every matching active quest — there is **no public endpoint to advance progress** (server-authoritative) - **Rewards**: currencies (Economy) and items (Inventory), paid **exactly once** per period via idempotent grants; `auto_claim` quests pay on completion, others via `POST /me/quests/:key/claim` - **My quests**: `GET /me/quests` returns active quests, per-period progress, and a claimable flag; hidden quests appear once completed - **Groups**: quests sharing a `group_key` collapse to one entry carrying `group_size`; `?group=<key>` lists that group's members in full - **Catalog**: `GET /quests` and per-user completions `GET /quests/user/:user_id` (gated by `GAMEND_FEATURES_LIST_QUESTS`) - **Admin management**: definitions CRUD plus per-user grant/reset/force-claim under `/api/v1/admin/quests` ## **12. Tournaments** Single-elimination bracket tournaments, server-structured and game-judged: - **Registration window → seeded draw → timed rounds → champions**; recurring tournaments (cron) create one occurrence per cycle sharing a slug; a nil starts_at keeps registration open until an admin draws manually - **Join/leave** as an entry leader (`POST`/`DELETE /tournaments/:id/join`); team composition is game policy - **Browse**: list/filter tournaments, standings, full bracket view, and the caller's current match (`GET /tournaments/:id/my_match`) - **Match verdicts are server-side** (game hooks) — no public resolve endpoint; clients get `tournament_match_ready` / `tournament_match_resolved` / `tournament_updated` / `tournament_finished` on the user channel - **Admin management** over HTTP: create/update/delete, cancel, draw now, finish, and force match verdicts under `/api/v1/admin/tournaments` ## **13. Matchmaking** Ticket-based queueing that turns waiting players into hidden, locked lobbies: - **Join over HTTP** (`POST /matchmaking/tickets` with a `match_params` string map); only tickets with identical params match together — encode mode/map/skill band as parameter values - **A match forms** when a group reaches `max_players`, or has at least `min_players` and the oldest ticket outwaited the timeout; the server creates a hidden lobby, seats everyone and locks it - **The result is a push, not a poll**: matched players receive `match_found` (`lobby_id`, `match_params`) on their user channel; disconnecting cancels your tickets - **Inspect**: `GET /matchmaking/tickets/me` for your ticket, `GET /matchmaking/stats` for queue depths - **Admin management** over HTTP: list/filter tickets, force-cancel, and stats under `/api/v1/admin/matchmaking` ## **14. Ready checks** One primitive for \"everyone must answer before this proceeds\", with one client-facing surface: - **A player holds at most one check per lane** — the match lane (lobby ready-up or matchmaking accept) and the party lane (the party's standing board) — so answering needs no id: `GET /me/ready_check` returns `{\"lobby\": …, \"party\": …}` (each null when none) and `POST /me/ready_check` with `{\"ready\": true|false, \"scope\": \"lobby\"|\"party\"}` answers one (scope defaults to `lobby`) - **Two kinds.** `ready` (lobby/party board) is a toggle — a \"no\" just leaves the check open, and it lists every participant. `accept` (match confirmation) is final — one decline fails it for everyone — and returns counts plus your own state, so a pending match does not reveal who you were paired with - **Hosts open one** with `POST /lobbies/ready_check` (host-managed lobbies only; hostless matchmaking lobbies belong to the server), **party leaders** with `POST /parties/ready_check`; either call is a **reset** — it quietly replaces an already-open board with a fresh one over the current members, so the same endpoint serves \"ready check!\", \"force ready\" (with `timeout_ms`) and \"start over\". Call it off with `DELETE /lobbies/ready_check` / `DELETE /parties/ready_check`. The opener is pre-marked ready — clicking the button is their answer - **Failure does nothing on its own**: a declined or timed-out check kicks nobody, starts nothing, and moves no lobby state. It reports who did not answer, and the game (or the host, with the kick they already have) decides - **Live**: `ready_check_started` / `ready_check_updated` / `ready_check_passed` / `ready_check_failed` on the lobby channel, the party channel for a party board, or the user channel for an accept check - **Admin management** over HTTP: list/filter checks, force-cancel, and 24h outcome stats under `/api/v1/admin/ready_checks` ## **15. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates. ### **15.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ``` ### **15.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, quest progress/completions/claims, party/group invites, tournament events, chat mutes (`chat_muted` / `chat_unmuted`), KV subscriptions - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat ### **15.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/gamend' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` `phoenix` ships as a dependency of the package, so no extra install is needed. ## **16. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients). ### **16.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency ### **16.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **16.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/gamend' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, { onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ```
21
21
  *
22
- * The version of the OpenAPI document: 1.0.1239
22
+ * The version of the OpenAPI document: 1.0.1241
23
23
  *
24
24
  *
25
25
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).