@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,8 +5,14 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _QuestObjective = _interopRequireDefault(require("./QuestObjective"));
9
+ var _QuestProgress = _interopRequireDefault(require("./QuestProgress"));
10
+ var _QuestReward = _interopRequireDefault(require("./QuestReward"));
8
11
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
12
  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); }
13
+ function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
14
+ function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
15
+ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
10
16
  function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
11
17
  function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
12
18
  function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
@@ -15,7 +21,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
15
21
  * Gamend API
16
22
  * API for Gamend. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, quests, leaderboards, tournaments, matchmaking, payments, server scripting, and admin portal. ## **1. Authentication** This API uses JWT (JSON Web Tokens) with access and refresh tokens: ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ``` ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token. ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights: - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported ## **3. Friends** The Friends domain offers lightweight social features: - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights: - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated ## **5. Notifications** Persistent user-to-user notifications that survive across sessions: - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect - **Push delivery**: notifications also fan out to the recipient's registered mobile devices (see Push notifications) ## **5b. Push notifications** Mobile/web push delivery to registered devices (FCM for Android/Web, APNs-direct for iOS): - **Register device tokens** via `POST /me/push_tokens` (`token`, `platform`, optional `provider`/`device_id`); re-registering a `device_id` rotates its token in place - **List/remove own devices** via `GET /me/push_tokens` and `DELETE /me/push_tokens/:id` - **Server-authoritative sending** — no public send endpoint; pushes originate from server hooks (`Gamend.Push.send_to_user/2`) or the admin API - **Per-token routing**: each token's `provider` (\"fcm\" | \"apns\") selects the delivery backend; unconfigured backends log instead of sending (dev-friendly) - **Reliability**: delivery rides the durable job queue with retries; dead tokens reported by the provider are disabled automatically ## **6. Groups** Groups provide persistent community management for players: - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"` ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads): - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel ## **8. Chat** Real-time messaging across multiple conversation types: - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation is built in**: an admin-managed word filter (`block` / `mask` / `flag`, matched on a normalized form so leetspeak and padding do not slip through) and mutes are enforced before a message is stored or broadcast; the `before_chat_message` pipeline hook stays available for rules of your own - **Report a message**: `POST /chat/messages/:id/report` with an optional `reason` — one report per player per message, capped per day; reports the filter files itself have no reporter - **Scoped mutes** mirror kick: `POST /lobbies/mute` + `/lobbies/unmute` (lobby host), `POST /groups/:id/mute` + `/groups/:id/unmute` (group admin), `POST /parties/mute` + `/parties/unmute` (party leader), each with a paginated `.../mutes` listing for the same authority. Body is `{target_user_id, expires_at?, reason?}`; omitting `expires_at` mutes permanently - **Global mutes and the blocklist are server-authoritative** — no public endpoint; admin API (`/api/v1/admin/chat`) or a plugin calling `Gamend.Chat.mute_user/4` - **Real-time moderation events**: the muted player receives `chat_muted` / `chat_unmuted` on their user channel ## **9. Leaderboards** Server-managed ranked scoreboards: - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings: - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata ## **11. Quests / Progression** One event-driven progression engine covering achievements, daily/weekly quests, time-boxed event quests, chains, and groups: - **Kinds**: `achievement` (permanent one-shot — the replacement for the old achievements system), `daily`/`weekly` (reset per UTC period), `event` (starts_at/ends_at window), `chain` (requires a prerequisite quest) - **Objectives**: each quest lists objectives `{event, target, params}`; server-side `report_event` advances every matching active quest — there is **no public endpoint to advance progress** (server-authoritative) - **Rewards**: currencies (Economy) and items (Inventory), paid **exactly once** per period via idempotent grants; `auto_claim` quests pay on completion, others via `POST /me/quests/:key/claim` - **My quests**: `GET /me/quests` returns active quests, per-period progress, and a claimable flag; hidden quests appear once completed - **Groups**: quests sharing a `group_key` collapse to one entry carrying `group_size`; `?group=<key>` lists that group's members in full - **Catalog**: `GET /quests` and per-user completions `GET /quests/user/:user_id` (gated by `GAMEND_FEATURES_LIST_QUESTS`) - **Admin management**: definitions CRUD plus per-user grant/reset/force-claim under `/api/v1/admin/quests` ## **12. Tournaments** Single-elimination bracket tournaments, server-structured and game-judged: - **Registration window → seeded draw → timed rounds → champions**; recurring tournaments (cron) create one occurrence per cycle sharing a slug; a nil starts_at keeps registration open until an admin draws manually - **Join/leave** as an entry leader (`POST`/`DELETE /tournaments/:id/join`); team composition is game policy - **Browse**: list/filter tournaments, standings, full bracket view, and the caller's current match (`GET /tournaments/:id/my_match`) - **Match verdicts are server-side** (game hooks) — no public resolve endpoint; clients get `tournament_match_ready` / `tournament_match_resolved` / `tournament_updated` / `tournament_finished` on the user channel - **Admin management** over HTTP: create/update/delete, cancel, draw now, finish, and force match verdicts under `/api/v1/admin/tournaments` ## **13. Matchmaking** Ticket-based queueing that turns waiting players into hidden, locked lobbies: - **Join over HTTP** (`POST /matchmaking/tickets` with a `match_params` string map); only tickets with identical params match together — encode mode/map/skill band as parameter values - **A match forms** when a group reaches `max_players`, or has at least `min_players` and the oldest ticket outwaited the timeout; the server creates a hidden lobby, seats everyone and locks it - **The result is a push, not a poll**: matched players receive `match_found` (`lobby_id`, `match_params`) on their user channel; disconnecting cancels your tickets - **Inspect**: `GET /matchmaking/tickets/me` for your ticket, `GET /matchmaking/stats` for queue depths - **Admin management** over HTTP: list/filter tickets, force-cancel, and stats under `/api/v1/admin/matchmaking` ## **14. Ready checks** One primitive for \"everyone must answer before this proceeds\", with one client-facing surface: - **A player holds at most one check per lane** — the match lane (lobby ready-up or matchmaking accept) and the party lane (the party's standing board) — so answering needs no id: `GET /me/ready_check` returns `{\"lobby\": …, \"party\": …}` (each null when none) and `POST /me/ready_check` with `{\"ready\": true|false, \"scope\": \"lobby\"|\"party\"}` answers one (scope defaults to `lobby`) - **Two kinds.** `ready` (lobby/party board) is a toggle — a \"no\" just leaves the check open, and it lists every participant. `accept` (match confirmation) is final — one decline fails it for everyone — and returns counts plus your own state, so a pending match does not reveal who you were paired with - **Hosts open one** with `POST /lobbies/ready_check` (host-managed lobbies only; hostless matchmaking lobbies belong to the server), **party leaders** with `POST /parties/ready_check`; either call is a **reset** — it quietly replaces an already-open board with a fresh one over the current members, so the same endpoint serves \"ready check!\", \"force ready\" (with `timeout_ms`) and \"start over\". Call it off with `DELETE /lobbies/ready_check` / `DELETE /parties/ready_check`. The opener is pre-marked ready — clicking the button is their answer - **Failure does nothing on its own**: a declined or timed-out check kicks nobody, starts nothing, and moves no lobby state. It reports who did not answer, and the game (or the host, with the kick they already have) decides - **Live**: `ready_check_started` / `ready_check_updated` / `ready_check_passed` / `ready_check_failed` on the lobby channel, the party channel for a party board, or the user channel for an accept check - **Admin management** over HTTP: list/filter checks, force-cancel, and 24h outcome stats under `/api/v1/admin/ready_checks` ## **15. Real-time: WebSocket Channels** The server provides real-time communication via Phoenix WebSocket channels. Connect to the WebSocket endpoint and join topic-based channels for live updates. ### **15.1 Connection** Connect to `wss://your-server.com/socket` with your JWT token as a parameter: ``` const socket = new Socket(\"wss://your-server.com/socket\", { params: { token: \"<access_token>\" } }) socket.connect() ``` ### **15.2 Available Channels** - **User channel** (`user:<user_id>`): notifications, friend events, quest progress/completions/claims, party/group invites, tournament events, chat mutes (`chat_muted` / `chat_unmuted`), KV subscriptions - **Lobby channel** (`lobby:<lobby_id>`): lobby member joins/leaves, lobby updates, lobby chat - **Lobbies channel** (`lobbies`): global lobby list changes (created, updated, deleted) - **Group channel** (`group:<group_id>`): group member changes, group updates, group chat - **Groups channel** (`groups`): global group list changes - **Party channel** (`party:<party_id>`): party member changes, party updates, party chat ### **15.3 JS SDK Helper** The `GameRealtime` class (included in this SDK) wraps Phoenix.Socket with convenient channel helpers: ```javascript import { GameRealtime } from '@ughuuu/gamend' const realtime = new GameRealtime('https://your-server.com', accessToken) const userChannel = realtime.joinUserChannel(userId) userChannel.on('notification', payload => console.log(payload)) ``` `phoenix` ships as a dependency of the package, so no extra install is needed. ## **16. Real-time: WebRTC DataChannels** For low-latency game data, the server supports WebRTC DataChannels alongside WebSocket. The server acts as a WebRTC peer (not P2P between clients). ### **16.1 How It Works** 1. Client connects via WebSocket and joins the **User channel** 2. Client sends an SDP offer over the channel (`webrtc:offer` event) 3. Server responds with an SDP answer (`webrtc:answer` event) 4. ICE candidates are exchanged (`webrtc:ice` events) 5. Once connected, named DataChannels carry game data at low latency ### **16.2 Default DataChannels** - **`events`** (reliable, ordered): important game events (player actions, state changes) - **`state`** (unreliable, unordered): high-frequency position/state sync ### **16.3 JS SDK Helper** The `GameWebRTC` class (included in this SDK, browser-only) handles signaling automatically: ```javascript import { GameRealtime, GameWebRTC } from '@ughuuu/gamend' const realtime = new GameRealtime('https://your-server.com', token) const userChannel = realtime.joinUserChannel(userId) const webrtc = new GameWebRTC(userChannel, { onData: (label, data) => console.log(label, data) }) await webrtc.connect() webrtc.send('events', JSON.stringify({ type: 'move', x: 10, y: 20 })) ```
17
23
  *
18
- * The version of the OpenAPI document: 1.0.1240
24
+ * The version of the OpenAPI document: 1.0.1250
19
25
  *
20
26
  *
21
27
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -24,18 +30,41 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
24
30
  *
25
31
  */
26
32
  /**
27
- * The AdminListQuests200ResponseDataInner model module.
28
- * @module model/AdminListQuests200ResponseDataInner
33
+ * The Quest model module.
34
+ * @module model/Quest
29
35
  * @version 1.0.0
30
36
  */
31
- var AdminListQuests200ResponseDataInner = /*#__PURE__*/function () {
37
+ var Quest = /*#__PURE__*/function () {
32
38
  /**
33
- * Constructs a new <code>AdminListQuests200ResponseDataInner</code>.
34
- * @alias module:model/AdminListQuests200ResponseDataInner
39
+ * Constructs a new <code>Quest</code>.
40
+ * A quest, with the caller&#39;s progress
41
+ * @alias module:model/Quest
42
+ * @param autoClaim {Boolean} Rewards grant on completion
43
+ * @param category {String} Free-form grouping label for your UI; empty when unset
44
+ * @param claimable {Boolean} Completed and waiting to be claimed
45
+ * @param description {String}
46
+ * @param endsAt {Date}
47
+ * @param groupKey {String} Quests sharing this list as one entry; pass `?group=` to open it
48
+ * @param groupSize {Number} How many quests the entry stands for (1 when ungrouped)
49
+ * @param groupTitle {String} The collapsed group entry's title
50
+ * @param hidden {Boolean} Hidden until completed
51
+ * @param iconUrl {String} Empty when unset
52
+ * @param id {String}
53
+ * @param key {String} Unique slug
54
+ * @param metadata {Object}
55
+ * @param objectives {Array.<module:model/QuestObjective>}
56
+ * @param prerequisiteQuestKey {String} Quest that must be completed first; empty when none
57
+ * @param progress {module:model/QuestProgress} Null when the caller has not started it, or is not signed in
58
+ * @param reset {module:model/Quest.ResetEnum} When progress starts over
59
+ * @param resetIntervalDays {Number} Cadence in days when `reset` is `interval` (biweekly = 14)
60
+ * @param rewards {Array.<module:model/QuestReward>}
61
+ * @param sortOrder {Number}
62
+ * @param startsAt {Date}
63
+ * @param title {String}
35
64
  */
36
- function AdminListQuests200ResponseDataInner() {
37
- _classCallCheck(this, AdminListQuests200ResponseDataInner);
38
- AdminListQuests200ResponseDataInner.initialize(this);
65
+ function Quest(autoClaim, category, claimable, description, endsAt, groupKey, groupSize, groupTitle, hidden, iconUrl, id, key, metadata, objectives, prerequisiteQuestKey, progress, reset, resetIntervalDays, rewards, sortOrder, startsAt, title) {
66
+ _classCallCheck(this, Quest);
67
+ Quest.initialize(this, autoClaim, category, claimable, description, endsAt, groupKey, groupSize, groupTitle, hidden, iconUrl, id, key, metadata, objectives, prerequisiteQuestKey, progress, reset, resetIntervalDays, rewards, sortOrder, startsAt, title);
39
68
  }
40
69
 
41
70
  /**
@@ -43,31 +72,54 @@ var AdminListQuests200ResponseDataInner = /*#__PURE__*/function () {
43
72
  * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
44
73
  * Only for internal use.
45
74
  */
46
- return _createClass(AdminListQuests200ResponseDataInner, null, [{
75
+ return _createClass(Quest, null, [{
47
76
  key: "initialize",
48
- value: function initialize(obj) {}
77
+ value: function initialize(obj, autoClaim, category, claimable, description, endsAt, groupKey, groupSize, groupTitle, hidden, iconUrl, id, key, metadata, objectives, prerequisiteQuestKey, progress, reset, resetIntervalDays, rewards, sortOrder, startsAt, title) {
78
+ obj['auto_claim'] = autoClaim;
79
+ obj['category'] = category;
80
+ obj['claimable'] = claimable;
81
+ obj['description'] = description;
82
+ obj['ends_at'] = endsAt;
83
+ obj['group_key'] = groupKey;
84
+ obj['group_size'] = groupSize;
85
+ obj['group_title'] = groupTitle;
86
+ obj['hidden'] = hidden;
87
+ obj['icon_url'] = iconUrl;
88
+ obj['id'] = id;
89
+ obj['key'] = key;
90
+ obj['metadata'] = metadata;
91
+ obj['objectives'] = objectives;
92
+ obj['prerequisite_quest_key'] = prerequisiteQuestKey;
93
+ obj['progress'] = progress;
94
+ obj['reset'] = reset;
95
+ obj['reset_interval_days'] = resetIntervalDays;
96
+ obj['rewards'] = rewards;
97
+ obj['sort_order'] = sortOrder;
98
+ obj['starts_at'] = startsAt;
99
+ obj['title'] = title;
100
+ }
49
101
 
50
102
  /**
51
- * Constructs a <code>AdminListQuests200ResponseDataInner</code> from a plain JavaScript object, optionally creating a new instance.
103
+ * Constructs a <code>Quest</code> from a plain JavaScript object, optionally creating a new instance.
52
104
  * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
53
105
  * @param {Object} data The plain JavaScript object bearing properties of interest.
54
- * @param {module:model/AdminListQuests200ResponseDataInner} obj Optional instance to populate.
55
- * @return {module:model/AdminListQuests200ResponseDataInner} The populated <code>AdminListQuests200ResponseDataInner</code> instance.
106
+ * @param {module:model/Quest} obj Optional instance to populate.
107
+ * @return {module:model/Quest} The populated <code>Quest</code> instance.
56
108
  */
57
109
  }, {
58
110
  key: "constructFromObject",
59
111
  value: function constructFromObject(data, obj) {
60
112
  if (data) {
61
- obj = obj || new AdminListQuests200ResponseDataInner();
62
- if (data.hasOwnProperty('active')) {
63
- obj['active'] = _ApiClient["default"].convertToType(data['active'], 'Boolean');
64
- }
113
+ obj = obj || new Quest();
65
114
  if (data.hasOwnProperty('auto_claim')) {
66
115
  obj['auto_claim'] = _ApiClient["default"].convertToType(data['auto_claim'], 'Boolean');
67
116
  }
68
117
  if (data.hasOwnProperty('category')) {
69
118
  obj['category'] = _ApiClient["default"].convertToType(data['category'], 'String');
70
119
  }
120
+ if (data.hasOwnProperty('claimable')) {
121
+ obj['claimable'] = _ApiClient["default"].convertToType(data['claimable'], 'Boolean');
122
+ }
71
123
  if (data.hasOwnProperty('description')) {
72
124
  obj['description'] = _ApiClient["default"].convertToType(data['description'], 'String');
73
125
  }
@@ -77,6 +129,9 @@ var AdminListQuests200ResponseDataInner = /*#__PURE__*/function () {
77
129
  if (data.hasOwnProperty('group_key')) {
78
130
  obj['group_key'] = _ApiClient["default"].convertToType(data['group_key'], 'String');
79
131
  }
132
+ if (data.hasOwnProperty('group_size')) {
133
+ obj['group_size'] = _ApiClient["default"].convertToType(data['group_size'], 'Number');
134
+ }
80
135
  if (data.hasOwnProperty('group_title')) {
81
136
  obj['group_title'] = _ApiClient["default"].convertToType(data['group_title'], 'String');
82
137
  }
@@ -89,9 +144,6 @@ var AdminListQuests200ResponseDataInner = /*#__PURE__*/function () {
89
144
  if (data.hasOwnProperty('id')) {
90
145
  obj['id'] = _ApiClient["default"].convertToType(data['id'], 'String');
91
146
  }
92
- if (data.hasOwnProperty('inserted_at')) {
93
- obj['inserted_at'] = _ApiClient["default"].convertToType(data['inserted_at'], 'Date');
94
- }
95
147
  if (data.hasOwnProperty('key')) {
96
148
  obj['key'] = _ApiClient["default"].convertToType(data['key'], 'String');
97
149
  }
@@ -99,11 +151,14 @@ var AdminListQuests200ResponseDataInner = /*#__PURE__*/function () {
99
151
  obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], Object);
100
152
  }
101
153
  if (data.hasOwnProperty('objectives')) {
102
- obj['objectives'] = _ApiClient["default"].convertToType(data['objectives'], [Object]);
154
+ obj['objectives'] = _ApiClient["default"].convertToType(data['objectives'], [_QuestObjective["default"]]);
103
155
  }
104
156
  if (data.hasOwnProperty('prerequisite_quest_key')) {
105
157
  obj['prerequisite_quest_key'] = _ApiClient["default"].convertToType(data['prerequisite_quest_key'], 'String');
106
158
  }
159
+ if (data.hasOwnProperty('progress')) {
160
+ obj['progress'] = _ApiClient["default"].convertToType(data['progress'], _QuestProgress["default"]);
161
+ }
107
162
  if (data.hasOwnProperty('reset')) {
108
163
  obj['reset'] = _ApiClient["default"].convertToType(data['reset'], 'String');
109
164
  }
@@ -111,7 +166,7 @@ var AdminListQuests200ResponseDataInner = /*#__PURE__*/function () {
111
166
  obj['reset_interval_days'] = _ApiClient["default"].convertToType(data['reset_interval_days'], 'Number');
112
167
  }
113
168
  if (data.hasOwnProperty('rewards')) {
114
- obj['rewards'] = _ApiClient["default"].convertToType(data['rewards'], [Object]);
169
+ obj['rewards'] = _ApiClient["default"].convertToType(data['rewards'], [_QuestReward["default"]]);
115
170
  }
116
171
  if (data.hasOwnProperty('sort_order')) {
117
172
  obj['sort_order'] = _ApiClient["default"].convertToType(data['sort_order'], 'Number');
@@ -122,22 +177,34 @@ var AdminListQuests200ResponseDataInner = /*#__PURE__*/function () {
122
177
  if (data.hasOwnProperty('title')) {
123
178
  obj['title'] = _ApiClient["default"].convertToType(data['title'], 'String');
124
179
  }
125
- if (data.hasOwnProperty('updated_at')) {
126
- obj['updated_at'] = _ApiClient["default"].convertToType(data['updated_at'], 'Date');
127
- }
128
180
  }
129
181
  return obj;
130
182
  }
131
183
 
132
184
  /**
133
- * Validates the JSON data with respect to <code>AdminListQuests200ResponseDataInner</code>.
185
+ * Validates the JSON data with respect to <code>Quest</code>.
134
186
  * @param {Object} data The plain JavaScript object bearing properties of interest.
135
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>AdminListQuests200ResponseDataInner</code>.
187
+ * @return {boolean} to indicate whether the JSON data is valid with respect to <code>Quest</code>.
136
188
  */
137
189
  }, {
138
190
  key: "validateJSON",
139
191
  value: function validateJSON(data) {
140
- // ensure the json data is a string
192
+ // check to make sure all required properties are present in the JSON string
193
+ var _iterator = _createForOfIteratorHelper(Quest.RequiredProperties),
194
+ _step;
195
+ try {
196
+ for (_iterator.s(); !(_step = _iterator.n()).done;) {
197
+ var property = _step.value;
198
+ if (!data.hasOwnProperty(property)) {
199
+ throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
200
+ }
201
+ }
202
+ // ensure the json data is a string
203
+ } catch (err) {
204
+ _iterator.e(err);
205
+ } finally {
206
+ _iterator.f();
207
+ }
141
208
  if (data['category'] && !(typeof data['category'] === 'string' || data['category'] instanceof String)) {
142
209
  throw new Error("Expected the field `category` to be a primitive type in the JSON string but got " + data['category']);
143
210
  }
@@ -165,21 +232,60 @@ var AdminListQuests200ResponseDataInner = /*#__PURE__*/function () {
165
232
  if (data['key'] && !(typeof data['key'] === 'string' || data['key'] instanceof String)) {
166
233
  throw new Error("Expected the field `key` to be a primitive type in the JSON string but got " + data['key']);
167
234
  }
168
- // ensure the json data is an array
169
- if (!Array.isArray(data['objectives'])) {
170
- throw new Error("Expected the field `objectives` to be an array in the JSON data but got " + data['objectives']);
235
+ if (data['objectives']) {
236
+ // data not null
237
+ // ensure the json data is an array
238
+ if (!Array.isArray(data['objectives'])) {
239
+ throw new Error("Expected the field `objectives` to be an array in the JSON data but got " + data['objectives']);
240
+ }
241
+ // validate the optional field `objectives` (array)
242
+ var _iterator2 = _createForOfIteratorHelper(data['objectives']),
243
+ _step2;
244
+ try {
245
+ for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
246
+ var item = _step2.value;
247
+ _QuestObjective["default"].validateJSON(item);
248
+ }
249
+ } catch (err) {
250
+ _iterator2.e(err);
251
+ } finally {
252
+ _iterator2.f();
253
+ }
254
+ ;
171
255
  }
172
256
  // ensure the json data is a string
173
257
  if (data['prerequisite_quest_key'] && !(typeof data['prerequisite_quest_key'] === 'string' || data['prerequisite_quest_key'] instanceof String)) {
174
258
  throw new Error("Expected the field `prerequisite_quest_key` to be a primitive type in the JSON string but got " + data['prerequisite_quest_key']);
175
259
  }
260
+ // validate the optional field `progress`
261
+ if (data['progress']) {
262
+ // data not null
263
+ _QuestProgress["default"].validateJSON(data['progress']);
264
+ }
176
265
  // ensure the json data is a string
177
266
  if (data['reset'] && !(typeof data['reset'] === 'string' || data['reset'] instanceof String)) {
178
267
  throw new Error("Expected the field `reset` to be a primitive type in the JSON string but got " + data['reset']);
179
268
  }
180
- // ensure the json data is an array
181
- if (!Array.isArray(data['rewards'])) {
182
- throw new Error("Expected the field `rewards` to be an array in the JSON data but got " + data['rewards']);
269
+ if (data['rewards']) {
270
+ // data not null
271
+ // ensure the json data is an array
272
+ if (!Array.isArray(data['rewards'])) {
273
+ throw new Error("Expected the field `rewards` to be an array in the JSON data but got " + data['rewards']);
274
+ }
275
+ // validate the optional field `rewards` (array)
276
+ var _iterator3 = _createForOfIteratorHelper(data['rewards']),
277
+ _step3;
278
+ try {
279
+ for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
280
+ var _item = _step3.value;
281
+ _QuestReward["default"].validateJSON(_item);
282
+ }
283
+ } catch (err) {
284
+ _iterator3.e(err);
285
+ } finally {
286
+ _iterator3.f();
287
+ }
288
+ ;
183
289
  }
184
290
  // ensure the json data is a string
185
291
  if (data['title'] && !(typeof data['title'] === 'string' || data['title'] instanceof String)) {
@@ -189,122 +295,137 @@ var AdminListQuests200ResponseDataInner = /*#__PURE__*/function () {
189
295
  }
190
296
  }]);
191
297
  }();
192
- /**
193
- * @member {Boolean} active
194
- */
195
- AdminListQuests200ResponseDataInner.prototype['active'] = undefined;
298
+ Quest.RequiredProperties = ["auto_claim", "category", "claimable", "description", "ends_at", "group_key", "group_size", "group_title", "hidden", "icon_url", "id", "key", "metadata", "objectives", "prerequisite_quest_key", "progress", "reset", "reset_interval_days", "rewards", "sort_order", "starts_at", "title"];
196
299
 
197
300
  /**
301
+ * Rewards grant on completion
198
302
  * @member {Boolean} auto_claim
199
303
  */
200
- AdminListQuests200ResponseDataInner.prototype['auto_claim'] = undefined;
304
+ Quest.prototype['auto_claim'] = undefined;
201
305
 
202
306
  /**
307
+ * Free-form grouping label for your UI; empty when unset
203
308
  * @member {String} category
204
309
  */
205
- AdminListQuests200ResponseDataInner.prototype['category'] = undefined;
310
+ Quest.prototype['category'] = undefined;
311
+
312
+ /**
313
+ * Completed and waiting to be claimed
314
+ * @member {Boolean} claimable
315
+ */
316
+ Quest.prototype['claimable'] = undefined;
206
317
 
207
318
  /**
208
319
  * @member {String} description
209
320
  */
210
- AdminListQuests200ResponseDataInner.prototype['description'] = undefined;
321
+ Quest.prototype['description'] = undefined;
211
322
 
212
323
  /**
213
324
  * @member {Date} ends_at
214
325
  */
215
- AdminListQuests200ResponseDataInner.prototype['ends_at'] = undefined;
326
+ Quest.prototype['ends_at'] = undefined;
216
327
 
217
328
  /**
329
+ * Quests sharing this list as one entry; pass `?group=` to open it
218
330
  * @member {String} group_key
219
331
  */
220
- AdminListQuests200ResponseDataInner.prototype['group_key'] = undefined;
332
+ Quest.prototype['group_key'] = undefined;
221
333
 
222
334
  /**
335
+ * How many quests the entry stands for (1 when ungrouped)
336
+ * @member {Number} group_size
337
+ */
338
+ Quest.prototype['group_size'] = undefined;
339
+
340
+ /**
341
+ * The collapsed group entry's title
223
342
  * @member {String} group_title
224
343
  */
225
- AdminListQuests200ResponseDataInner.prototype['group_title'] = undefined;
344
+ Quest.prototype['group_title'] = undefined;
226
345
 
227
346
  /**
347
+ * Hidden until completed
228
348
  * @member {Boolean} hidden
229
349
  */
230
- AdminListQuests200ResponseDataInner.prototype['hidden'] = undefined;
350
+ Quest.prototype['hidden'] = undefined;
231
351
 
232
352
  /**
353
+ * Empty when unset
233
354
  * @member {String} icon_url
234
355
  */
235
- AdminListQuests200ResponseDataInner.prototype['icon_url'] = undefined;
356
+ Quest.prototype['icon_url'] = undefined;
236
357
 
237
358
  /**
238
359
  * @member {String} id
239
360
  */
240
- AdminListQuests200ResponseDataInner.prototype['id'] = undefined;
241
-
242
- /**
243
- * @member {Date} inserted_at
244
- */
245
- AdminListQuests200ResponseDataInner.prototype['inserted_at'] = undefined;
361
+ Quest.prototype['id'] = undefined;
246
362
 
247
363
  /**
364
+ * Unique slug
248
365
  * @member {String} key
249
366
  */
250
- AdminListQuests200ResponseDataInner.prototype['key'] = undefined;
367
+ Quest.prototype['key'] = undefined;
251
368
 
252
369
  /**
253
370
  * @member {Object} metadata
254
371
  */
255
- AdminListQuests200ResponseDataInner.prototype['metadata'] = undefined;
372
+ Quest.prototype['metadata'] = undefined;
256
373
 
257
374
  /**
258
- * @member {Array.<Object>} objectives
375
+ * @member {Array.<module:model/QuestObjective>} objectives
259
376
  */
260
- AdminListQuests200ResponseDataInner.prototype['objectives'] = undefined;
377
+ Quest.prototype['objectives'] = undefined;
261
378
 
262
379
  /**
380
+ * Quest that must be completed first; empty when none
263
381
  * @member {String} prerequisite_quest_key
264
382
  */
265
- AdminListQuests200ResponseDataInner.prototype['prerequisite_quest_key'] = undefined;
383
+ Quest.prototype['prerequisite_quest_key'] = undefined;
384
+
385
+ /**
386
+ * Null when the caller has not started it, or is not signed in
387
+ * @member {module:model/QuestProgress} progress
388
+ */
389
+ Quest.prototype['progress'] = undefined;
266
390
 
267
391
  /**
268
- * @member {module:model/AdminListQuests200ResponseDataInner.ResetEnum} reset
392
+ * When progress starts over
393
+ * @member {module:model/Quest.ResetEnum} reset
269
394
  */
270
- AdminListQuests200ResponseDataInner.prototype['reset'] = undefined;
395
+ Quest.prototype['reset'] = undefined;
271
396
 
272
397
  /**
398
+ * Cadence in days when `reset` is `interval` (biweekly = 14)
273
399
  * @member {Number} reset_interval_days
274
400
  */
275
- AdminListQuests200ResponseDataInner.prototype['reset_interval_days'] = undefined;
401
+ Quest.prototype['reset_interval_days'] = undefined;
276
402
 
277
403
  /**
278
- * @member {Array.<Object>} rewards
404
+ * @member {Array.<module:model/QuestReward>} rewards
279
405
  */
280
- AdminListQuests200ResponseDataInner.prototype['rewards'] = undefined;
406
+ Quest.prototype['rewards'] = undefined;
281
407
 
282
408
  /**
283
409
  * @member {Number} sort_order
284
410
  */
285
- AdminListQuests200ResponseDataInner.prototype['sort_order'] = undefined;
411
+ Quest.prototype['sort_order'] = undefined;
286
412
 
287
413
  /**
288
414
  * @member {Date} starts_at
289
415
  */
290
- AdminListQuests200ResponseDataInner.prototype['starts_at'] = undefined;
416
+ Quest.prototype['starts_at'] = undefined;
291
417
 
292
418
  /**
293
419
  * @member {String} title
294
420
  */
295
- AdminListQuests200ResponseDataInner.prototype['title'] = undefined;
296
-
297
- /**
298
- * @member {Date} updated_at
299
- */
300
- AdminListQuests200ResponseDataInner.prototype['updated_at'] = undefined;
421
+ Quest.prototype['title'] = undefined;
301
422
 
302
423
  /**
303
424
  * Allowed values for the <code>reset</code> property.
304
425
  * @enum {String}
305
426
  * @readonly
306
427
  */
307
- AdminListQuests200ResponseDataInner['ResetEnum'] = {
428
+ Quest['ResetEnum'] = {
308
429
  /**
309
430
  * value: "never"
310
431
  * @const
@@ -336,4 +457,4 @@ AdminListQuests200ResponseDataInner['ResetEnum'] = {
336
457
  */
337
458
  "repeat": "repeat"
338
459
  };
339
- var _default = exports["default"] = AdminListQuests200ResponseDataInner;
460
+ var _default = exports["default"] = Quest;