@ughuuu/gamend 1.0.1240 → 1.0.1250

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (451) hide show
  1. package/README.md +193 -123
  2. package/dist/ApiClient.js +1 -1
  3. package/dist/api/AdminAnalyticsApi.js +22 -21
  4. package/dist/api/AdminChatApi.js +97 -63
  5. package/dist/api/AdminEconomyApi.js +28 -23
  6. package/dist/api/AdminGroupsApi.js +14 -13
  7. package/dist/api/AdminKVApi.js +23 -22
  8. package/dist/api/AdminLeaderboardsApi.js +36 -34
  9. package/dist/api/AdminLobbiesApi.js +14 -13
  10. package/dist/api/AdminMatchmakingApi.js +14 -14
  11. package/dist/api/AdminNotificationsApi.js +14 -13
  12. package/dist/api/AdminPushApi.js +13 -14
  13. package/dist/api/AdminQuestsApi.js +43 -39
  14. package/dist/api/AdminReadyChecksApi.js +14 -13
  15. package/dist/api/AdminRetentionApi.js +9 -9
  16. package/dist/api/AdminSessionsApi.js +13 -12
  17. package/dist/api/AdminStorageApi.js +53 -12
  18. package/dist/api/AdminTournamentsApi.js +36 -33
  19. package/dist/api/AdminUsersApi.js +10 -9
  20. package/dist/api/AuthenticationApi.js +305 -57
  21. package/dist/api/ChatApi.js +25 -25
  22. package/dist/api/ClientLogsApi.js +9 -9
  23. package/dist/api/EconomyApi.js +14 -13
  24. package/dist/api/FriendsApi.js +27 -25
  25. package/dist/api/GroupsApi.js +58 -57
  26. package/dist/api/HealthApi.js +1 -1
  27. package/dist/api/HooksApi.js +28 -13
  28. package/dist/api/KVApi.js +6 -6
  29. package/dist/api/LeaderboardsApi.js +31 -32
  30. package/dist/api/LobbiesApi.js +26 -26
  31. package/dist/api/MatchmakingApi.js +21 -22
  32. package/dist/api/NotificationsApi.js +5 -5
  33. package/dist/api/PartiesApi.js +75 -54
  34. package/dist/api/PaymentsApi.js +57 -34
  35. package/dist/api/PushApi.js +8 -8
  36. package/dist/api/QuestsApi.js +22 -21
  37. package/dist/api/ReadyChecksApi.js +25 -24
  38. package/dist/api/SignalingApi.js +5 -5
  39. package/dist/api/StatsApi.js +5 -5
  40. package/dist/api/TimeApi.js +5 -5
  41. package/dist/api/TournamentsApi.js +58 -45
  42. package/dist/api/UsersApi.js +44 -39
  43. package/dist/index.js +1038 -604
  44. package/dist/model/AcceptPartyInviteRequest.js +1 -1
  45. package/dist/model/ActivityStats.js +159 -0
  46. package/dist/model/{AdminListChatMutes200ResponseDataInner.js → AdminChatMute.js} +77 -32
  47. package/dist/model/AdminChatMutePage.js +147 -0
  48. package/dist/model/AdminChatMuteResponse.js +115 -0
  49. package/dist/model/AdminClaimQuestRequest.js +1 -1
  50. package/dist/model/AdminCreateChatFilterWordRequest.js +1 -1
  51. package/dist/model/AdminCreateChatMuteRequest.js +1 -1
  52. package/dist/model/AdminCreateKvEntryRequest.js +3 -1
  53. package/dist/model/AdminCreateLeaderboardRequest.js +1 -1
  54. package/dist/model/AdminCreateNotificationRequest.js +1 -1
  55. package/dist/model/AdminCreateQuestRequest.js +1 -1
  56. package/dist/model/AdminCreateQuestRequestObjectivesInner.js +1 -1
  57. package/dist/model/AdminCreateQuestRequestRewardsInner.js +1 -1
  58. package/dist/model/AdminCreateTournamentRequest.js +1 -1
  59. package/dist/model/AdminGrantCurrencyRequest.js +1 -1
  60. package/dist/model/AdminGrantItemRequest.js +1 -1
  61. package/dist/model/AdminGrantQuestRequest.js +1 -1
  62. package/dist/model/AdminImportChatFilterWordsRequest.js +1 -1
  63. package/dist/model/AdminInventoryItem.js +161 -0
  64. package/dist/model/AdminInventoryItemPage.js +147 -0
  65. package/dist/model/{AdminUpsertKv200ResponseData.js → AdminKvEntry.js} +67 -29
  66. package/dist/model/{AdminListLobbies200Response.js → AdminKvEntryPage.js} +57 -34
  67. package/dist/model/AdminKvEntryResponse.js +115 -0
  68. package/dist/model/AdminLeaderboardIconUploadUrlRequest.js +1 -1
  69. package/dist/model/{AdminUpdateLeaderboardRecord200ResponseData.js → AdminLeaderboardRecord.js} +71 -28
  70. package/dist/model/AdminLeaderboardRecordResponse.js +115 -0
  71. package/dist/model/AdminLedgerEntry.js +195 -0
  72. package/dist/model/AdminLedgerEntryPage.js +147 -0
  73. package/dist/model/AdminMatchmakingStats.js +161 -0
  74. package/dist/model/AdminMatchmakingStatsResponse.js +115 -0
  75. package/dist/model/{AdminListMatchmakingTickets200ResponseDataInner.js → AdminMatchmakingTicket.js} +78 -33
  76. package/dist/model/{AdminListGroups200Response.js → AdminMatchmakingTicketPage.js} +57 -34
  77. package/dist/model/AdminMatchmakingTicketResponse.js +115 -0
  78. package/dist/model/{AdminListPushTokens200ResponseDataInner.js → AdminPushToken.js} +76 -50
  79. package/dist/model/AdminPushTokenPage.js +147 -0
  80. package/dist/model/{UserQuests200ResponseDataInner.js → AdminQuest.js} +146 -106
  81. package/dist/model/AdminQuestClaim.js +147 -0
  82. package/dist/model/AdminQuestClaimResponse.js +115 -0
  83. package/dist/model/AdminQuestIconUploadUrlRequest.js +1 -1
  84. package/dist/model/{AdminListNotifications200Response.js → AdminQuestPage.js} +57 -34
  85. package/dist/model/{AdminListQuestProgress200ResponseDataInner.js → AdminQuestProgress.js} +80 -34
  86. package/dist/model/AdminQuestProgressPage.js +147 -0
  87. package/dist/model/AdminQuestProgressResponse.js +115 -0
  88. package/dist/model/AdminQuestResponse.js +115 -0
  89. package/dist/model/{OpenLobbyReadyCheck201Response.js → AdminReadyCheck.js} +115 -63
  90. package/dist/model/AdminReadyCheckPage.js +147 -0
  91. package/dist/model/AdminReadyCheckResponse.js +115 -0
  92. package/dist/model/AdminResetQuestRequest.js +1 -1
  93. package/dist/model/AdminResolveChatReportRequest.js +1 -1
  94. package/dist/model/AdminResolveTournamentMatchRequest.js +1 -1
  95. package/dist/model/AdminSendPushRequest.js +1 -1
  96. package/dist/model/{AdminListSessions200ResponseDataInner.js → AdminSession.js} +87 -25
  97. package/dist/model/AdminSessionPage.js +147 -0
  98. package/dist/model/AdminSetLeaderboardIconRequest.js +1 -1
  99. package/dist/model/AdminSetQuestIconRequest.js +1 -1
  100. package/dist/model/AdminSetTournamentIconRequest.js +1 -1
  101. package/dist/model/AdminSpendCurrencyRequest.js +1 -1
  102. package/dist/model/AdminSubmitLeaderboardScoreRequest.js +1 -1
  103. package/dist/model/AdminTestChatPhraseRequest.js +1 -1
  104. package/dist/model/{AdminDrawTournament200ResponseData.js → AdminTournament.js} +101 -42
  105. package/dist/model/AdminTournamentIconUploadUrlRequest.js +1 -1
  106. package/dist/model/AdminTournamentResponse.js +115 -0
  107. package/dist/model/AdminUpdateChatFilterWordRequest.js +1 -1
  108. package/dist/model/AdminUpdateGroupRequest.js +1 -1
  109. package/dist/model/AdminUpdateKvEntryRequest.js +3 -1
  110. package/dist/model/AdminUpdateLeaderboardRecordRequest.js +1 -1
  111. package/dist/model/AdminUpdateLeaderboardRequest.js +1 -1
  112. package/dist/model/AdminUpdateLobbyRequest.js +1 -1
  113. package/dist/model/AdminUpdateQuestRequest.js +1 -1
  114. package/dist/model/AdminUpdateTournamentRequest.js +1 -1
  115. package/dist/model/AdminUpdateUserRequest.js +1 -1
  116. package/dist/model/AdminUpsertKvRequest.js +3 -1
  117. package/dist/model/{AdminUpdateUser200ResponseData.js → AdminUser.js} +94 -31
  118. package/dist/model/AdminUserResponse.js +115 -0
  119. package/dist/model/AdminWallet.js +151 -0
  120. package/dist/model/{ListLeaderboards200Response.js → AdminWalletPage.js} +57 -34
  121. package/dist/model/{AdminGetAnalyticsCounts200Response.js → AnalyticsCounts.js} +62 -34
  122. package/dist/model/AnalyticsCountsResponse.js +115 -0
  123. package/dist/model/{AdminGetAnalyticsDaily200Response.js → AnalyticsDaily.js} +53 -31
  124. package/dist/model/AnalyticsDailyResponse.js +115 -0
  125. package/dist/model/AnalyticsDay.js +159 -0
  126. package/dist/model/{AdminGetAnalyticsEconomy200Response.js → AnalyticsEconomy.js} +66 -43
  127. package/dist/model/AnalyticsEconomyResponse.js +115 -0
  128. package/dist/model/{AdminGetAnalyticsSummary200Response.js → AnalyticsSummary.js} +81 -36
  129. package/dist/model/AnalyticsSummaryResponse.js +115 -0
  130. package/dist/model/AuthProvidersResponse.js +1 -1
  131. package/dist/model/BlockedFriendship.js +1 -1
  132. package/dist/model/BlockedFriendshipPage.js +1 -1
  133. package/dist/model/CallHookRequest.js +1 -1
  134. package/dist/model/CancelPartyInviteRequest.js +1 -1
  135. package/dist/model/CancelledCount.js +109 -0
  136. package/dist/model/CancelledCountResponse.js +115 -0
  137. package/dist/model/ChatFilterHit.js +182 -0
  138. package/dist/model/ChatFilterLanguages.js +114 -0
  139. package/dist/model/ChatFilterLanguagesResponse.js +115 -0
  140. package/dist/model/{AdminTestChatPhrase200ResponseData.js → ChatFilterTest.js} +65 -36
  141. package/dist/model/ChatFilterTestResponse.js +115 -0
  142. package/dist/model/{AdminUpdateChatFilterWord200ResponseData.js → ChatFilterWord.js} +66 -30
  143. package/dist/model/ChatFilterWordPage.js +147 -0
  144. package/dist/model/ChatFilterWordResponse.js +115 -0
  145. package/dist/model/ChatMessage.js +1 -1
  146. package/dist/model/ChatMessagePage.js +1 -1
  147. package/dist/model/{OAuthResultResponse.js → ChatMessageResponse.js} +26 -26
  148. package/dist/model/ChatMuteRecord.js +1 -1
  149. package/dist/model/ChatMuteRecordPage.js +1 -1
  150. package/dist/model/ChatMuteRecordResponse.js +1 -1
  151. package/dist/model/ChatReadCursor.js +1 -1
  152. package/dist/model/ChatReadCursorResponse.js +115 -0
  153. package/dist/model/{AdminResolveChatReport200ResponseData.js → ChatReport.js} +89 -36
  154. package/dist/model/{ListLeaderboardRecords200Response.js → ChatReportPage.js} +57 -34
  155. package/dist/model/ChatReportResponse.js +115 -0
  156. package/dist/model/ChatUnread.js +1 -1
  157. package/dist/model/ChatUnreadResponse.js +1 -1
  158. package/dist/model/ClientLogBatch.js +1 -1
  159. package/dist/model/ClientLogEntry.js +1 -1
  160. package/dist/model/ClientLogPolicy.js +1 -1
  161. package/dist/model/ClientLogPolicyResponse.js +115 -0
  162. package/dist/model/ClientLogResult.js +1 -1
  163. package/dist/model/ClientLogResultResponse.js +115 -0
  164. package/dist/model/ClientLogSession.js +1 -1
  165. package/dist/model/{AvatarUpdate.js → CounterTotal.js} +35 -36
  166. package/dist/model/CreateCurrentUserAvatarUploadUrlRequest.js +1 -1
  167. package/dist/model/CreateFriendRequestRequest.js +1 -1
  168. package/dist/model/CreateGroupIconUploadUrlRequest.js +1 -1
  169. package/dist/model/CreateGroupRequest.js +1 -1
  170. package/dist/model/CreateLobbyRequest.js +1 -1
  171. package/dist/model/CreatePartyRequest.js +1 -1
  172. package/dist/model/CurrentUser.js +1 -1
  173. package/dist/model/CurrentUserResponse.js +115 -0
  174. package/dist/model/DeclinePartyInviteRequest.js +1 -1
  175. package/dist/model/{AdminSendPush200Response.js → DeleteCurrentUserRequest.js} +24 -23
  176. package/dist/model/DeleteNotificationsRequest.js +1 -1
  177. package/dist/model/DeletedCount.js +1 -1
  178. package/dist/model/DeletedCountResponse.js +1 -1
  179. package/dist/model/DemoteGroupMemberRequest.js +1 -1
  180. package/dist/model/DeviceLoginRequest.js +1 -1
  181. package/dist/model/EconomyFlowDay.js +167 -0
  182. package/dist/model/EconomyTotal.js +167 -0
  183. package/dist/model/Entitlement.js +213 -0
  184. package/dist/model/EntitlementPage.js +147 -0
  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/Group.js +1 -1
  194. package/dist/model/GroupInvite.js +13 -14
  195. package/dist/model/GroupInviteOutcome.js +132 -0
  196. package/dist/model/GroupInviteOutcomeResponse.js +115 -0
  197. package/dist/model/GroupInvitePage.js +1 -1
  198. package/dist/model/GroupJoinRequest.js +1 -1
  199. package/dist/model/GroupJoinRequestPage.js +1 -1
  200. package/dist/model/GroupJoinRequestResponse.js +115 -0
  201. package/dist/model/GroupMember.js +1 -1
  202. package/dist/model/GroupMemberPage.js +1 -1
  203. package/dist/model/GroupMemberResponse.js +115 -0
  204. package/dist/model/GroupPage.js +1 -1
  205. package/dist/model/GroupResponse.js +115 -0
  206. package/dist/model/{StatusResponse.js → Health.js} +35 -23
  207. package/dist/model/HealthResponse.js +17 -31
  208. package/dist/model/HookCallResponse.js +110 -0
  209. package/dist/model/HookFunction.js +196 -0
  210. package/dist/model/HookFunctionPage.js +147 -0
  211. package/dist/model/HookSignature.js +154 -0
  212. package/dist/model/ImportedCount.js +109 -0
  213. package/dist/model/ImportedCountResponse.js +115 -0
  214. package/dist/model/InventoryResponse.js +112 -0
  215. package/dist/model/InviteToGroupRequest.js +1 -1
  216. package/dist/model/InviteToPartyRequest.js +1 -1
  217. package/dist/model/ItemQuantity.js +137 -0
  218. package/dist/model/ItemQuantityResponse.js +115 -0
  219. package/dist/model/JoinLobbyRequest.js +1 -1
  220. package/dist/model/KickGroupMemberRequest.js +1 -1
  221. package/dist/model/KickPartyMemberRequest.js +1 -1
  222. package/dist/model/KickUserRequest.js +1 -1
  223. package/dist/model/KvEntry.js +164 -0
  224. package/dist/model/KvEntryResponse.js +115 -0
  225. package/dist/model/{ResolveLeaderboardSlugs200ResponseDataValue.js → Leaderboard.js} +90 -45
  226. package/dist/model/LeaderboardPage.js +147 -0
  227. package/dist/model/{GetMyRecord200ResponseData.js → LeaderboardRecord.js} +66 -31
  228. package/dist/model/{UserQuests200Response.js → LeaderboardRecordPage.js} +57 -34
  229. package/dist/model/LeaderboardRecordResponse.js +115 -0
  230. package/dist/model/LeaderboardResponse.js +115 -0
  231. package/dist/model/LeaderboardsBySlugResponse.js +113 -0
  232. package/dist/model/{ListCurrentUserLedger200ResponseDataInner.js → LedgerEntry.js} +65 -26
  233. package/dist/model/LedgerEntryPage.js +147 -0
  234. package/dist/model/LinkAppleIosRequest.js +113 -0
  235. package/dist/model/LinkDeviceRequest.js +1 -1
  236. package/dist/model/LinkGoogleIdTokenRequest.js +113 -0
  237. package/dist/model/LinkProviderRequest.js +113 -0
  238. package/dist/model/LinkedProviders.js +1 -1
  239. package/dist/model/Lobby.js +1 -1
  240. package/dist/model/LobbyPage.js +1 -1
  241. package/dist/model/LobbyResponse.js +6 -49
  242. package/dist/model/LobbyStats.js +1 -1
  243. package/dist/model/LobbyStatsResponse.js +1 -1
  244. package/dist/model/LoginRequest.js +1 -1
  245. package/dist/model/MarkChatReadRequest.js +1 -1
  246. package/dist/model/MatchmakingJoinRequest.js +1 -1
  247. package/dist/model/MatchmakingQueue.js +121 -0
  248. package/dist/model/{MatchmakingStats200ResponseData.js → MatchmakingStats.js} +53 -30
  249. package/dist/model/MatchmakingStatsResponse.js +115 -0
  250. package/dist/model/{MatchmakingJoin201ResponseData.js → MatchmakingTicket.js} +75 -33
  251. package/dist/model/MatchmakingTicketResponse.js +115 -0
  252. package/dist/model/MuteGroupMemberRequest.js +1 -1
  253. package/dist/model/MuteLobbyMemberRequest.js +1 -1
  254. package/dist/model/MutePartyMemberRequest.js +1 -1
  255. package/dist/model/MyReadyChecks.js +132 -0
  256. package/dist/model/MyReadyChecksResponse.js +115 -0
  257. package/dist/model/Notification.js +1 -1
  258. package/dist/model/NotificationPage.js +1 -1
  259. package/dist/model/NotificationResponse.js +115 -0
  260. package/dist/model/OAuthAuthorization.js +1 -1
  261. package/dist/model/OAuthAuthorizationResponse.js +115 -0
  262. package/dist/model/OAuthSessionStatus.js +38 -27
  263. package/dist/model/OAuthSessionStatusResponse.js +115 -0
  264. package/dist/model/OauthApiCallbackRequest.js +29 -6
  265. package/dist/model/OauthCallbackApiAppleIosRequest.js +1 -1
  266. package/dist/model/OauthGoogleIdTokenRequest.js +1 -1
  267. package/dist/model/OkResponse.js +1 -1
  268. package/dist/model/OpenLobbyReadyCheckRequest.js +1 -1
  269. package/dist/model/OpenPartyReadyCheckRequest.js +1 -1
  270. package/dist/model/PageMeta.js +1 -1
  271. package/dist/model/Party.js +1 -1
  272. package/dist/model/PartyCreateLobbyRequest.js +1 -1
  273. package/dist/model/PartyInvite.js +1 -1
  274. package/dist/model/PartyInvitePage.js +147 -0
  275. package/dist/model/PartyJoinLobbyRequest.js +1 -1
  276. package/dist/model/PartyResponse.js +115 -0
  277. package/dist/model/PartyStats.js +1 -1
  278. package/dist/model/PartyStatsResponse.js +1 -1
  279. package/dist/model/PaymentCatalogEntry.js +195 -0
  280. package/dist/model/{AdminListChatFilterWords200Response.js → PaymentCatalogEntryPage.js} +56 -45
  281. package/dist/model/PaymentProduct.js +180 -0
  282. package/dist/model/PaymentWebhookReceipt.js +137 -0
  283. package/dist/model/PaymentWebhookReceiptResponse.js +115 -0
  284. package/dist/model/PaymentsSteamCheckoutRequest.js +1 -1
  285. package/dist/model/PaymentsSteamFinalizeRequest.js +1 -1
  286. package/dist/model/PaymentsStripeCheckoutRequest.js +1 -1
  287. package/dist/model/PlayerStats.js +1 -1
  288. package/dist/model/PlayerStatsResponse.js +1 -1
  289. package/dist/model/PromoteGroupMemberRequest.js +1 -1
  290. package/dist/model/ProviderLinkStatus.js +181 -0
  291. package/dist/model/ProviderLinkStatusResponse.js +115 -0
  292. package/dist/model/PublicUser.js +5 -35
  293. package/dist/model/PublicUserPage.js +1 -1
  294. package/dist/model/PublicUserResponse.js +115 -0
  295. package/dist/model/Purchase.js +279 -0
  296. package/dist/model/PurchaseResponse.js +115 -0
  297. package/dist/model/PurchaseValidation.js +126 -0
  298. package/dist/model/PurchaseValidationResponse.js +115 -0
  299. package/dist/model/PushToken.js +1 -1
  300. package/dist/model/PushTokenPage.js +1 -1
  301. package/dist/model/PushTokenResponse.js +115 -0
  302. package/dist/model/{AdminListQuests200ResponseDataInner.js → Quest.js} +194 -73
  303. package/dist/model/{ClaimQuest200ResponseData.js → QuestClaim.js} +58 -35
  304. package/dist/model/QuestClaimResponse.js +115 -0
  305. package/dist/model/QuestFunnelResponse.js +112 -0
  306. package/dist/model/QuestObjective.js +136 -0
  307. package/dist/model/{AdminListChatMessages200Response.js → QuestPage.js} +57 -34
  308. package/dist/model/{UserQuests200ResponseDataInnerProgress.js → QuestProgress.js} +67 -31
  309. package/dist/model/QuestReward.js +157 -0
  310. package/dist/model/QuestStats.js +129 -0
  311. package/dist/model/QuestStatsResponse.js +115 -0
  312. package/dist/model/QuickJoinRequest.js +1 -1
  313. package/dist/model/ReadyCheckOutcomesResponse.js +112 -0
  314. package/dist/model/ReadyCheckParticipant.js +179 -0
  315. package/dist/model/{GetMyReadyCheck200ResponseParty.js → ReadyCheckState.js} +119 -42
  316. package/dist/model/ReadyCheckStateResponse.js +115 -0
  317. package/dist/model/RefreshTokenRequest.js +1 -1
  318. package/dist/model/RegisterPushTokenRequest.js +1 -1
  319. package/dist/model/{ProfileUpdate.js → RegisterRequest.js} +40 -49
  320. package/dist/model/ReportChatMessageRequest.js +1 -1
  321. package/dist/model/ResolveLeaderboardSlugsRequest.js +1 -1
  322. package/dist/model/RespondReadyCheckRequest.js +1 -1
  323. package/dist/model/RetentionStatus.js +133 -0
  324. package/dist/model/RetentionStatusResponse.js +115 -0
  325. package/dist/model/SendChatMessageRequest.js +1 -1
  326. package/dist/model/SendNotificationRequest.js +1 -1
  327. package/dist/model/ServerStats.js +227 -0
  328. package/dist/model/ServerStatsResponse.js +115 -0
  329. package/dist/model/ServerTime.js +110 -0
  330. package/dist/model/ServerTimeResponse.js +115 -0
  331. package/dist/model/Session.js +1 -1
  332. package/dist/model/SessionResponse.js +1 -1
  333. package/dist/model/SetCurrentUserAvatarRequest.js +1 -1
  334. package/dist/model/SetGroupIconRequest.js +1 -1
  335. package/dist/model/SetLobbyStateRequest.js +1 -1
  336. package/dist/model/SignalingStats.js +131 -0
  337. package/dist/model/SignalingStatsResponse.js +115 -0
  338. package/dist/model/SteamCheckout.js +144 -0
  339. package/dist/model/SteamCheckoutResponse.js +115 -0
  340. package/dist/model/StorageObject.js +134 -0
  341. package/dist/model/StorageObjectPage.js +147 -0
  342. package/dist/model/StorageObjectResponse.js +115 -0
  343. package/dist/model/{UnmuteResult.js → StorageUsage.js} +33 -34
  344. package/dist/model/StorageUsageResponse.js +115 -0
  345. package/dist/model/StripeCheckout.js +143 -0
  346. package/dist/model/StripeCheckoutResponse.js +115 -0
  347. package/dist/model/{ListTournaments200ResponseDataInner.js → Tournament.js} +111 -41
  348. package/dist/model/TournamentBracket.js +186 -0
  349. package/dist/model/TournamentBracketPage.js +147 -0
  350. package/dist/model/TournamentEntry.js +211 -0
  351. package/dist/model/TournamentEntryPage.js +147 -0
  352. package/dist/model/TournamentEntryResponse.js +115 -0
  353. package/dist/model/{TournamentMyMatch200Response.js → TournamentMatch.js} +105 -28
  354. package/dist/model/TournamentMatchCounts.js +129 -0
  355. package/dist/model/TournamentMatchResponse.js +115 -0
  356. package/dist/model/{AdminListMatchmakingTickets200Response.js → TournamentPage.js} +57 -34
  357. package/dist/model/TournamentPlacement.js +200 -0
  358. package/dist/model/TournamentResponse.js +115 -0
  359. package/dist/model/TournamentStandings.js +163 -0
  360. package/dist/model/TournamentStandingsResponse.js +115 -0
  361. package/dist/model/TournamentStats.js +141 -0
  362. package/dist/model/UnmuteGroupMemberRequest.js +1 -1
  363. package/dist/model/UnmuteLobbyMemberRequest.js +1 -1
  364. package/dist/model/UnmutePartyMemberRequest.js +1 -1
  365. package/dist/model/UpdateChatMessageRequest.js +1 -1
  366. package/dist/model/UpdateCurrentUserDisplayNameRequest.js +1 -1
  367. package/dist/model/UpdateCurrentUserPasswordRequest.js +1 -1
  368. package/dist/model/UpdateCurrentUserUsernameRequest.js +1 -1
  369. package/dist/model/UpdateGroupRequest.js +1 -1
  370. package/dist/model/UpdateLobbyRequest.js +1 -1
  371. package/dist/model/UpdatePartyRequest.js +1 -1
  372. package/dist/model/UploadTicket.js +1 -1
  373. package/dist/model/UploadTicketResponse.js +115 -0
  374. package/dist/model/UserBrief.js +1 -1
  375. package/dist/model/UserBriefPage.js +1 -1
  376. package/dist/model/WalletBalance.js +137 -0
  377. package/dist/model/WalletBalanceResponse.js +115 -0
  378. package/dist/model/WalletBalancesResponse.js +112 -0
  379. package/package.json +1 -1
  380. package/dist/model/AdminCancelMatchmakingTicket200Response.js +0 -91
  381. package/dist/model/AdminCancelReadyCheck200Response.js +0 -91
  382. package/dist/model/AdminCancelReadyCheck200ResponseData.js +0 -223
  383. package/dist/model/AdminConsumeItem400Response.js +0 -89
  384. package/dist/model/AdminCreateChatMute200Response.js +0 -91
  385. package/dist/model/AdminCreateLeaderboard200Response.js +0 -91
  386. package/dist/model/AdminCreateLeaderboard200ResponseData.js +0 -248
  387. package/dist/model/AdminDeleteChatConversation200Response.js +0 -91
  388. package/dist/model/AdminDeleteChatConversation200ResponseData.js +0 -85
  389. package/dist/model/AdminDeleteChatFilterWordsByLang200Response.js +0 -93
  390. package/dist/model/AdminDrawTournament200Response.js +0 -91
  391. package/dist/model/AdminGetAnalyticsCounts200ResponseTotalsInner.js +0 -97
  392. package/dist/model/AdminGetAnalyticsDaily200ResponseSeriesInner.js +0 -128
  393. package/dist/model/AdminGetAnalyticsEconomy200ResponseFlowInner.js +0 -133
  394. package/dist/model/AdminGetAnalyticsEconomy200ResponseTotalsInner.js +0 -133
  395. package/dist/model/AdminImportChatFilterWords200Response.js +0 -93
  396. package/dist/model/AdminListChatMessages200ResponseDataInner.js +0 -213
  397. package/dist/model/AdminListChatMutes200Response.js +0 -124
  398. package/dist/model/AdminListChatReports200Response.js +0 -124
  399. package/dist/model/AdminListKvEntries200Response.js +0 -124
  400. package/dist/model/AdminListLobbies200ResponseDataInner.js +0 -191
  401. package/dist/model/AdminListNotifications200ResponseDataInner.js +0 -173
  402. package/dist/model/AdminListPushTokens200Response.js +0 -118
  403. package/dist/model/AdminListQuestProgress200Response.js +0 -118
  404. package/dist/model/AdminListQuests200Response.js +0 -118
  405. package/dist/model/AdminListReadyChecks200Response.js +0 -124
  406. package/dist/model/AdminListSessions200Response.js +0 -124
  407. package/dist/model/AdminListStorageObjects200Response.js +0 -132
  408. package/dist/model/AdminListStorageObjects200ResponseDataInner.js +0 -105
  409. package/dist/model/AdminListStorageObjects200ResponseUsage.js +0 -93
  410. package/dist/model/AdminMatchmakingStats200Response.js +0 -91
  411. package/dist/model/AdminMatchmakingStats200ResponseData.js +0 -113
  412. package/dist/model/AdminResolveChatReport200Response.js +0 -91
  413. package/dist/model/AdminRunRetention200Response.js +0 -104
  414. package/dist/model/AdminTestChatPhrase200Response.js +0 -91
  415. package/dist/model/AdminTestChatPhrase200ResponseDataHitsInner.js +0 -113
  416. package/dist/model/AdminUpdateChatFilterWord200Response.js +0 -91
  417. package/dist/model/AdminUpdateGroup200Response.js +0 -199
  418. package/dist/model/AdminUpdateLeaderboardRecord200Response.js +0 -91
  419. package/dist/model/AdminUpdateLobby200Response.js +0 -91
  420. package/dist/model/AdminUpdateUser200Response.js +0 -91
  421. package/dist/model/AdminUpsertKv200Response.js +0 -91
  422. package/dist/model/CallHook200Response.js +0 -88
  423. package/dist/model/ClaimQuest200Response.js +0 -91
  424. package/dist/model/GetCurrentUserInventory200Response.js +0 -87
  425. package/dist/model/GetKv200Response.js +0 -93
  426. package/dist/model/GetMyReadyCheck200Response.js +0 -105
  427. package/dist/model/GetMyReadyCheck200ResponseLobby.js +0 -257
  428. package/dist/model/GetMyRecord200Response.js +0 -91
  429. package/dist/model/GetServerTime200Response.js +0 -86
  430. package/dist/model/GetStats200Response.js +0 -91
  431. package/dist/model/GetStats200ResponseData.js +0 -151
  432. package/dist/model/ListCurrentUserLedger200Response.js +0 -118
  433. package/dist/model/ListRecordsAroundUser200Response.js +0 -110
  434. package/dist/model/ListTournaments200Response.js +0 -110
  435. package/dist/model/MatchmakingCancel200Response.js +0 -85
  436. package/dist/model/MatchmakingJoin201Response.js +0 -91
  437. package/dist/model/MatchmakingMyTicket200Response.js +0 -91
  438. package/dist/model/MatchmakingMyTicket200ResponseData.js +0 -186
  439. package/dist/model/MatchmakingStats200Response.js +0 -91
  440. package/dist/model/MatchmakingStats200ResponseDataQueuesInner.js +0 -93
  441. package/dist/model/OAuthResult.js +0 -148
  442. package/dist/model/OAuthSessionData.js +0 -153
  443. package/dist/model/OAuthSessionDataDetails.js +0 -128
  444. package/dist/model/QuestStats200Response.js +0 -91
  445. package/dist/model/QuestStats200ResponseData.js +0 -101
  446. package/dist/model/ResolveLeaderboardSlugs200Response.js +0 -89
  447. package/dist/model/SignalingStats200Response.js +0 -91
  448. package/dist/model/SignalingStats200ResponseData.js +0 -101
  449. package/dist/model/UserQuests200ResponseDataInnerObjectivesInner.js +0 -108
  450. package/dist/model/UserQuests200ResponseDataInnerRewardsInner.js +0 -130
  451. package/dist/model/UserQuests200ResponseMeta.js +0 -125
@@ -5,15 +5,17 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
- var _AdminConsumeItem400Response = _interopRequireDefault(require("../model/AdminConsumeItem400Response"));
9
- var _AdminCreateLeaderboard200Response = _interopRequireDefault(require("../model/AdminCreateLeaderboard200Response"));
10
8
  var _AdminCreateLeaderboardRequest = _interopRequireDefault(require("../model/AdminCreateLeaderboardRequest"));
11
9
  var _AdminLeaderboardIconUploadUrlRequest = _interopRequireDefault(require("../model/AdminLeaderboardIconUploadUrlRequest"));
10
+ var _AdminLeaderboardRecordResponse = _interopRequireDefault(require("../model/AdminLeaderboardRecordResponse"));
12
11
  var _AdminSetLeaderboardIconRequest = _interopRequireDefault(require("../model/AdminSetLeaderboardIconRequest"));
13
12
  var _AdminSubmitLeaderboardScoreRequest = _interopRequireDefault(require("../model/AdminSubmitLeaderboardScoreRequest"));
14
- var _AdminUpdateLeaderboardRecord200Response = _interopRequireDefault(require("../model/AdminUpdateLeaderboardRecord200Response"));
15
13
  var _AdminUpdateLeaderboardRecordRequest = _interopRequireDefault(require("../model/AdminUpdateLeaderboardRecordRequest"));
16
14
  var _AdminUpdateLeaderboardRequest = _interopRequireDefault(require("../model/AdminUpdateLeaderboardRequest"));
15
+ var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
16
+ var _LeaderboardResponse = _interopRequireDefault(require("../model/LeaderboardResponse"));
17
+ var _OkResponse = _interopRequireDefault(require("../model/OkResponse"));
18
+ var _UploadTicketResponse = _interopRequireDefault(require("../model/UploadTicketResponse"));
17
19
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
18
20
  function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
19
21
  function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
@@ -24,7 +26,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
24
26
  * Gamend API
25
27
  * 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 })) ```
26
28
  *
27
- * The version of the OpenAPI document: 1.0.1240
29
+ * The version of the OpenAPI document: 1.0.1250
28
30
  *
29
31
  *
30
32
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -54,7 +56,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
54
56
  * Create leaderboard (admin)
55
57
  * @param {Object} opts Optional parameters
56
58
  * @param {module:model/AdminCreateLeaderboardRequest} [adminCreateLeaderboardRequest] Leaderboard
57
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminCreateLeaderboard200Response} and HTTP response
59
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/LeaderboardResponse} and HTTP response
58
60
  */
59
61
  return _createClass(AdminLeaderboardsApi, [{
60
62
  key: "adminCreateLeaderboardWithHttpInfo",
@@ -68,7 +70,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
68
70
  var authNames = ['authorization'];
69
71
  var contentTypes = ['application/json'];
70
72
  var accepts = ['application/json'];
71
- var returnType = _AdminCreateLeaderboard200Response["default"];
73
+ var returnType = _LeaderboardResponse["default"];
72
74
  return this.apiClient.callApi('/api/v1/admin/leaderboards', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
73
75
  }
74
76
 
@@ -76,7 +78,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
76
78
  * Create leaderboard (admin)
77
79
  * @param {Object} opts Optional parameters
78
80
  * @param {module:model/AdminCreateLeaderboardRequest} opts.adminCreateLeaderboardRequest Leaderboard
79
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminCreateLeaderboard200Response}
81
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/LeaderboardResponse}
80
82
  */
81
83
  }, {
82
84
  key: "adminCreateLeaderboard",
@@ -89,7 +91,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
89
91
  /**
90
92
  * Delete leaderboard (admin)
91
93
  * @param {String} id
92
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
94
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OkResponse} and HTTP response
93
95
  */
94
96
  }, {
95
97
  key: "adminDeleteLeaderboardWithHttpInfo",
@@ -108,14 +110,14 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
108
110
  var authNames = ['authorization'];
109
111
  var contentTypes = [];
110
112
  var accepts = ['application/json'];
111
- var returnType = Object;
113
+ var returnType = _OkResponse["default"];
112
114
  return this.apiClient.callApi('/api/v1/admin/leaderboards/{id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
113
115
  }
114
116
 
115
117
  /**
116
118
  * Delete leaderboard (admin)
117
119
  * @param {String} id
118
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
120
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OkResponse}
119
121
  */
120
122
  }, {
121
123
  key: "adminDeleteLeaderboard",
@@ -129,7 +131,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
129
131
  * Delete leaderboard record (admin)
130
132
  * @param {String} id
131
133
  * @param {String} recordId
132
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
134
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OkResponse} and HTTP response
133
135
  */
134
136
  }, {
135
137
  key: "adminDeleteLeaderboardRecordWithHttpInfo",
@@ -153,7 +155,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
153
155
  var authNames = ['authorization'];
154
156
  var contentTypes = [];
155
157
  var accepts = ['application/json'];
156
- var returnType = Object;
158
+ var returnType = _OkResponse["default"];
157
159
  return this.apiClient.callApi('/api/v1/admin/leaderboards/{id}/records/{record_id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
158
160
  }
159
161
 
@@ -161,7 +163,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
161
163
  * Delete leaderboard record (admin)
162
164
  * @param {String} id
163
165
  * @param {String} recordId
164
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
166
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OkResponse}
165
167
  */
166
168
  }, {
167
169
  key: "adminDeleteLeaderboardRecord",
@@ -175,7 +177,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
175
177
  * Delete a user's record (admin)
176
178
  * @param {String} id
177
179
  * @param {String} userId
178
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
180
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OkResponse} and HTTP response
179
181
  */
180
182
  }, {
181
183
  key: "adminDeleteLeaderboardUserRecordWithHttpInfo",
@@ -199,7 +201,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
199
201
  var authNames = ['authorization'];
200
202
  var contentTypes = [];
201
203
  var accepts = ['application/json'];
202
- var returnType = Object;
204
+ var returnType = _OkResponse["default"];
203
205
  return this.apiClient.callApi('/api/v1/admin/leaderboards/{id}/records/user/{user_id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
204
206
  }
205
207
 
@@ -207,7 +209,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
207
209
  * Delete a user's record (admin)
208
210
  * @param {String} id
209
211
  * @param {String} userId
210
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
212
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OkResponse}
211
213
  */
212
214
  }, {
213
215
  key: "adminDeleteLeaderboardUserRecord",
@@ -220,7 +222,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
220
222
  /**
221
223
  * End leaderboard (admin)
222
224
  * @param {String} id
223
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminCreateLeaderboard200Response} and HTTP response
225
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/LeaderboardResponse} and HTTP response
224
226
  */
225
227
  }, {
226
228
  key: "adminEndLeaderboardWithHttpInfo",
@@ -239,14 +241,14 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
239
241
  var authNames = ['authorization'];
240
242
  var contentTypes = [];
241
243
  var accepts = ['application/json'];
242
- var returnType = _AdminCreateLeaderboard200Response["default"];
244
+ var returnType = _LeaderboardResponse["default"];
243
245
  return this.apiClient.callApi('/api/v1/admin/leaderboards/{id}/end', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
244
246
  }
245
247
 
246
248
  /**
247
249
  * End leaderboard (admin)
248
250
  * @param {String} id
249
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminCreateLeaderboard200Response}
251
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/LeaderboardResponse}
250
252
  */
251
253
  }, {
252
254
  key: "adminEndLeaderboard",
@@ -262,7 +264,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
262
264
  * @param {String} id
263
265
  * @param {Object} opts Optional parameters
264
266
  * @param {module:model/AdminLeaderboardIconUploadUrlRequest} [adminLeaderboardIconUploadUrlRequest] Declared content type
265
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
267
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UploadTicketResponse} and HTTP response
266
268
  */
267
269
  }, {
268
270
  key: "adminLeaderboardIconUploadUrlWithHttpInfo",
@@ -282,7 +284,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
282
284
  var authNames = ['authorization'];
283
285
  var contentTypes = ['application/json'];
284
286
  var accepts = ['application/json'];
285
- var returnType = Object;
287
+ var returnType = _UploadTicketResponse["default"];
286
288
  return this.apiClient.callApi('/api/v1/admin/leaderboards/{id}/icon/upload_url', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
287
289
  }
288
290
 
@@ -292,7 +294,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
292
294
  * @param {String} id
293
295
  * @param {Object} opts Optional parameters
294
296
  * @param {module:model/AdminLeaderboardIconUploadUrlRequest} opts.adminLeaderboardIconUploadUrlRequest Declared content type
295
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
297
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UploadTicketResponse}
296
298
  */
297
299
  }, {
298
300
  key: "adminLeaderboardIconUploadUrl",
@@ -308,7 +310,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
308
310
  * @param {String} id
309
311
  * @param {Object} opts Optional parameters
310
312
  * @param {module:model/AdminSetLeaderboardIconRequest} [adminSetLeaderboardIconRequest] Uploaded object key
311
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
313
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/LeaderboardResponse} and HTTP response
312
314
  */
313
315
  }, {
314
316
  key: "adminSetLeaderboardIconWithHttpInfo",
@@ -328,7 +330,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
328
330
  var authNames = ['authorization'];
329
331
  var contentTypes = ['application/json'];
330
332
  var accepts = ['application/json'];
331
- var returnType = Object;
333
+ var returnType = _LeaderboardResponse["default"];
332
334
  return this.apiClient.callApi('/api/v1/admin/leaderboards/{id}/icon', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
333
335
  }
334
336
 
@@ -338,7 +340,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
338
340
  * @param {String} id
339
341
  * @param {Object} opts Optional parameters
340
342
  * @param {module:model/AdminSetLeaderboardIconRequest} opts.adminSetLeaderboardIconRequest Uploaded object key
341
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
343
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/LeaderboardResponse}
342
344
  */
343
345
  }, {
344
346
  key: "adminSetLeaderboardIcon",
@@ -353,7 +355,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
353
355
  * @param {String} id
354
356
  * @param {Object} opts Optional parameters
355
357
  * @param {module:model/AdminSubmitLeaderboardScoreRequest} [adminSubmitLeaderboardScoreRequest] Score submission
356
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminUpdateLeaderboardRecord200Response} and HTTP response
358
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminLeaderboardRecordResponse} and HTTP response
357
359
  */
358
360
  }, {
359
361
  key: "adminSubmitLeaderboardScoreWithHttpInfo",
@@ -373,7 +375,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
373
375
  var authNames = ['authorization'];
374
376
  var contentTypes = ['application/json'];
375
377
  var accepts = ['application/json'];
376
- var returnType = _AdminUpdateLeaderboardRecord200Response["default"];
378
+ var returnType = _AdminLeaderboardRecordResponse["default"];
377
379
  return this.apiClient.callApi('/api/v1/admin/leaderboards/{id}/records', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
378
380
  }
379
381
 
@@ -382,7 +384,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
382
384
  * @param {String} id
383
385
  * @param {Object} opts Optional parameters
384
386
  * @param {module:model/AdminSubmitLeaderboardScoreRequest} opts.adminSubmitLeaderboardScoreRequest Score submission
385
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminUpdateLeaderboardRecord200Response}
387
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminLeaderboardRecordResponse}
386
388
  */
387
389
  }, {
388
390
  key: "adminSubmitLeaderboardScore",
@@ -397,7 +399,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
397
399
  * @param {String} id
398
400
  * @param {Object} opts Optional parameters
399
401
  * @param {module:model/AdminUpdateLeaderboardRequest} [adminUpdateLeaderboardRequest] Leaderboard patch
400
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminCreateLeaderboard200Response} and HTTP response
402
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/LeaderboardResponse} and HTTP response
401
403
  */
402
404
  }, {
403
405
  key: "adminUpdateLeaderboardWithHttpInfo",
@@ -417,7 +419,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
417
419
  var authNames = ['authorization'];
418
420
  var contentTypes = ['application/json'];
419
421
  var accepts = ['application/json'];
420
- var returnType = _AdminCreateLeaderboard200Response["default"];
422
+ var returnType = _LeaderboardResponse["default"];
421
423
  return this.apiClient.callApi('/api/v1/admin/leaderboards/{id}', 'PATCH', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
422
424
  }
423
425
 
@@ -426,7 +428,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
426
428
  * @param {String} id
427
429
  * @param {Object} opts Optional parameters
428
430
  * @param {module:model/AdminUpdateLeaderboardRequest} opts.adminUpdateLeaderboardRequest Leaderboard patch
429
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminCreateLeaderboard200Response}
431
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/LeaderboardResponse}
430
432
  */
431
433
  }, {
432
434
  key: "adminUpdateLeaderboard",
@@ -442,7 +444,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
442
444
  * @param {String} recordId
443
445
  * @param {Object} opts Optional parameters
444
446
  * @param {module:model/AdminUpdateLeaderboardRecordRequest} [adminUpdateLeaderboardRecordRequest] Record patch
445
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminUpdateLeaderboardRecord200Response} and HTTP response
447
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminLeaderboardRecordResponse} and HTTP response
446
448
  */
447
449
  }, {
448
450
  key: "adminUpdateLeaderboardRecordWithHttpInfo",
@@ -467,7 +469,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
467
469
  var authNames = ['authorization'];
468
470
  var contentTypes = ['application/json'];
469
471
  var accepts = ['application/json'];
470
- var returnType = _AdminUpdateLeaderboardRecord200Response["default"];
472
+ var returnType = _AdminLeaderboardRecordResponse["default"];
471
473
  return this.apiClient.callApi('/api/v1/admin/leaderboards/{id}/records/{record_id}', 'PATCH', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
472
474
  }
473
475
 
@@ -477,7 +479,7 @@ var AdminLeaderboardsApi = exports["default"] = /*#__PURE__*/function () {
477
479
  * @param {String} recordId
478
480
  * @param {Object} opts Optional parameters
479
481
  * @param {module:model/AdminUpdateLeaderboardRecordRequest} opts.adminUpdateLeaderboardRecordRequest Record patch
480
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminUpdateLeaderboardRecord200Response}
482
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminLeaderboardRecordResponse}
481
483
  */
482
484
  }, {
483
485
  key: "adminUpdateLeaderboardRecord",
@@ -5,10 +5,11 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
- var _AdminConsumeItem400Response = _interopRequireDefault(require("../model/AdminConsumeItem400Response"));
9
- var _AdminListLobbies200Response = _interopRequireDefault(require("../model/AdminListLobbies200Response"));
10
- var _AdminUpdateLobby200Response = _interopRequireDefault(require("../model/AdminUpdateLobby200Response"));
11
8
  var _AdminUpdateLobbyRequest = _interopRequireDefault(require("../model/AdminUpdateLobbyRequest"));
9
+ var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
10
+ var _LobbyPage = _interopRequireDefault(require("../model/LobbyPage"));
11
+ var _LobbyResponse = _interopRequireDefault(require("../model/LobbyResponse"));
12
+ var _OkResponse = _interopRequireDefault(require("../model/OkResponse"));
12
13
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
13
14
  function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
14
15
  function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
@@ -19,7 +20,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
19
20
  * Gamend API
20
21
  * API for Gamend. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, quests, leaderboards, tournaments, matchmaking, payments, server scripting, and admin portal. ## **1. Authentication** This API uses JWT (JSON Web Tokens) with access and refresh tokens: ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ``` ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token. ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights: - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported ## **3. Friends** The Friends domain offers lightweight social features: - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights: - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated ## **5. Notifications** Persistent user-to-user notifications that survive across sessions: - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect - **Push delivery**: notifications also fan out to the recipient's registered mobile devices (see Push notifications) ## **5b. Push notifications** Mobile/web push delivery to registered devices (FCM for Android/Web, APNs-direct for iOS): - **Register device tokens** via `POST /me/push_tokens` (`token`, `platform`, optional `provider`/`device_id`); re-registering a `device_id` rotates its token in place - **List/remove own devices** via `GET /me/push_tokens` and `DELETE /me/push_tokens/:id` - **Server-authoritative sending** — no public send endpoint; pushes originate from server hooks (`Gamend.Push.send_to_user/2`) or the admin API - **Per-token routing**: each token's `provider` (\"fcm\" | \"apns\") selects the delivery backend; unconfigured backends log instead of sending (dev-friendly) - **Reliability**: delivery rides the durable job queue with retries; dead tokens reported by the provider are disabled automatically ## **6. Groups** Groups provide persistent community management for players: - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"` ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads): - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel ## **8. Chat** Real-time messaging across multiple conversation types: - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation is built in**: an admin-managed word filter (`block` / `mask` / `flag`, matched on a normalized form so leetspeak and padding do not slip through) and mutes are enforced before a message is stored or broadcast; the `before_chat_message` pipeline hook stays available for rules of your own - **Report a message**: `POST /chat/messages/:id/report` with an optional `reason` — one report per player per message, capped per day; reports the filter files itself have no reporter - **Scoped mutes** mirror kick: `POST /lobbies/mute` + `/lobbies/unmute` (lobby host), `POST /groups/:id/mute` + `/groups/:id/unmute` (group admin), `POST /parties/mute` + `/parties/unmute` (party leader), each with a paginated `.../mutes` listing for the same authority. Body is `{target_user_id, expires_at?, reason?}`; omitting `expires_at` mutes permanently - **Global mutes and the blocklist are server-authoritative** — no public endpoint; admin API (`/api/v1/admin/chat`) or a plugin calling `Gamend.Chat.mute_user/4` - **Real-time moderation events**: the muted player receives `chat_muted` / `chat_unmuted` on their user channel ## **9. Leaderboards** Server-managed ranked scoreboards: - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings: - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata ## **11. Quests / Progression** One event-driven progression engine covering achievements, daily/weekly quests, time-boxed event quests, chains, and groups: - **Kinds**: `achievement` (permanent one-shot — the replacement for the old achievements system), `daily`/`weekly` (reset per UTC period), `event` (starts_at/ends_at window), `chain` (requires a prerequisite quest) - **Objectives**: each quest lists objectives `{event, target, params}`; server-side `report_event` advances every matching active quest — there is **no public endpoint to advance progress** (server-authoritative) - **Rewards**: currencies (Economy) and items (Inventory), paid **exactly once** per period via idempotent grants; `auto_claim` quests pay on completion, others via `POST /me/quests/:key/claim` - **My quests**: `GET /me/quests` returns active quests, per-period progress, and a claimable flag; hidden quests appear once completed - **Groups**: quests sharing a `group_key` collapse to one entry carrying `group_size`; `?group=<key>` lists that group's members in full - **Catalog**: `GET /quests` and per-user completions `GET /quests/user/:user_id` (gated by `GAMEND_FEATURES_LIST_QUESTS`) - **Admin management**: definitions CRUD plus per-user grant/reset/force-claim under `/api/v1/admin/quests` ## **12. Tournaments** Single-elimination bracket tournaments, server-structured and game-judged: - **Registration window → seeded draw → timed rounds → champions**; recurring tournaments (cron) create one occurrence per cycle sharing a slug; a nil starts_at keeps registration open until an admin draws manually - **Join/leave** as an entry leader (`POST`/`DELETE /tournaments/:id/join`); team composition is game policy - **Browse**: list/filter tournaments, standings, full bracket view, and the caller's current match (`GET /tournaments/:id/my_match`) - **Match verdicts are server-side** (game hooks) — no public resolve endpoint; clients get `tournament_match_ready` / `tournament_match_resolved` / `tournament_updated` / `tournament_finished` on the user channel - **Admin management** over HTTP: create/update/delete, cancel, draw now, finish, and force match verdicts under `/api/v1/admin/tournaments` ## **13. Matchmaking** Ticket-based queueing that turns waiting players into hidden, locked lobbies: - **Join over HTTP** (`POST /matchmaking/tickets` with a `match_params` string map); only tickets with identical params match together — encode mode/map/skill band as parameter values - **A match forms** when a group reaches `max_players`, or has at least `min_players` and the oldest ticket outwaited the timeout; the server creates a hidden lobby, seats everyone and locks it - **The result is a push, not a poll**: matched players receive `match_found` (`lobby_id`, `match_params`) on their user channel; disconnecting cancels your tickets - **Inspect**: `GET /matchmaking/tickets/me` for your ticket, `GET /matchmaking/stats` for queue depths - **Admin management** over HTTP: list/filter tickets, force-cancel, and stats under `/api/v1/admin/matchmaking` ## **14. Ready checks** One primitive for \"everyone must answer before this proceeds\", with one client-facing surface: - **A player holds at most one check per lane** — the match lane (lobby ready-up or matchmaking accept) and the party lane (the party's standing board) — so answering needs no id: `GET /me/ready_check` returns `{\"lobby\": …, \"party\": …}` (each null when none) and `POST /me/ready_check` with `{\"ready\": true|false, \"scope\": \"lobby\"|\"party\"}` answers one (scope defaults to `lobby`) - **Two kinds.** `ready` (lobby/party board) is a toggle — a \"no\" just leaves the check open, and it lists every participant. `accept` (match confirmation) is final — one decline fails it for everyone — and returns counts plus your own state, so a pending match does not reveal who you were paired with - **Hosts open one** with `POST /lobbies/ready_check` (host-managed lobbies only; hostless matchmaking lobbies belong to the server), **party leaders** with `POST /parties/ready_check`; either call is a **reset** — it quietly replaces an already-open board with a fresh one over the current members, so the same endpoint serves \"ready check!\", \"force ready\" (with `timeout_ms`) and \"start over\". Call it off with `DELETE /lobbies/ready_check` / `DELETE /parties/ready_check`. The opener is pre-marked ready — clicking the button is their answer - **Failure does nothing on its own**: a declined or timed-out check kicks nobody, starts nothing, and moves no lobby state. It reports who did not answer, and the game (or the host, with the kick they already have) decides - **Live**: `ready_check_started` / `ready_check_updated` / `ready_check_passed` / `ready_check_failed` on the lobby channel, the party channel for a party board, or the user channel for an accept check - **Admin management** over HTTP: list/filter checks, force-cancel, and 24h outcome stats under `/api/v1/admin/ready_checks` ## **15. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates. ### **15.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ``` ### **15.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, quest progress/completions/claims, party/group invites, tournament events, chat mutes (`chat_muted` / `chat_unmuted`), KV subscriptions - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat ### **15.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/gamend' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` `phoenix` ships as a dependency of the package, so no extra install is needed. ## **16. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients). ### **16.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency ### **16.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **16.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/gamend' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, { onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ```
21
22
  *
22
- * The version of the OpenAPI document: 1.0.1240
23
+ * The version of the OpenAPI document: 1.0.1250
23
24
  *
24
25
  *
25
26
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -48,7 +49,7 @@ var AdminLobbiesApi = exports["default"] = /*#__PURE__*/function () {
48
49
  /**
49
50
  * Delete lobby by id (admin)
50
51
  * @param {String} id
51
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response
52
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OkResponse} and HTTP response
52
53
  */
53
54
  return _createClass(AdminLobbiesApi, [{
54
55
  key: "adminDeleteLobbyWithHttpInfo",
@@ -67,14 +68,14 @@ var AdminLobbiesApi = exports["default"] = /*#__PURE__*/function () {
67
68
  var authNames = ['authorization'];
68
69
  var contentTypes = [];
69
70
  var accepts = ['application/json'];
70
- var returnType = Object;
71
+ var returnType = _OkResponse["default"];
71
72
  return this.apiClient.callApi('/api/v1/admin/lobbies/{id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
72
73
  }
73
74
 
74
75
  /**
75
76
  * Delete lobby by id (admin)
76
77
  * @param {String} id
77
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object}
78
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OkResponse}
78
79
  */
79
80
  }, {
80
81
  key: "adminDeleteLobby",
@@ -95,7 +96,7 @@ var AdminLobbiesApi = exports["default"] = /*#__PURE__*/function () {
95
96
  * @param {Number} [maxUsers]
96
97
  * @param {Number} [page]
97
98
  * @param {Number} [pageSize]
98
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminListLobbies200Response} and HTTP response
99
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/LobbyPage} and HTTP response
99
100
  */
100
101
  }, {
101
102
  key: "adminListLobbiesWithHttpInfo",
@@ -118,7 +119,7 @@ var AdminLobbiesApi = exports["default"] = /*#__PURE__*/function () {
118
119
  var authNames = ['authorization'];
119
120
  var contentTypes = [];
120
121
  var accepts = ['application/json'];
121
- var returnType = _AdminListLobbies200Response["default"];
122
+ var returnType = _LobbyPage["default"];
122
123
  return this.apiClient.callApi('/api/v1/admin/lobbies', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
123
124
  }
124
125
 
@@ -133,7 +134,7 @@ var AdminLobbiesApi = exports["default"] = /*#__PURE__*/function () {
133
134
  * @param {Number} opts.maxUsers
134
135
  * @param {Number} opts.page
135
136
  * @param {Number} opts.pageSize
136
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminListLobbies200Response}
137
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/LobbyPage}
137
138
  */
138
139
  }, {
139
140
  key: "adminListLobbies",
@@ -148,7 +149,7 @@ var AdminLobbiesApi = exports["default"] = /*#__PURE__*/function () {
148
149
  * @param {String} id
149
150
  * @param {Object} opts Optional parameters
150
151
  * @param {module:model/AdminUpdateLobbyRequest} [adminUpdateLobbyRequest] Lobby patch
151
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminUpdateLobby200Response} and HTTP response
152
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/LobbyResponse} and HTTP response
152
153
  */
153
154
  }, {
154
155
  key: "adminUpdateLobbyWithHttpInfo",
@@ -168,7 +169,7 @@ var AdminLobbiesApi = exports["default"] = /*#__PURE__*/function () {
168
169
  var authNames = ['authorization'];
169
170
  var contentTypes = ['application/json'];
170
171
  var accepts = ['application/json'];
171
- var returnType = _AdminUpdateLobby200Response["default"];
172
+ var returnType = _LobbyResponse["default"];
172
173
  return this.apiClient.callApi('/api/v1/admin/lobbies/{id}', 'PATCH', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
173
174
  }
174
175
 
@@ -177,7 +178,7 @@ var AdminLobbiesApi = exports["default"] = /*#__PURE__*/function () {
177
178
  * @param {String} id
178
179
  * @param {Object} opts Optional parameters
179
180
  * @param {module:model/AdminUpdateLobbyRequest} opts.adminUpdateLobbyRequest Lobby patch
180
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminUpdateLobby200Response}
181
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/LobbyResponse}
181
182
  */
182
183
  }, {
183
184
  key: "adminUpdateLobby",
@@ -5,10 +5,10 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
- var _AdminCancelMatchmakingTicket200Response = _interopRequireDefault(require("../model/AdminCancelMatchmakingTicket200Response"));
9
- var _AdminConsumeItem400Response = _interopRequireDefault(require("../model/AdminConsumeItem400Response"));
10
- var _AdminListMatchmakingTickets200Response = _interopRequireDefault(require("../model/AdminListMatchmakingTickets200Response"));
11
- var _AdminMatchmakingStats200Response = _interopRequireDefault(require("../model/AdminMatchmakingStats200Response"));
8
+ var _AdminMatchmakingStatsResponse = _interopRequireDefault(require("../model/AdminMatchmakingStatsResponse"));
9
+ var _AdminMatchmakingTicketPage = _interopRequireDefault(require("../model/AdminMatchmakingTicketPage"));
10
+ var _AdminMatchmakingTicketResponse = _interopRequireDefault(require("../model/AdminMatchmakingTicketResponse"));
11
+ var _ErrorResponse = _interopRequireDefault(require("../model/ErrorResponse"));
12
12
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
13
13
  function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
14
14
  function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
@@ -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.1240
22
+ * The version of the OpenAPI document: 1.0.1250
23
23
  *
24
24
  *
25
25
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -48,7 +48,7 @@ var AdminMatchmakingApi = exports["default"] = /*#__PURE__*/function () {
48
48
  /**
49
49
  * Cancel a matchmaking ticket (admin)
50
50
  * @param {String} id
51
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminCancelMatchmakingTicket200Response} and HTTP response
51
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminMatchmakingTicketResponse} and HTTP response
52
52
  */
53
53
  return _createClass(AdminMatchmakingApi, [{
54
54
  key: "adminCancelMatchmakingTicketWithHttpInfo",
@@ -67,14 +67,14 @@ var AdminMatchmakingApi = exports["default"] = /*#__PURE__*/function () {
67
67
  var authNames = ['authorization'];
68
68
  var contentTypes = [];
69
69
  var accepts = ['application/json'];
70
- var returnType = _AdminCancelMatchmakingTicket200Response["default"];
70
+ var returnType = _AdminMatchmakingTicketResponse["default"];
71
71
  return this.apiClient.callApi('/api/v1/admin/matchmaking/tickets/{id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
72
72
  }
73
73
 
74
74
  /**
75
75
  * Cancel a matchmaking ticket (admin)
76
76
  * @param {String} id
77
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminCancelMatchmakingTicket200Response}
77
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminMatchmakingTicketResponse}
78
78
  */
79
79
  }, {
80
80
  key: "adminCancelMatchmakingTicket",
@@ -91,7 +91,7 @@ var AdminMatchmakingApi = exports["default"] = /*#__PURE__*/function () {
91
91
  * @param {String} [userId]
92
92
  * @param {Number} [page = 1)]
93
93
  * @param {Number} [pageSize = 25)]
94
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminListMatchmakingTickets200Response} and HTTP response
94
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminMatchmakingTicketPage} and HTTP response
95
95
  */
96
96
  }, {
97
97
  key: "adminListMatchmakingTicketsWithHttpInfo",
@@ -110,7 +110,7 @@ var AdminMatchmakingApi = exports["default"] = /*#__PURE__*/function () {
110
110
  var authNames = ['authorization'];
111
111
  var contentTypes = [];
112
112
  var accepts = ['application/json'];
113
- var returnType = _AdminListMatchmakingTickets200Response["default"];
113
+ var returnType = _AdminMatchmakingTicketPage["default"];
114
114
  return this.apiClient.callApi('/api/v1/admin/matchmaking/tickets', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
115
115
  }
116
116
 
@@ -121,7 +121,7 @@ var AdminMatchmakingApi = exports["default"] = /*#__PURE__*/function () {
121
121
  * @param {String} opts.userId
122
122
  * @param {Number} opts.page (default to 1)
123
123
  * @param {Number} opts.pageSize (default to 25)
124
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminListMatchmakingTickets200Response}
124
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminMatchmakingTicketPage}
125
125
  */
126
126
  }, {
127
127
  key: "adminListMatchmakingTickets",
@@ -133,7 +133,7 @@ var AdminMatchmakingApi = exports["default"] = /*#__PURE__*/function () {
133
133
 
134
134
  /**
135
135
  * Matchmaking statistics (admin)
136
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminMatchmakingStats200Response} and HTTP response
136
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminMatchmakingStatsResponse} and HTTP response
137
137
  */
138
138
  }, {
139
139
  key: "adminMatchmakingStatsWithHttpInfo",
@@ -146,13 +146,13 @@ var AdminMatchmakingApi = exports["default"] = /*#__PURE__*/function () {
146
146
  var authNames = ['authorization'];
147
147
  var contentTypes = [];
148
148
  var accepts = ['application/json'];
149
- var returnType = _AdminMatchmakingStats200Response["default"];
149
+ var returnType = _AdminMatchmakingStatsResponse["default"];
150
150
  return this.apiClient.callApi('/api/v1/admin/matchmaking/stats', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
151
151
  }
152
152
 
153
153
  /**
154
154
  * Matchmaking statistics (admin)
155
- * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminMatchmakingStats200Response}
155
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminMatchmakingStatsResponse}
156
156
  */
157
157
  }, {
158
158
  key: "adminMatchmakingStats",