@ughuuu/gamend 1.0.0

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 (349) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +862 -0
  3. package/dist/ApiClient.js +703 -0
  4. package/dist/api/AchievementsApi.js +224 -0
  5. package/dist/api/AdminAchievementsApi.js +356 -0
  6. package/dist/api/AdminAnalyticsApi.js +237 -0
  7. package/dist/api/AdminChatApi.js +770 -0
  8. package/dist/api/AdminEconomyApi.js +327 -0
  9. package/dist/api/AdminGroupsApi.js +193 -0
  10. package/dist/api/AdminKVApi.js +305 -0
  11. package/dist/api/AdminLeaderboardsApi.js +490 -0
  12. package/dist/api/AdminLobbiesApi.js +190 -0
  13. package/dist/api/AdminMatchmakingApi.js +165 -0
  14. package/dist/api/AdminNotificationsApi.js +179 -0
  15. package/dist/api/AdminPushApi.js +179 -0
  16. package/dist/api/AdminQuestsApi.js +512 -0
  17. package/dist/api/AdminReadyChecksApi.js +169 -0
  18. package/dist/api/AdminRetentionApi.js +110 -0
  19. package/dist/api/AdminSessionsApi.js +165 -0
  20. package/dist/api/AdminStorageApi.js +212 -0
  21. package/dist/api/AdminTournamentsApi.js +468 -0
  22. package/dist/api/AdminUsersApi.js +130 -0
  23. package/dist/api/AuthenticationApi.js +556 -0
  24. package/dist/api/ChatApi.js +779 -0
  25. package/dist/api/ClientLogsApi.js +119 -0
  26. package/dist/api/EconomyApi.js +153 -0
  27. package/dist/api/FriendsApi.js +528 -0
  28. package/dist/api/GroupsApi.js +1105 -0
  29. package/dist/api/HealthApi.js +78 -0
  30. package/dist/api/HooksApi.js +114 -0
  31. package/dist/api/KVApi.js +95 -0
  32. package/dist/api/LeaderboardsApi.js +342 -0
  33. package/dist/api/LobbiesApi.js +495 -0
  34. package/dist/api/MatchmakingApi.js +187 -0
  35. package/dist/api/NotificationsApi.js +169 -0
  36. package/dist/api/PartiesApi.js +605 -0
  37. package/dist/api/PaymentsApi.js +377 -0
  38. package/dist/api/PushApi.js +166 -0
  39. package/dist/api/QuestsApi.js +270 -0
  40. package/dist/api/ReadyChecksApi.js +258 -0
  41. package/dist/api/SignalingApi.js +78 -0
  42. package/dist/api/StatsApi.js +78 -0
  43. package/dist/api/TimeApi.js +78 -0
  44. package/dist/api/TournamentsApi.js +394 -0
  45. package/dist/api/UsersApi.js +423 -0
  46. package/dist/gamend_proto.js +444 -0
  47. package/dist/gamend_realtime.pb.js +3145 -0
  48. package/dist/index.js +2090 -0
  49. package/dist/model/AcceptPartyInvite200Response.js +168 -0
  50. package/dist/model/AcceptPartyInvite200ResponseMembersInner.js +150 -0
  51. package/dist/model/AcceptPartyInviteRequest.js +113 -0
  52. package/dist/model/AdminCancelMatchmakingTicket200Response.js +91 -0
  53. package/dist/model/AdminCancelReadyCheck200Response.js +91 -0
  54. package/dist/model/AdminCancelReadyCheck200ResponseData.js +223 -0
  55. package/dist/model/AdminConsumeItem400Response.js +89 -0
  56. package/dist/model/AdminCreateAchievementRequest.js +182 -0
  57. package/dist/model/AdminCreateChatFilterWordRequest.js +194 -0
  58. package/dist/model/AdminCreateChatMute200Response.js +91 -0
  59. package/dist/model/AdminCreateChatMuteRequest.js +189 -0
  60. package/dist/model/AdminCreateKvEntry200Response.js +91 -0
  61. package/dist/model/AdminCreateKvEntryRequest.js +146 -0
  62. package/dist/model/AdminCreateLeaderboard200Response.js +91 -0
  63. package/dist/model/AdminCreateLeaderboard200ResponseData.js +248 -0
  64. package/dist/model/AdminCreateLeaderboardRequest.js +244 -0
  65. package/dist/model/AdminCreateNotification400Response.js +89 -0
  66. package/dist/model/AdminCreateNotificationRequest.js +165 -0
  67. package/dist/model/AdminCreateQuestRequest.js +350 -0
  68. package/dist/model/AdminCreateQuestRequestObjectivesInner.js +128 -0
  69. package/dist/model/AdminCreateQuestRequestRewardsInner.js +152 -0
  70. package/dist/model/AdminDeleteChatConversation200Response.js +91 -0
  71. package/dist/model/AdminDeleteChatConversation200ResponseData.js +85 -0
  72. package/dist/model/AdminDeleteChatFilterWordsByLang200Response.js +93 -0
  73. package/dist/model/AdminDrawTournament200Response.js +91 -0
  74. package/dist/model/AdminDrawTournament200ResponseData.js +310 -0
  75. package/dist/model/AdminEndLeaderboard200Response.js +91 -0
  76. package/dist/model/AdminEndLeaderboard200ResponseData.js +231 -0
  77. package/dist/model/AdminGetAnalyticsCounts200Response.js +143 -0
  78. package/dist/model/AdminGetAnalyticsCounts200ResponseTotalsInner.js +97 -0
  79. package/dist/model/AdminGetAnalyticsDaily200Response.js +119 -0
  80. package/dist/model/AdminGetAnalyticsDaily200ResponseSeriesInner.js +128 -0
  81. package/dist/model/AdminGetAnalyticsEconomy200Response.js +150 -0
  82. package/dist/model/AdminGetAnalyticsEconomy200ResponseFlowInner.js +133 -0
  83. package/dist/model/AdminGetAnalyticsEconomy200ResponseTotalsInner.js +133 -0
  84. package/dist/model/AdminGetAnalyticsSummary200Response.js +179 -0
  85. package/dist/model/AdminGrantAchievementRequest.js +126 -0
  86. package/dist/model/AdminGrantItemRequest.js +136 -0
  87. package/dist/model/AdminImportChatFilterWords200Response.js +93 -0
  88. package/dist/model/AdminImportChatFilterWordsRequest.js +150 -0
  89. package/dist/model/AdminIncrementAchievementRequest.js +134 -0
  90. package/dist/model/AdminListAchievements200Response.js +118 -0
  91. package/dist/model/AdminListAchievements200ResponseDataInner.js +185 -0
  92. package/dist/model/AdminListChatFilterWords200Response.js +136 -0
  93. package/dist/model/AdminListChatMessages200Response.js +124 -0
  94. package/dist/model/AdminListChatMessages200ResponseDataInner.js +213 -0
  95. package/dist/model/AdminListChatMutes200Response.js +124 -0
  96. package/dist/model/AdminListChatMutes200ResponseDataInner.js +226 -0
  97. package/dist/model/AdminListChatReports200Response.js +124 -0
  98. package/dist/model/AdminListGroups200Response.js +124 -0
  99. package/dist/model/AdminListKvEntries200Response.js +124 -0
  100. package/dist/model/AdminListKvEntries200ResponseDataInner.js +147 -0
  101. package/dist/model/AdminListLobbies200Response.js +124 -0
  102. package/dist/model/AdminListLobbies200ResponseDataInner.js +191 -0
  103. package/dist/model/AdminListMatchmakingTickets200Response.js +124 -0
  104. package/dist/model/AdminListMatchmakingTickets200ResponseDataInner.js +196 -0
  105. package/dist/model/AdminListNotifications200Response.js +124 -0
  106. package/dist/model/AdminListNotifications200ResponseDataInner.js +173 -0
  107. package/dist/model/AdminListNotifications200ResponseMeta.js +125 -0
  108. package/dist/model/AdminListPushTokens200Response.js +118 -0
  109. package/dist/model/AdminListPushTokens200ResponseDataInner.js +226 -0
  110. package/dist/model/AdminListQuestProgress200Response.js +118 -0
  111. package/dist/model/AdminListQuestProgress200ResponseDataInner.js +208 -0
  112. package/dist/model/AdminListQuests200Response.js +118 -0
  113. package/dist/model/AdminListQuests200ResponseDataInner.js +339 -0
  114. package/dist/model/AdminListReadyChecks200Response.js +124 -0
  115. package/dist/model/AdminListSessions200Response.js +124 -0
  116. package/dist/model/AdminListSessions200ResponseDataInner.js +141 -0
  117. package/dist/model/AdminListStorageObjects200Response.js +132 -0
  118. package/dist/model/AdminListStorageObjects200ResponseDataInner.js +105 -0
  119. package/dist/model/AdminListStorageObjects200ResponseUsage.js +93 -0
  120. package/dist/model/AdminMatchmakingStats200Response.js +91 -0
  121. package/dist/model/AdminMatchmakingStats200ResponseData.js +113 -0
  122. package/dist/model/AdminResetQuestRequest.js +127 -0
  123. package/dist/model/AdminResolveChatReport200Response.js +91 -0
  124. package/dist/model/AdminResolveChatReport200ResponseData.js +274 -0
  125. package/dist/model/AdminResolveChatReportRequest.js +153 -0
  126. package/dist/model/AdminResolveTournamentMatchRequest.js +90 -0
  127. package/dist/model/AdminRevokeAchievementRequest.js +126 -0
  128. package/dist/model/AdminRunRetention200Response.js +104 -0
  129. package/dist/model/AdminSendPushRequest.js +190 -0
  130. package/dist/model/AdminSetQuestIconRequest.js +112 -0
  131. package/dist/model/AdminSpendCurrencyRequest.js +160 -0
  132. package/dist/model/AdminSubmitLeaderboardScore200Response.js +91 -0
  133. package/dist/model/AdminSubmitLeaderboardScore200ResponseData.js +141 -0
  134. package/dist/model/AdminSubmitLeaderboardScoreRequest.js +142 -0
  135. package/dist/model/AdminTestChatPhrase200Response.js +91 -0
  136. package/dist/model/AdminTestChatPhrase200ResponseData.js +187 -0
  137. package/dist/model/AdminTestChatPhrase200ResponseDataHitsInner.js +113 -0
  138. package/dist/model/AdminTestChatPhraseRequest.js +112 -0
  139. package/dist/model/AdminTournamentIconUploadUrlRequest.js +112 -0
  140. package/dist/model/AdminUpdateAchievementRequest.js +145 -0
  141. package/dist/model/AdminUpdateChatFilterWord200Response.js +91 -0
  142. package/dist/model/AdminUpdateChatFilterWord200ResponseData.js +195 -0
  143. package/dist/model/AdminUpdateChatFilterWordRequest.js +166 -0
  144. package/dist/model/AdminUpdateGroup200Response.js +199 -0
  145. package/dist/model/AdminUpdateGroupRequest.js +138 -0
  146. package/dist/model/AdminUpdateKvEntryRequest.js +129 -0
  147. package/dist/model/AdminUpdateLeaderboardRecord200Response.js +91 -0
  148. package/dist/model/AdminUpdateLeaderboardRecord200ResponseData.js +165 -0
  149. package/dist/model/AdminUpdateLeaderboardRecordRequest.js +93 -0
  150. package/dist/model/AdminUpdateLeaderboardRequest.js +137 -0
  151. package/dist/model/AdminUpdateLobby200Response.js +91 -0
  152. package/dist/model/AdminUpdateLobbyRequest.js +142 -0
  153. package/dist/model/AdminUpdateTournamentRequest.js +266 -0
  154. package/dist/model/AdminUpdateUser200Response.js +91 -0
  155. package/dist/model/AdminUpdateUser200ResponseData.js +193 -0
  156. package/dist/model/AdminUpdateUserRequest.js +113 -0
  157. package/dist/model/AdminUpsertKv200Response.js +91 -0
  158. package/dist/model/AdminUpsertKv200ResponseData.js +159 -0
  159. package/dist/model/AdminUpsertKvRequest.js +154 -0
  160. package/dist/model/ApproveJoinRequest200Response.js +205 -0
  161. package/dist/model/CallHook200Response.js +88 -0
  162. package/dist/model/CallHookRequest.js +140 -0
  163. package/dist/model/CancelGroupInvite200Response.js +89 -0
  164. package/dist/model/CancelJoinRequest200Response.js +181 -0
  165. package/dist/model/CancelPartyInviteRequest.js +113 -0
  166. package/dist/model/ChatUnreadCount200Response.js +91 -0
  167. package/dist/model/ChatUnreadCount200ResponseData.js +85 -0
  168. package/dist/model/ClaimQuest200Response.js +91 -0
  169. package/dist/model/ClaimQuest200ResponseData.js +124 -0
  170. package/dist/model/ClientLogBatch.js +148 -0
  171. package/dist/model/ClientLogEntry.js +217 -0
  172. package/dist/model/ClientLogPolicy.js +193 -0
  173. package/dist/model/ClientLogResult.js +146 -0
  174. package/dist/model/ClientLogSession.js +256 -0
  175. package/dist/model/CreateCurrentUserAvatarUploadUrlRequest.js +124 -0
  176. package/dist/model/CreateFriendRequestRequest.js +113 -0
  177. package/dist/model/CreateGroupRequest.js +203 -0
  178. package/dist/model/CreateLobby401Response.js +89 -0
  179. package/dist/model/CreateLobbyRequest.js +155 -0
  180. package/dist/model/CreatePartyRequest.js +98 -0
  181. package/dist/model/DeclineGroupInvite200Response.js +89 -0
  182. package/dist/model/DeclinePartyInviteRequest.js +113 -0
  183. package/dist/model/DeleteNotifications200Response.js +91 -0
  184. package/dist/model/DeleteNotifications200ResponseData.js +86 -0
  185. package/dist/model/DeleteNotificationsRequest.js +113 -0
  186. package/dist/model/DeletePushToken200Response.js +210 -0
  187. package/dist/model/DemoteGroupMemberRequest.js +113 -0
  188. package/dist/model/DeviceLoginRequest.js +113 -0
  189. package/dist/model/ErrorResponse.js +114 -0
  190. package/dist/model/GameServerWebApiV1TournamentControllerIndex200Response.js +110 -0
  191. package/dist/model/GameServerWebApiV1TournamentControllerIndex200ResponseDataInner.js +258 -0
  192. package/dist/model/GameServerWebApiV1TournamentControllerMyMatch200Response.js +173 -0
  193. package/dist/model/GetCurrentUser200Response.js +214 -0
  194. package/dist/model/GetCurrentUser200ResponseLinkedProviders.js +126 -0
  195. package/dist/model/GetCurrentUserInventory200Response.js +87 -0
  196. package/dist/model/GetKv200Response.js +93 -0
  197. package/dist/model/GetLobby200Response.js +133 -0
  198. package/dist/model/GetMyReadyCheck200Response.js +105 -0
  199. package/dist/model/GetMyReadyCheck200ResponseLobby.js +257 -0
  200. package/dist/model/GetMyReadyCheck200ResponseParty.js +257 -0
  201. package/dist/model/GetMyRecord200Response.js +91 -0
  202. package/dist/model/GetMyRecord200ResponseData.js +151 -0
  203. package/dist/model/GetServerTime200Response.js +86 -0
  204. package/dist/model/GetStats200Response.js +91 -0
  205. package/dist/model/GetStats200ResponseData.js +151 -0
  206. package/dist/model/HealthResponse.js +129 -0
  207. package/dist/model/InviteToGroup200Response.js +90 -0
  208. package/dist/model/InviteToGroupRequest.js +113 -0
  209. package/dist/model/InviteToPartyRequest.js +113 -0
  210. package/dist/model/JoinLobby200Response.js +89 -0
  211. package/dist/model/JoinLobbyRequest.js +90 -0
  212. package/dist/model/JoinPartyByCodeRequest.js +113 -0
  213. package/dist/model/KickGroupMemberRequest.js +113 -0
  214. package/dist/model/KickPartyMemberRequest.js +113 -0
  215. package/dist/model/KickUser200Response.js +89 -0
  216. package/dist/model/KickUserRequest.js +109 -0
  217. package/dist/model/LeaveLobby200Response.js +89 -0
  218. package/dist/model/LinkDeviceRequest.js +112 -0
  219. package/dist/model/ListAuthProviders200Response.js +122 -0
  220. package/dist/model/ListBlacklistedUsers200Response.js +118 -0
  221. package/dist/model/ListBlacklistedUsers200ResponseDataInner.js +113 -0
  222. package/dist/model/ListBlockedFriends200Response.js +124 -0
  223. package/dist/model/ListBlockedFriends200ResponseDataInner.js +103 -0
  224. package/dist/model/ListBlockedFriends200ResponseDataInnerRequester.js +113 -0
  225. package/dist/model/ListChatMessages200Response.js +118 -0
  226. package/dist/model/ListChatMessages200ResponseDataInner.js +208 -0
  227. package/dist/model/ListCurrentUserLedger200Response.js +118 -0
  228. package/dist/model/ListCurrentUserLedger200ResponseDataInner.js +145 -0
  229. package/dist/model/ListFriendRequests200Response.js +105 -0
  230. package/dist/model/ListFriendRequests200ResponseData.js +139 -0
  231. package/dist/model/ListFriendRequests200ResponseDataIncomingInner.js +140 -0
  232. package/dist/model/ListFriendRequests200ResponseDataIncomingInnerRequester.js +142 -0
  233. package/dist/model/ListFriendRequests200ResponseIncomingInner.js +140 -0
  234. package/dist/model/ListFriendRequests200ResponseIncomingInnerRequester.js +142 -0
  235. package/dist/model/ListFriendRequests200ResponseMeta.js +104 -0
  236. package/dist/model/ListFriends200Response.js +124 -0
  237. package/dist/model/ListFriends200ResponseDataInner.js +164 -0
  238. package/dist/model/ListFriends200ResponseMeta.js +125 -0
  239. package/dist/model/ListGroupInvitations200Response.js +124 -0
  240. package/dist/model/ListGroupInvitations200ResponseDataInner.js +183 -0
  241. package/dist/model/ListGroupMembers200Response.js +124 -0
  242. package/dist/model/ListGroupMembers200ResponseDataInner.js +180 -0
  243. package/dist/model/ListGroupMutes200Response.js +124 -0
  244. package/dist/model/ListGroupMutes200ResponseDataInner.js +193 -0
  245. package/dist/model/ListGroupMutes200ResponseMeta.js +109 -0
  246. package/dist/model/ListJoinRequests200Response.js +124 -0
  247. package/dist/model/ListLeaderboardRecords200Response.js +124 -0
  248. package/dist/model/ListLeaderboardRecords200ResponseDataInner.js +134 -0
  249. package/dist/model/ListLeaderboardRecords200ResponseMeta.js +125 -0
  250. package/dist/model/ListLeaderboards200Response.js +124 -0
  251. package/dist/model/ListLeaderboards200ResponseDataInner.js +247 -0
  252. package/dist/model/ListLobbies200Response.js +124 -0
  253. package/dist/model/ListLobbies200ResponseDataInner.js +192 -0
  254. package/dist/model/ListLobbies200ResponseInner.js +153 -0
  255. package/dist/model/ListLobbies200ResponseMeta.js +125 -0
  256. package/dist/model/ListMyGroups200Response.js +124 -0
  257. package/dist/model/ListMyGroups200ResponseDataInner.js +243 -0
  258. package/dist/model/ListNotifications200Response.js +124 -0
  259. package/dist/model/ListNotifications200ResponseDataInner.js +186 -0
  260. package/dist/model/ListPartyInvitations200ResponseInner.js +171 -0
  261. package/dist/model/ListPushTokens200Response.js +118 -0
  262. package/dist/model/ListRecordsAroundUser200Response.js +110 -0
  263. package/dist/model/ListSentInvitations200Response.js +124 -0
  264. package/dist/model/ListSentInvitations200ResponseDataInner.js +181 -0
  265. package/dist/model/ListTournaments200Response.js +110 -0
  266. package/dist/model/ListTournaments200ResponseDataInner.js +271 -0
  267. package/dist/model/LobbyStats200Response.js +91 -0
  268. package/dist/model/LobbyStats200ResponseData.js +104 -0
  269. package/dist/model/Login200Response.js +91 -0
  270. package/dist/model/Login200ResponseData.js +150 -0
  271. package/dist/model/Login200ResponseDataUser.js +97 -0
  272. package/dist/model/LoginRequest.js +128 -0
  273. package/dist/model/MarkChatReadRequest.js +169 -0
  274. package/dist/model/MatchmakingCancel200Response.js +85 -0
  275. package/dist/model/MatchmakingJoin201Response.js +91 -0
  276. package/dist/model/MatchmakingJoin201ResponseData.js +186 -0
  277. package/dist/model/MatchmakingJoinRequest.js +101 -0
  278. package/dist/model/MatchmakingMyTicket200Response.js +91 -0
  279. package/dist/model/MatchmakingMyTicket200ResponseData.js +186 -0
  280. package/dist/model/MatchmakingStats200Response.js +91 -0
  281. package/dist/model/MatchmakingStats200ResponseData.js +118 -0
  282. package/dist/model/MatchmakingStats200ResponseDataQueuesInner.js +93 -0
  283. package/dist/model/MuteGroupMemberRequest.js +135 -0
  284. package/dist/model/MyAchievements200Response.js +124 -0
  285. package/dist/model/MyAchievements200ResponseDataInner.js +196 -0
  286. package/dist/model/OAuthSessionData.js +153 -0
  287. package/dist/model/OAuthSessionDataDetails.js +128 -0
  288. package/dist/model/OAuthSessionStatus.js +173 -0
  289. package/dist/model/OauthApiCallback200Response.js +91 -0
  290. package/dist/model/OauthApiCallbackRequest.js +90 -0
  291. package/dist/model/OauthCallbackApiAppleIosRequest.js +113 -0
  292. package/dist/model/OauthGoogleIdTokenRequest.js +113 -0
  293. package/dist/model/OauthRequest200Response.js +103 -0
  294. package/dist/model/OauthSessionStatus404Response.js +126 -0
  295. package/dist/model/OpenLobbyReadyCheck201Response.js +256 -0
  296. package/dist/model/OpenLobbyReadyCheckRequest.js +95 -0
  297. package/dist/model/PartyCreateLobbyRequest.js +139 -0
  298. package/dist/model/PartyJoinLobbyRequest.js +90 -0
  299. package/dist/model/PartyStats200Response.js +91 -0
  300. package/dist/model/PartyStats200ResponseData.js +93 -0
  301. package/dist/model/PaymentsEntitlements401Response.js +89 -0
  302. package/dist/model/PaymentsSteamCheckoutRequest.js +169 -0
  303. package/dist/model/PaymentsSteamFinalizeRequest.js +112 -0
  304. package/dist/model/PaymentsStripeCheckoutRequest.js +133 -0
  305. package/dist/model/PromoteGroupMemberRequest.js +113 -0
  306. package/dist/model/QuestStats200Response.js +91 -0
  307. package/dist/model/QuestStats200ResponseData.js +101 -0
  308. package/dist/model/QuickJoinRequest.js +108 -0
  309. package/dist/model/RefreshToken200Response.js +91 -0
  310. package/dist/model/RefreshToken200ResponseData.js +151 -0
  311. package/dist/model/RefreshTokenRequest.js +113 -0
  312. package/dist/model/RegisterPushTokenRequest.js +199 -0
  313. package/dist/model/RemoveFriendship401Response.js +89 -0
  314. package/dist/model/ReportChatMessageRequest.js +90 -0
  315. package/dist/model/ResolveLeaderboardSlugs200Response.js +89 -0
  316. package/dist/model/ResolveLeaderboardSlugs200ResponseDataValue.js +264 -0
  317. package/dist/model/ResolveLeaderboardSlugsRequest.js +113 -0
  318. package/dist/model/RespondReadyCheckRequest.js +140 -0
  319. package/dist/model/SearchUsers200Response.js +124 -0
  320. package/dist/model/SearchUsers200ResponseDataInner.js +168 -0
  321. package/dist/model/SendChatMessageRequest.js +180 -0
  322. package/dist/model/SendNotificationRequest.js +163 -0
  323. package/dist/model/SetLobbyStateRequest.js +126 -0
  324. package/dist/model/ShowParty200Response.js +160 -0
  325. package/dist/model/ShowParty200ResponseMembersInner.js +137 -0
  326. package/dist/model/SignalingStats200Response.js +91 -0
  327. package/dist/model/SignalingStats200ResponseData.js +101 -0
  328. package/dist/model/TournamentMyMatch200Response.js +173 -0
  329. package/dist/model/UnmuteLobbyMemberRequest.js +113 -0
  330. package/dist/model/UpdateChatMessageRequest.js +99 -0
  331. package/dist/model/UpdateCurrentUserDisplayName400Response.js +97 -0
  332. package/dist/model/UpdateCurrentUserDisplayNameRequest.js +112 -0
  333. package/dist/model/UpdateCurrentUserPassword400Response.js +97 -0
  334. package/dist/model/UpdateCurrentUserPasswordRequest.js +125 -0
  335. package/dist/model/UpdateCurrentUserUsernameRequest.js +112 -0
  336. package/dist/model/UpdateGroupRequest.js +173 -0
  337. package/dist/model/UpdateLobbyRequest.js +161 -0
  338. package/dist/model/UpdatePartyRequest.js +95 -0
  339. package/dist/model/UserQuests200Response.js +124 -0
  340. package/dist/model/UserQuests200ResponseDataInner.js +401 -0
  341. package/dist/model/UserQuests200ResponseDataInnerObjectivesInner.js +108 -0
  342. package/dist/model/UserQuests200ResponseDataInnerProgress.js +159 -0
  343. package/dist/model/UserQuests200ResponseDataInnerRewardsInner.js +130 -0
  344. package/dist/model/UserQuests200ResponseMeta.js +125 -0
  345. package/dist/model/UserStats200Response.js +91 -0
  346. package/dist/model/UserStats200ResponseData.js +117 -0
  347. package/dist/realtime.js +370 -0
  348. package/dist/webrtc.js +541 -0
  349. package/package.json +51 -0
@@ -0,0 +1,703 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _superagent = _interopRequireDefault(require("superagent"));
8
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
9
+ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
10
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
11
+ 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
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
13
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
14
+ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
15
+ * Gamend API
16
+ * API for Gamend. Provides HTTP REST API, real-time WebSocket channels, and WebRTC DataChannels for low-latency game data. Features authentication, users, lobbies, groups, parties, friends, chat, notifications, quests, leaderboards, tournaments, matchmaking, payments, server scripting, and admin portal. ## **1. Authentication** This API uses JWT (JSON Web Tokens) with access and refresh tokens: ### **1.1 Getting Tokens** - **Email/Password**: POST to `/api/v1/login` with email and password - **Device (SDK)**: POST to `/api/v1/login` with a `device_id` string (creates/returns a device user) - **Discord OAuth**: Use `/api/v1/auth/discord` flow - **Google OAuth**: Use `/api/v1/auth/google` flow - **Facebook OAuth**: Use `/api/v1/auth/facebook` flow - **Apple Sign In**: Use `/auth/apple` browser flow or apple sdk flow - **Steam (OpenID)**: Use `/api/v1/auth/steam` flow Both methods return: - `access_token` - Short-lived (15 min), use for API requests - `refresh_token` - Long-lived (30 days), use to get new access tokens ### **1.2 Using Tokens** Include the access token in the Authorization header: ``` Authorization: Bearer <access_token> ``` ### **1.3 Refreshing Tokens** When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token. ## **2. Users** Users endpoints cover the user lifecycle and profile features. Key highlights: - **Registration and login** (email/password, device token for SDKs, and OAuth providers) - **Profile metadata** (JSON blob per user) and editable profile fields - **Account lifecycle**: password reset, email confirmation, and account deletion - **Sessions & tokens**: both browser sessions and JWT-based API tokens are supported ## **3. Friends** The Friends domain offers lightweight social features: - **Friend requests** (send / accept / reject / block flows) - **Friend listing & pagination**, with basic privacy controls - **Domain helpers** to manage and query friend relationships from API or UI contexts ## **4. Lobbies** Lobbies provide matchmaking / room management primitives. Highlights: - **Create / list / update / delete** lobbies with rich metadata (mode, region, tags) - **Host-managed or hostless** modes (hostless allowed internally, not creatable via public API) - **Membership management**: join, leave, kick users, and automatic host transfer - **Controls & protection**: max users, hidden/locked states, and optional password protection - **Hidden lobbies** are excluded from public listings; public listing endpoints are paginated ## **5. Notifications** Persistent user-to-user notifications that survive across sessions: - **Send notifications** to accepted friends with a title, optional content, and optional metadata - **List own notifications** with pagination (ordered oldest-first) - **Delete notifications** by ID (single or batch) - **Real-time delivery** via the user WebSocket channel (`\"notification\"` events) - **Offline delivery**: undeleted notifications are replayed on WebSocket reconnect - **Push delivery**: notifications also fan out to the recipient's registered mobile devices (see Push notifications) ## **5b. Push notifications** Mobile/web push delivery to registered devices (FCM for Android/Web, APNs-direct for iOS): - **Register device tokens** via `POST /me/push_tokens` (`token`, `platform`, optional `provider`/`device_id`); re-registering a `device_id` rotates its token in place - **List/remove own devices** via `GET /me/push_tokens` and `DELETE /me/push_tokens/:id` - **Server-authoritative sending** — no public send endpoint; pushes originate from server hooks (`Gamend.Push.send_to_user/2`) or the admin API - **Per-token routing**: each token's `provider` (\"fcm\" | \"apns\") selects the delivery backend; unconfigured backends log instead of sending (dev-friendly) - **Reliability**: delivery rides the durable job queue with retries; dead tokens reported by the provider are disabled automatically ## **6. Groups** Groups provide persistent community management for players: - **Three group types**: `public` (anyone joins directly), `private` (users request to join, admins approve), `hidden` (invite-only, never listed) - **Membership roles**: `admin` and `member`, with promote/demote capabilities - **Join requests**: for private groups, users submit requests that admins approve or reject - **Invitations**: admins can invite users directly (blocked users are rejected) - **CRUD operations**: create, update, delete groups with metadata support - **Group chat**: integrated via the Chat API with `chat_type: \"group\"` ## **7. Parties** Ephemeral groups of users for short-lived sessions (e.g., matchmaking squads): - **Invite-only joining**: the party leader sends invites by user ID to friends or shared-group members - **Invite flow**: `POST /parties/invite` → recipient accepts via `POST /parties/invite/accept` or declines via `POST /parties/invite/decline`; leader can cancel via `POST /parties/invite/cancel` - **Invite visibility**: leader can list sent invites (`GET /parties/invitations/sent`); recipient can list received invites (`GET /parties/invitations`) - **Connection requirement**: invites can only be sent to users who are friends or share at least one group with the leader - **One party at a time**: a user can only be in one party; accepting an invite while already in a party is rejected - **Leader management**: the creator is the leader; leadership can be transferred - **Lobby integration**: parties can create or join lobbies as a group - **Party chat**: integrated via the Chat API with `chat_type: \"party\"` - **Real-time events** via the party WebSocket channel ## **8. Chat** Real-time messaging across multiple conversation types: - **Chat types**: `lobby` (within a lobby), `group` (within a group), `party` (within a party), `friend` (DMs between friends) - **Send messages** with content, optional metadata, and automatic access validation - **List messages** with pagination (newest first) - **Read tracking**: mark messages as read and get unread counts per conversation - **Real-time delivery** via PubSub and WebSocket channels - **Moderation is built in**: an admin-managed word filter (`block` / `mask` / `flag`, matched on a normalized form so leetspeak and padding do not slip through) and mutes are enforced before a message is stored or broadcast; the `before_chat_message` pipeline hook stays available for rules of your own - **Report a message**: `POST /chat/messages/:id/report` with an optional `reason` — one report per player per message, capped per day; reports the filter files itself have no reporter - **Scoped mutes** mirror kick: `POST /lobbies/mute` + `/lobbies/unmute` (lobby host), `POST /groups/:id/mute` + `/groups/:id/unmute` (group admin), `POST /parties/mute` + `/parties/unmute` (party leader), each with a paginated `.../mutes` listing for the same authority. Body is `{target_user_id, expires_at?, reason?}`; omitting `expires_at` mutes permanently - **Global mutes and the blocklist are server-authoritative** — no public endpoint; admin API (`/api/v1/admin/chat`) or a plugin calling `Gamend.Chat.mute_user/4` - **Real-time moderation events**: the muted player receives `chat_muted` / `chat_unmuted` on their user channel ## **9. Leaderboards** Server-managed ranked scoreboards: - **Multiple leaderboards**: create named leaderboards with configurable sort order - **Score submission**: submit scores with optional metadata - **Rankings**: retrieve paginated rankings with user details - **Reset support**: leaderboards can be reset periodically ## **10. Key-Value Storage** Per-user persistent key-value storage for game state, preferences, and settings: - **Get/set/delete** key-value pairs scoped to the authenticated user - **List keys** with optional prefix filtering - **Metadata support**: values can include arbitrary JSON metadata ## **11. Quests / Progression** One event-driven progression engine covering achievements, daily/weekly quests, time-boxed event quests, chains, and groups: - **Kinds**: `achievement` (permanent one-shot — the replacement for the old achievements system), `daily`/`weekly` (reset per UTC period), `event` (starts_at/ends_at window), `chain` (requires a prerequisite quest) - **Objectives**: each quest lists objectives `{event, target, params}`; server-side `report_event` advances every matching active quest — there is **no public endpoint to advance progress** (server-authoritative) - **Rewards**: currencies (Economy) and items (Inventory), paid **exactly once** per period via idempotent grants; `auto_claim` quests pay on completion, others via `POST /me/quests/:key/claim` - **My quests**: `GET /me/quests` returns active quests, per-period progress, and a claimable flag; hidden quests appear once completed - **Groups**: quests sharing a `group_key` collapse to one entry carrying `group_size`; `?group=<key>` lists that group's members in full - **Catalog**: `GET /quests` and per-user completions `GET /quests/user/:user_id` (gated by `LIST_QUESTS_ENABLED`) - **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)) ``` Requires the `phoenix` npm package as a peer dependency: `npm install phoenix` ## **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
+ *
18
+ * The version of the OpenAPI document: 1.0.0
19
+ *
20
+ *
21
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
22
+ * https://openapi-generator.tech
23
+ * Do not edit the class manually.
24
+ *
25
+ */
26
+ /**
27
+ * @module ApiClient
28
+ * @version 1.0.0
29
+ */
30
+ /**
31
+ * Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
32
+ * application to use this class directly - the *Api and model classes provide the public API for the service. The
33
+ * contents of this file should be regarded as internal but are documented for completeness.
34
+ * @alias module:ApiClient
35
+ * @class
36
+ */
37
+ var ApiClient = /*#__PURE__*/function () {
38
+ /**
39
+ * The base URL against which to resolve every API call's (relative) path.
40
+ * Overrides the default value set in spec file if present
41
+ * @param {String} basePath
42
+ */
43
+ function ApiClient() {
44
+ var basePath = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'http://localhost:4000';
45
+ _classCallCheck(this, ApiClient);
46
+ /**
47
+ * The base URL against which to resolve every API call's (relative) path.
48
+ * @type {String}
49
+ * @default http://localhost:4000
50
+ */
51
+ this.basePath = basePath.replace(/\/+$/, '');
52
+
53
+ /**
54
+ * The authentication methods to be included for all API calls.
55
+ * @type {Array.<String>}
56
+ */
57
+ this.authentications = {
58
+ 'authorization': {
59
+ type: 'bearer'
60
+ } // JWT
61
+ };
62
+
63
+ /**
64
+ * The default HTTP headers to be included for all API calls.
65
+ * @type {Array.<String>}
66
+ * @default {}
67
+ */
68
+ this.defaultHeaders = {
69
+ 'User-Agent': 'OpenAPI-Generator/1.0.0/Javascript'
70
+ };
71
+
72
+ /**
73
+ * The default HTTP timeout for all API calls.
74
+ * @type {Number}
75
+ * @default 60000
76
+ */
77
+ this.timeout = 60000;
78
+
79
+ /**
80
+ * If set to false an additional timestamp parameter is added to all API GET calls to
81
+ * prevent browser caching
82
+ * @type {Boolean}
83
+ * @default true
84
+ */
85
+ this.cache = true;
86
+
87
+ /**
88
+ * If set to true, the client will save the cookies from each server
89
+ * response, and return them in the next request.
90
+ * @default false
91
+ */
92
+ this.enableCookies = false;
93
+
94
+ /*
95
+ * Used to save and return cookies in a node.js (non-browser) setting,
96
+ * if this.enableCookies is set to true.
97
+ */
98
+ if (typeof window === 'undefined') {
99
+ this.agent = new _superagent["default"].agent();
100
+ }
101
+
102
+ /*
103
+ * Allow user to override superagent agent
104
+ */
105
+ this.requestAgent = null;
106
+
107
+ /*
108
+ * Allow user to add superagent plugins
109
+ */
110
+ this.plugins = null;
111
+ }
112
+
113
+ /**
114
+ * Returns a string representation for an actual parameter.
115
+ * @param param The actual parameter.
116
+ * @returns {String} The string representation of <code>param</code>.
117
+ */
118
+ return _createClass(ApiClient, [{
119
+ key: "paramToString",
120
+ value: function paramToString(param) {
121
+ if (param == undefined || param == null) {
122
+ return '';
123
+ }
124
+ if (param instanceof Date) {
125
+ return param.toJSON();
126
+ }
127
+ if (ApiClient.canBeJsonified(param)) {
128
+ return JSON.stringify(param);
129
+ }
130
+ return param.toString();
131
+ }
132
+
133
+ /**
134
+ * Returns a boolean indicating if the parameter could be JSON.stringified
135
+ * @param param The actual parameter
136
+ * @returns {Boolean} Flag indicating if <code>param</code> can be JSON.stringified
137
+ */
138
+ }, {
139
+ key: "buildUrl",
140
+ value:
141
+ /**
142
+ * Builds full URL by appending the given path to the base URL and replacing path parameter place-holders with parameter values.
143
+ * NOTE: query parameters are not handled here.
144
+ * @param {String} path The path to append to the base URL.
145
+ * @param {Object} pathParams The parameter values to append.
146
+ * @param {String} apiBasePath Base path defined in the path, operation level to override the default one
147
+ * @returns {String} The encoded path with parameter values substituted.
148
+ */
149
+ function buildUrl(path, pathParams, apiBasePath) {
150
+ var _this = this;
151
+ if (!path.match(/^\//)) {
152
+ path = '/' + path;
153
+ }
154
+ var url = this.basePath + path;
155
+
156
+ // use API (operation, path) base path if defined
157
+ if (apiBasePath !== null && apiBasePath !== undefined) {
158
+ url = apiBasePath + path;
159
+ }
160
+ url = url.replace(/\{([\w-\.#]+)\}/g, function (fullMatch, key) {
161
+ var value;
162
+ if (pathParams.hasOwnProperty(key)) {
163
+ value = _this.paramToString(pathParams[key]);
164
+ } else {
165
+ value = fullMatch;
166
+ }
167
+ return encodeURIComponent(value);
168
+ });
169
+ return url;
170
+ }
171
+
172
+ /**
173
+ * Checks whether the given content type represents JSON.<br>
174
+ * JSON content type examples:<br>
175
+ * <ul>
176
+ * <li>application/json</li>
177
+ * <li>application/json; charset=UTF8</li>
178
+ * <li>APPLICATION/JSON</li>
179
+ * </ul>
180
+ * @param {String} contentType The MIME content type to check.
181
+ * @returns {Boolean} <code>true</code> if <code>contentType</code> represents JSON, otherwise <code>false</code>.
182
+ */
183
+ }, {
184
+ key: "isJsonMime",
185
+ value: function isJsonMime(contentType) {
186
+ return Boolean(contentType != null && contentType.match(/^application\/json(;.*)?$/i));
187
+ }
188
+
189
+ /**
190
+ * Chooses a content type from the given array, with JSON preferred; i.e. return JSON if included, otherwise return the first.
191
+ * @param {Array.<String>} contentTypes
192
+ * @returns {String} The chosen content type, preferring JSON.
193
+ */
194
+ }, {
195
+ key: "jsonPreferredMime",
196
+ value: function jsonPreferredMime(contentTypes) {
197
+ for (var i = 0; i < contentTypes.length; i++) {
198
+ if (this.isJsonMime(contentTypes[i])) {
199
+ return contentTypes[i];
200
+ }
201
+ }
202
+ return contentTypes[0];
203
+ }
204
+
205
+ /**
206
+ * Checks whether the given parameter value represents file-like content.
207
+ * @param param The parameter to check.
208
+ * @returns {Boolean} <code>true</code> if <code>param</code> represents a file.
209
+ */
210
+ }, {
211
+ key: "isFileParam",
212
+ value: function isFileParam(param) {
213
+ // fs.ReadStream in Node.js and Electron (but not in runtime like browserify)
214
+ if (typeof require === 'function') {
215
+ var fs;
216
+ try {
217
+ fs = require('fs');
218
+ } catch (err) {}
219
+ if (fs && fs.ReadStream && param instanceof fs.ReadStream) {
220
+ return true;
221
+ }
222
+ }
223
+
224
+ // Buffer in Node.js
225
+ if (typeof Buffer === 'function' && param instanceof Buffer) {
226
+ return true;
227
+ }
228
+
229
+ // Blob in browser
230
+ if (typeof Blob === 'function' && param instanceof Blob) {
231
+ return true;
232
+ }
233
+
234
+ // File in browser (it seems File object is also instance of Blob, but keep this for safe)
235
+ if (typeof File === 'function' && param instanceof File) {
236
+ return true;
237
+ }
238
+ return false;
239
+ }
240
+
241
+ /**
242
+ * Normalizes parameter values:
243
+ * <ul>
244
+ * <li>remove nils</li>
245
+ * <li>keep files and arrays</li>
246
+ * <li>format to string with `paramToString` for other cases</li>
247
+ * </ul>
248
+ * @param {Object.<String, Object>} params The parameters as object properties.
249
+ * @returns {Object.<String, Object>} normalized parameters.
250
+ */
251
+ }, {
252
+ key: "normalizeParams",
253
+ value: function normalizeParams(params) {
254
+ var newParams = {};
255
+ for (var key in params) {
256
+ if (params.hasOwnProperty(key) && params[key] != undefined && params[key] != null) {
257
+ var value = params[key];
258
+ if (this.isFileParam(value) || Array.isArray(value)) {
259
+ newParams[key] = value;
260
+ } else {
261
+ newParams[key] = this.paramToString(value);
262
+ }
263
+ }
264
+ }
265
+ return newParams;
266
+ }
267
+
268
+ /**
269
+ * Builds a string representation of an array-type actual parameter, according to the given collection format.
270
+ * @param {Array} param An array parameter.
271
+ * @param {module:ApiClient.CollectionFormatEnum} collectionFormat The array element separator strategy.
272
+ * @returns {String|Array} A string representation of the supplied collection, using the specified delimiter. Returns
273
+ * <code>param</code> as is if <code>collectionFormat</code> is <code>multi</code>.
274
+ */
275
+ }, {
276
+ key: "buildCollectionParam",
277
+ value: function buildCollectionParam(param, collectionFormat) {
278
+ if (param == null) {
279
+ return null;
280
+ }
281
+ switch (collectionFormat) {
282
+ case 'csv':
283
+ return param.map(this.paramToString, this).join(',');
284
+ case 'ssv':
285
+ return param.map(this.paramToString, this).join(' ');
286
+ case 'tsv':
287
+ return param.map(this.paramToString, this).join('\t');
288
+ case 'pipes':
289
+ return param.map(this.paramToString, this).join('|');
290
+ case 'multi':
291
+ //return the array directly as SuperAgent will handle it as expected
292
+ return param.map(this.paramToString, this);
293
+ case 'passthrough':
294
+ return param;
295
+ default:
296
+ throw new Error('Unknown collection format: ' + collectionFormat);
297
+ }
298
+ }
299
+
300
+ /**
301
+ * Applies authentication headers to the request.
302
+ * @param {Object} request The request object created by a <code>superagent()</code> call.
303
+ * @param {Array.<String>} authNames An array of authentication method names.
304
+ */
305
+ }, {
306
+ key: "applyAuthToRequest",
307
+ value: function applyAuthToRequest(request, authNames) {
308
+ var _this2 = this;
309
+ authNames.forEach(function (authName) {
310
+ var auth = _this2.authentications[authName];
311
+ switch (auth.type) {
312
+ case 'basic':
313
+ if (auth.username || auth.password) {
314
+ request.auth(auth.username || '', auth.password || '');
315
+ }
316
+ break;
317
+ case 'bearer':
318
+ if (auth.accessToken) {
319
+ var localVarBearerToken = typeof auth.accessToken === 'function' ? auth.accessToken() : auth.accessToken;
320
+ request.set({
321
+ 'Authorization': 'Bearer ' + localVarBearerToken
322
+ });
323
+ }
324
+ break;
325
+ case 'apiKey':
326
+ if (auth.apiKey) {
327
+ var data = {};
328
+ if (auth.apiKeyPrefix) {
329
+ data[auth.name] = auth.apiKeyPrefix + ' ' + auth.apiKey;
330
+ } else {
331
+ data[auth.name] = auth.apiKey;
332
+ }
333
+ if (auth['in'] === 'header') {
334
+ request.set(data);
335
+ } else {
336
+ request.query(data);
337
+ }
338
+ }
339
+ break;
340
+ case 'oauth2':
341
+ if (auth.accessToken) {
342
+ request.set({
343
+ 'Authorization': 'Bearer ' + auth.accessToken
344
+ });
345
+ }
346
+ break;
347
+ default:
348
+ throw new Error('Unknown authentication type: ' + auth.type);
349
+ }
350
+ });
351
+ }
352
+
353
+ /**
354
+ * Deserializes an HTTP response body into a value of the specified type.
355
+ * @param {Object} response A SuperAgent response object.
356
+ * @param {(String|Array.<String>|Object.<String, Object>|Function)} returnType The type to return. Pass a string for simple types
357
+ * or the constructor function for a complex type. Pass an array containing the type name to return an array of that type. To
358
+ * return an object, pass an object with one property whose name is the key type and whose value is the corresponding value type:
359
+ * all properties on <code>data<code> will be converted to this type.
360
+ * @returns A value of the specified type.
361
+ */
362
+ }, {
363
+ key: "deserialize",
364
+ value: function deserialize(response, returnType) {
365
+ if (response == null || returnType == null || response.status == 204) {
366
+ return null;
367
+ }
368
+
369
+ // Rely on SuperAgent for parsing response body.
370
+ // See http://visionmedia.github.io/superagent/#parsing-response-bodies
371
+ var data = response.body;
372
+ if (data == null || _typeof(data) === 'object' && typeof data.length === 'undefined' && !Object.keys(data).length) {
373
+ // SuperAgent does not always produce a body; use the unparsed response as a fallback
374
+ data = response.text;
375
+ }
376
+ return ApiClient.convertToType(data, returnType);
377
+ }
378
+
379
+ /**
380
+ * Invokes the REST service using the supplied settings and parameters.
381
+ * @param {String} path The base URL to invoke.
382
+ * @param {String} httpMethod The HTTP method to use.
383
+ * @param {Object.<String, String>} pathParams A map of path parameters and their values.
384
+ * @param {Object.<String, Object>} queryParams A map of query parameters and their values.
385
+ * @param {Object.<String, Object>} headerParams A map of header parameters and their values.
386
+ * @param {Object.<String, Object>} formParams A map of form parameters and their values.
387
+ * @param {Object} bodyParam The value to pass as the request body.
388
+ * @param {Array.<String>} authNames An array of authentication type names.
389
+ * @param {Array.<String>} contentTypes An array of request MIME types.
390
+ * @param {Array.<String>} accepts An array of acceptable response MIME types.
391
+ * @param {(String|Array|ObjectFunction)} returnType The required type to return; can be a string for simple types or the
392
+ * constructor for a complex type.
393
+ * @param {String} apiBasePath base path defined in the operation/path level to override the default one
394
+ * @returns {Promise} A {@link https://www.promisejs.org/|Promise} object.
395
+ */
396
+ }, {
397
+ key: "callApi",
398
+ value: function callApi(path, httpMethod, pathParams, queryParams, headerParams, formParams, bodyParam, authNames, contentTypes, accepts, returnType, apiBasePath) {
399
+ var _this3 = this;
400
+ var url = this.buildUrl(path, pathParams, apiBasePath);
401
+ var request = (0, _superagent["default"])(httpMethod, url);
402
+ if (this.plugins !== null) {
403
+ for (var index in this.plugins) {
404
+ if (this.plugins.hasOwnProperty(index)) {
405
+ request.use(this.plugins[index]);
406
+ }
407
+ }
408
+ }
409
+
410
+ // apply authentications
411
+ this.applyAuthToRequest(request, authNames);
412
+
413
+ // set query parameters
414
+ if (httpMethod.toUpperCase() === 'GET' && this.cache === false) {
415
+ queryParams['_'] = new Date().getTime();
416
+ }
417
+ request.query(this.normalizeParams(queryParams));
418
+
419
+ // set header parameters
420
+ request.set(this.defaultHeaders).set(this.normalizeParams(headerParams));
421
+
422
+ // set requestAgent if it is set by user
423
+ if (this.requestAgent) {
424
+ request.agent(this.requestAgent);
425
+ }
426
+
427
+ // set request timeout
428
+ request.timeout(this.timeout);
429
+ var contentType = this.jsonPreferredMime(contentTypes);
430
+ if (contentType) {
431
+ // Issue with superagent and multipart/form-data (https://github.com/visionmedia/superagent/issues/746)
432
+ if (contentType != 'multipart/form-data') {
433
+ request.type(contentType);
434
+ }
435
+ }
436
+ if (contentType === 'application/x-www-form-urlencoded') {
437
+ var normalizedParams = this.normalizeParams(formParams);
438
+ var urlSearchParams = new URLSearchParams(normalizedParams);
439
+ var queryString = urlSearchParams.toString();
440
+ request.send(queryString);
441
+ } else if (contentType == 'multipart/form-data') {
442
+ var _formParams = this.normalizeParams(formParams);
443
+ for (var key in _formParams) {
444
+ if (_formParams.hasOwnProperty(key)) {
445
+ var _formParamsValue = _formParams[key];
446
+ if (this.isFileParam(_formParamsValue)) {
447
+ // file field
448
+ request.attach(key, _formParamsValue);
449
+ } else if (Array.isArray(_formParamsValue) && _formParamsValue.length && this.isFileParam(_formParamsValue[0])) {
450
+ // multiple files
451
+ _formParamsValue.forEach(function (file) {
452
+ return request.attach(key, file);
453
+ });
454
+ } else {
455
+ request.field(key, _formParamsValue);
456
+ }
457
+ }
458
+ }
459
+ } else if (bodyParam !== null && bodyParam !== undefined) {
460
+ if (!request.header['Content-Type']) {
461
+ request.type('application/json');
462
+ }
463
+ request.send(bodyParam);
464
+ }
465
+ var accept = this.jsonPreferredMime(accepts);
466
+ if (accept) {
467
+ request.accept(accept);
468
+ }
469
+ if (returnType === 'Blob') {
470
+ request.responseType('blob');
471
+ } else if (returnType === 'String') {
472
+ request.responseType('text');
473
+ }
474
+
475
+ // Attach previously saved cookies, if enabled
476
+ if (this.enableCookies) {
477
+ if (typeof window === 'undefined') {
478
+ this.agent._attachCookies(request);
479
+ } else {
480
+ request.withCredentials();
481
+ }
482
+ }
483
+ return new Promise(function (resolve, reject) {
484
+ request.end(function (error, response) {
485
+ if (error) {
486
+ var err = {};
487
+ if (response) {
488
+ err.status = response.status;
489
+ err.statusText = response.statusText;
490
+ err.body = response.body;
491
+ err.response = response;
492
+ }
493
+ err.error = error;
494
+ reject(err);
495
+ } else {
496
+ try {
497
+ var data = _this3.deserialize(response, returnType);
498
+ if (_this3.enableCookies && typeof window === 'undefined') {
499
+ _this3.agent._saveCookies(response);
500
+ }
501
+ resolve({
502
+ data: data,
503
+ response: response
504
+ });
505
+ } catch (err) {
506
+ reject(err);
507
+ }
508
+ }
509
+ });
510
+ });
511
+ }
512
+
513
+ /**
514
+ * Parses an ISO-8601 string representation or epoch representation of a date value.
515
+ * @param {String} str The date value as a string.
516
+ * @returns {Date} The parsed date object.
517
+ */
518
+ }, {
519
+ key: "hostSettings",
520
+ value:
521
+ /**
522
+ * Gets an array of host settings
523
+ * @returns An array of host settings
524
+ */
525
+ function hostSettings() {
526
+ return [{
527
+ 'url': "http://localhost:4000",
528
+ 'description': "No description provided"
529
+ }];
530
+ }
531
+ }, {
532
+ key: "getBasePathFromSettings",
533
+ value: function getBasePathFromSettings(index) {
534
+ var variables = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
535
+ var servers = this.hostSettings();
536
+
537
+ // check array index out of bound
538
+ if (index < 0 || index >= servers.length) {
539
+ throw new Error("Invalid index " + index + " when selecting the host settings. Must be less than " + servers.length);
540
+ }
541
+ var server = servers[index];
542
+ var url = server['url'];
543
+
544
+ // go through variable and assign a value
545
+ for (var variable_name in server['variables']) {
546
+ if (variable_name in variables) {
547
+ var variable = server['variables'][variable_name];
548
+ if (!('enum_values' in variable) || variable['enum_values'].includes(variables[variable_name])) {
549
+ url = url.replace("{" + variable_name + "}", variables[variable_name]);
550
+ } else {
551
+ throw new Error("The variable `" + variable_name + "` in the host URL has invalid value " + variables[variable_name] + ". Must be " + server['variables'][variable_name]['enum_values'] + ".");
552
+ }
553
+ } else {
554
+ // use default value
555
+ url = url.replace("{" + variable_name + "}", server['variables'][variable_name]['default_value']);
556
+ }
557
+ }
558
+ return url;
559
+ }
560
+
561
+ /**
562
+ * Constructs a new map or array model from REST data.
563
+ * @param data {Object|Array} The REST data.
564
+ * @param obj {Object|Array} The target object or array.
565
+ */
566
+ }], [{
567
+ key: "canBeJsonified",
568
+ value: function canBeJsonified(str) {
569
+ if (typeof str !== 'string' && _typeof(str) !== 'object') return false;
570
+ try {
571
+ var type = str.toString();
572
+ return type === '[object Object]' || type === '[object Array]';
573
+ } catch (err) {
574
+ return false;
575
+ }
576
+ }
577
+ }, {
578
+ key: "parseDate",
579
+ value: function parseDate(str) {
580
+ if (isNaN(str)) {
581
+ return new Date(str.replace(/(\d)(T)(\d)/i, '$1 $3'));
582
+ }
583
+ return new Date(+str);
584
+ }
585
+
586
+ /**
587
+ * Converts a value to the specified type.
588
+ * @param {(String|Object)} data The data to convert, as a string or object.
589
+ * @param {(String|Array.<String>|Object.<String, Object>|Function)} type The type to return. Pass a string for simple types
590
+ * or the constructor function for a complex type. Pass an array containing the type name to return an array of that type. To
591
+ * return an object, pass an object with one property whose name is the key type and whose value is the corresponding value type:
592
+ * all properties on <code>data<code> will be converted to this type.
593
+ * @returns An instance of the specified type or null or undefined if data is null or undefined.
594
+ */
595
+ }, {
596
+ key: "convertToType",
597
+ value: function convertToType(data, type) {
598
+ if (data === null || data === undefined) return data;
599
+ switch (type) {
600
+ case 'Boolean':
601
+ return Boolean(data);
602
+ case 'Integer':
603
+ return parseInt(data, 10);
604
+ case 'Number':
605
+ return parseFloat(data);
606
+ case 'String':
607
+ return String(data);
608
+ case 'Date':
609
+ return ApiClient.parseDate(String(data));
610
+ case 'Blob':
611
+ return data;
612
+ default:
613
+ if (type === Object) {
614
+ // generic object, return directly
615
+ return data;
616
+ } else if (typeof type.constructFromObject === 'function') {
617
+ // for model type like User and enum class
618
+ return type.constructFromObject(data);
619
+ } else if (Array.isArray(type)) {
620
+ // for array type like: ['String']
621
+ var itemType = type[0];
622
+ return data.map(function (item) {
623
+ return ApiClient.convertToType(item, itemType);
624
+ });
625
+ } else if (_typeof(type) === 'object') {
626
+ // for plain object type like: {'String': 'Integer'}
627
+ var keyType, valueType;
628
+ for (var k in type) {
629
+ if (type.hasOwnProperty(k)) {
630
+ keyType = k;
631
+ valueType = type[k];
632
+ break;
633
+ }
634
+ }
635
+ var result = {};
636
+ for (var k in data) {
637
+ if (data.hasOwnProperty(k)) {
638
+ var key = ApiClient.convertToType(k, keyType);
639
+ var value = ApiClient.convertToType(data[k], valueType);
640
+ result[key] = value;
641
+ }
642
+ }
643
+ return result;
644
+ } else {
645
+ // for unknown type, return the data directly
646
+ return data;
647
+ }
648
+ }
649
+ }
650
+ }, {
651
+ key: "constructFromObject",
652
+ value: function constructFromObject(data, obj, itemType) {
653
+ if (Array.isArray(data)) {
654
+ for (var i = 0; i < data.length; i++) {
655
+ if (data.hasOwnProperty(i)) obj[i] = ApiClient.convertToType(data[i], itemType);
656
+ }
657
+ } else {
658
+ for (var k in data) {
659
+ if (data.hasOwnProperty(k)) obj[k] = ApiClient.convertToType(data[k], itemType);
660
+ }
661
+ }
662
+ }
663
+ }]);
664
+ }();
665
+ /**
666
+ * Enumeration of collection format separator strategies.
667
+ * @enum {String}
668
+ * @readonly
669
+ */
670
+ ApiClient.CollectionFormatEnum = {
671
+ /**
672
+ * Comma-separated values. Value: <code>csv</code>
673
+ * @const
674
+ */
675
+ CSV: ',',
676
+ /**
677
+ * Space-separated values. Value: <code>ssv</code>
678
+ * @const
679
+ */
680
+ SSV: ' ',
681
+ /**
682
+ * Tab-separated values. Value: <code>tsv</code>
683
+ * @const
684
+ */
685
+ TSV: '\t',
686
+ /**
687
+ * Pipe(|)-separated values. Value: <code>pipes</code>
688
+ * @const
689
+ */
690
+ PIPES: '|',
691
+ /**
692
+ * Native array. Value: <code>multi</code>
693
+ * @const
694
+ */
695
+ MULTI: 'multi'
696
+ };
697
+
698
+ /**
699
+ * The default API client implementation.
700
+ * @type {module:ApiClient}
701
+ */
702
+ ApiClient.instance = new ApiClient();
703
+ var _default = exports["default"] = ApiClient;