@steamsets/client-ts 0.19.4 → 0.22.2

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 (538) hide show
  1. package/FUNCTIONS.md +2 -2
  2. package/README.md +95 -193
  3. package/docs/sdks/account/README.md +1230 -196
  4. package/docs/sdks/admin/README.md +94 -5
  5. package/docs/sdks/app/README.md +5 -5
  6. package/docs/sdks/badge/README.md +226 -10
  7. package/docs/sdks/badges/README.md +8 -375
  8. package/docs/sdks/connection/README.md +4 -239
  9. package/docs/sdks/{sessions → developerapps}/README.md +28 -16
  10. package/docs/sdks/events/README.md +4 -93
  11. package/docs/sdks/leaderboard/README.md +5 -77
  12. package/docs/sdks/liveness/README.md +5 -5
  13. package/docs/sdks/{locations → location}/README.md +7 -5
  14. package/docs/sdks/{accounts → roles}/README.md +10 -14
  15. package/docs/sdks/session/README.md +11 -106
  16. package/funcs/{locationsGet.d.ts → accountBookmarkBadge.d.ts} +3 -2
  17. package/funcs/{internalDeleteImages.d.ts.map → accountBookmarkBadge.d.ts.map} +1 -1
  18. package/funcs/{badgesBookmark.js → accountBookmarkBadge.js} +3 -3
  19. package/funcs/{internalDeleteImages.js.map → accountBookmarkBadge.js.map} +1 -1
  20. package/funcs/{accountsQueue.d.ts → accountConnect.d.ts} +2 -2
  21. package/funcs/{badgesBookmark.d.ts.map → accountConnect.d.ts.map} +1 -1
  22. package/funcs/{connectionsConnect.js → accountConnect.js} +3 -3
  23. package/funcs/{sessionsDelete.js.map → accountConnect.js.map} +1 -1
  24. package/funcs/{accountAccountV1GetMeta.d.ts → accountConnectionUpdate.d.ts} +2 -2
  25. package/funcs/{badgeBadgeV1TagsSuggest.d.ts.map → accountConnectionUpdate.d.ts.map} +1 -1
  26. package/funcs/{connectionUpdate.js → accountConnectionUpdate.js} +3 -3
  27. package/funcs/{badgeBadgeV1TagsSuggest.js.map → accountConnectionUpdate.js.map} +1 -1
  28. package/funcs/{settingsVerifyEmail.d.ts → accountCreateSession.d.ts} +2 -3
  29. package/funcs/accountCreateSession.d.ts.map +1 -0
  30. package/funcs/{sessionCreate.js → accountCreateSession.js} +3 -3
  31. package/funcs/accountCreateSession.js.map +1 -0
  32. package/funcs/{accountUpdateApp.d.ts → accountDeleteConnection.d.ts} +2 -2
  33. package/funcs/{externalAppV1ListBadges.d.ts.map → accountDeleteConnection.d.ts.map} +1 -1
  34. package/funcs/{connectionDelete.js → accountDeleteConnection.js} +3 -3
  35. package/funcs/{accountAccountV1GetMeta.js.map → accountDeleteConnection.js.map} +1 -1
  36. package/funcs/{internalDeleteDeveloperApp.d.ts → accountDeveloperAppsDelete.d.ts} +2 -2
  37. package/funcs/{internalDeleteDeveloperApp.d.ts.map → accountDeveloperAppsDelete.d.ts.map} +1 -1
  38. package/funcs/{internalDeleteDeveloperApp.js → accountDeveloperAppsDelete.js} +3 -3
  39. package/funcs/{internalDeleteDeveloperApp.js.map → accountDeveloperAppsDelete.js.map} +1 -1
  40. package/funcs/accountDeveloperAppsUpdate.d.ts +12 -0
  41. package/funcs/{internalCreateDeveloperApp.d.ts.map → accountDeveloperAppsUpdate.d.ts.map} +1 -1
  42. package/funcs/{developerUpdateApp.js → accountDeveloperAppsUpdate.js} +3 -3
  43. package/funcs/{internalCreateDeveloperApp.js.map → accountDeveloperAppsUpdate.js.map} +1 -1
  44. package/funcs/{accountGetAccount.d.ts → accountEmailSendVerification.d.ts} +2 -3
  45. package/funcs/accountEmailSendVerification.d.ts.map +1 -0
  46. package/funcs/{settingsSendVerification.js → accountEmailSendVerification.js} +3 -3
  47. package/funcs/accountEmailSendVerification.js.map +1 -0
  48. package/funcs/{developerCreateDeveloperApp.d.ts → accountEmailSubscription.d.ts} +2 -3
  49. package/funcs/{settingsSendVerification.d.ts.map → accountEmailSubscription.d.ts.map} +1 -1
  50. package/funcs/{settingsSubscribeEmail.js → accountEmailSubscription.js} +3 -3
  51. package/funcs/accountEmailSubscription.js.map +1 -0
  52. package/funcs/{badgeBadgeV1TagsSuggest.d.ts → accountEmailVerify.d.ts} +2 -2
  53. package/funcs/{appAppV1ListBadges.d.ts.map → accountEmailVerify.d.ts.map} +1 -1
  54. package/funcs/{settingsVerifyEmail.js → accountEmailVerify.js} +3 -3
  55. package/funcs/{appAppV1ListBadges.js.map → accountEmailVerify.js.map} +1 -1
  56. package/funcs/{internalCreateDeveloperApp.d.ts → accountGetBadgeBookmarks.d.ts} +2 -3
  57. package/funcs/accountGetBadgeBookmarks.d.ts.map +1 -0
  58. package/funcs/{badgesGetBookmarks.js → accountGetBadgeBookmarks.js} +3 -3
  59. package/funcs/accountGetBadgeBookmarks.js.map +1 -0
  60. package/funcs/{internalGetStaff.d.ts → accountGetImages.d.ts} +2 -2
  61. package/funcs/{internalGetStaff.d.ts.map → accountGetImages.d.ts.map} +1 -1
  62. package/funcs/{imagesGet.js → accountGetImages.js} +3 -3
  63. package/funcs/accountGetImages.js.map +1 -0
  64. package/funcs/{settingsSendVerification.d.ts → accountGetMeta.d.ts} +3 -2
  65. package/funcs/{dataGetFriends.d.ts.map → accountGetMeta.d.ts.map} +1 -1
  66. package/funcs/{dataAccountV1GetMeta.js → accountGetMeta.js} +3 -3
  67. package/funcs/{dataGetFriends.js.map → accountGetMeta.js.map} +1 -1
  68. package/funcs/{badgesGetBookmarks.d.ts → accountGetOwnedBadges.d.ts} +2 -2
  69. package/funcs/accountGetOwnedBadges.d.ts.map +1 -0
  70. package/funcs/{badgesGetOwned.js → accountGetOwnedBadges.js} +3 -3
  71. package/funcs/accountGetOwnedBadges.js.map +1 -0
  72. package/funcs/{appAppV1ListBadges.d.ts → accountGetSession.d.ts} +2 -3
  73. package/funcs/accountGetSession.d.ts.map +1 -0
  74. package/funcs/{sessionsGet.js → accountGetSession.js} +3 -3
  75. package/funcs/{livenessCheck.js.map → accountGetSession.js.map} +1 -1
  76. package/funcs/{settingsSubscribeEmail.d.ts → accountGetSettings.d.ts} +2 -2
  77. package/funcs/{badgesGetBookmarks.d.ts.map → accountGetSettings.d.ts.map} +1 -1
  78. package/funcs/{settingsGet.js → accountGetSettings.js} +3 -3
  79. package/funcs/accountGetSettings.js.map +1 -0
  80. package/funcs/{sessionLogin.d.ts → accountLogin.d.ts} +2 -2
  81. package/funcs/{sessionLogin.d.ts.map → accountLogin.d.ts.map} +1 -1
  82. package/funcs/{sessionLogin.js → accountLogin.js} +3 -3
  83. package/funcs/{sessionLogin.js.map → accountLogin.js.map} +1 -1
  84. package/funcs/{dataGetApps.d.ts → accountQueue.d.ts} +2 -2
  85. package/funcs/{eventsUpdate.d.ts.map → accountQueue.d.ts.map} +1 -1
  86. package/funcs/{accountsQueue.js → accountQueue.js} +3 -3
  87. package/funcs/{imagesUpdate.js.map → accountQueue.js.map} +1 -1
  88. package/funcs/{internalDeleteImages.d.ts → accountReconnect.d.ts} +2 -2
  89. package/funcs/{accountUpdateApp.d.ts.map → accountReconnect.d.ts.map} +1 -1
  90. package/funcs/{connectionReconnect.js → accountReconnect.js} +3 -3
  91. package/funcs/{connectionVerify.js.map → accountReconnect.js.map} +1 -1
  92. package/funcs/{settingsUpdateRole.d.ts → accountRolesUpdate.d.ts} +2 -2
  93. package/funcs/{settingsUpdateRole.d.ts.map → accountRolesUpdate.d.ts.map} +1 -1
  94. package/funcs/{settingsUpdateRole.js → accountRolesUpdate.js} +3 -3
  95. package/funcs/{settingsUpdateRole.js.map → accountRolesUpdate.js.map} +1 -1
  96. package/funcs/{dataGetLeaderboardHistory.d.ts → accountSessionDelete.d.ts} +2 -2
  97. package/funcs/{internalUploadImages.d.ts.map → accountSessionDelete.d.ts.map} +1 -1
  98. package/funcs/{sessionsDelete.js → accountSessionDelete.js} +3 -3
  99. package/funcs/{dataAccountV1GetMeta.js.map → accountSessionDelete.js.map} +1 -1
  100. package/funcs/{imagesDeleteImages.d.ts → accountUpdateImages.d.ts} +2 -2
  101. package/funcs/{settingsVerifyEmail.d.ts.map → accountUpdateImages.d.ts.map} +1 -1
  102. package/funcs/{imagesUpdate.js → accountUpdateImages.js} +3 -3
  103. package/funcs/{connectionReconnect.js.map → accountUpdateImages.js.map} +1 -1
  104. package/funcs/{eventsGet.d.ts → accountUpdateSettings.d.ts} +2 -2
  105. package/funcs/accountUpdateSettings.d.ts.map +1 -0
  106. package/funcs/{settingsUpdate.js → accountUpdateSettings.js} +3 -3
  107. package/funcs/accountUpdateSettings.js.map +1 -0
  108. package/funcs/accountVerifyConnection.d.ts +12 -0
  109. package/funcs/{accountAccountV1GetMeta.d.ts.map → accountVerifyConnection.d.ts.map} +1 -1
  110. package/funcs/{connectionVerify.js → accountVerifyConnection.js} +3 -3
  111. package/funcs/{externalAppV1ListBadges.js.map → accountVerifyConnection.js.map} +1 -1
  112. package/funcs/{externalGetLeaderboardHistory.d.ts → adminEventsGet.d.ts} +2 -3
  113. package/funcs/{badgesGetOwned.d.ts.map → adminEventsGet.d.ts.map} +1 -1
  114. package/funcs/{eventsGet.js → adminEventsGet.js} +3 -3
  115. package/funcs/{badgesGetOwned.js.map → adminEventsGet.js.map} +1 -1
  116. package/funcs/{dataAccountV1GetMeta.d.ts → adminRemoveVanity.d.ts} +2 -2
  117. package/funcs/{accountGetAccount.d.ts.map → adminRemoveVanity.d.ts.map} +1 -1
  118. package/funcs/{eventAdminV1RemoveVanity.js → adminRemoveVanity.js} +3 -3
  119. package/funcs/{accountGetAccount.js.map → adminRemoveVanity.js.map} +1 -1
  120. package/funcs/{externalAppV1ListBadges.d.ts → adminUpdateEvent.d.ts} +2 -2
  121. package/funcs/{connectionVerify.d.ts.map → adminUpdateEvent.d.ts.map} +1 -1
  122. package/funcs/{eventsUpdate.js → adminUpdateEvent.js} +3 -3
  123. package/funcs/{connectionDelete.js.map → adminUpdateEvent.js.map} +1 -1
  124. package/funcs/{internalAccountV1GetMeta.d.ts → appListBadges.d.ts} +2 -2
  125. package/funcs/{accountsQueue.d.ts.map → appListBadges.d.ts.map} +1 -1
  126. package/funcs/{appAppV1ListBadges.js → appListBadges.js} +3 -3
  127. package/funcs/{accountsQueue.js.map → appListBadges.js.map} +1 -1
  128. package/funcs/{dataGetInfo.d.ts → badgeSearch.d.ts} +2 -2
  129. package/funcs/{dataGetInfo.d.ts.map → badgeSearch.d.ts.map} +1 -1
  130. package/funcs/{badgesSearch.js → badgeSearch.js} +3 -3
  131. package/funcs/{dataGetInfo.js.map → badgeSearch.js.map} +1 -1
  132. package/funcs/{connectionsConnect.d.ts → badgeSuggest.d.ts} +2 -2
  133. package/funcs/{imagesUpdate.d.ts.map → badgeSuggest.d.ts.map} +1 -1
  134. package/funcs/{badgeBadgeV1SearchSuggest.js → badgeSuggest.js} +3 -3
  135. package/funcs/{badgesSearch.js.map → badgeSuggest.js.map} +1 -1
  136. package/funcs/badgeSuggestTags.d.ts +12 -0
  137. package/funcs/{connectionDelete.d.ts.map → badgeSuggestTags.d.ts.map} +1 -1
  138. package/funcs/{badgeBadgeV1TagsSuggest.js → badgeSuggestTags.js} +3 -3
  139. package/funcs/{connectionUpdate.js.map → badgeSuggestTags.js.map} +1 -1
  140. package/funcs/{badgesTag.d.ts → badgeTag.d.ts} +2 -2
  141. package/funcs/badgeTag.d.ts.map +1 -0
  142. package/funcs/{badgesTag.js → badgeTag.js} +3 -3
  143. package/funcs/badgeTag.js.map +1 -0
  144. package/funcs/{badgesGetOwned.d.ts → leaderboardBadgesGetList.d.ts} +2 -2
  145. package/funcs/leaderboardBadgesGetList.d.ts.map +1 -0
  146. package/funcs/{leaderboardGetBadges.js → leaderboardBadgesGetList.js} +3 -3
  147. package/funcs/leaderboardBadgesGetList.js.map +1 -0
  148. package/funcs/{accountDeleteDeveloperApp.d.ts → leaderboardGetAccountMeta.d.ts} +2 -2
  149. package/funcs/{accountDeleteDeveloperApp.d.ts.map → leaderboardGetAccountMeta.d.ts.map} +1 -1
  150. package/funcs/{accountLeaderboardV1GetLeaderboardAccountMeta.js → leaderboardGetAccountMeta.js} +3 -3
  151. package/funcs/leaderboardGetAccountMeta.js.map +1 -0
  152. package/funcs/{internalCheck.d.ts → livenessGet.d.ts} +2 -2
  153. package/funcs/livenessGet.d.ts.map +1 -0
  154. package/funcs/{internalCheck.js → livenessGet.js} +3 -3
  155. package/funcs/livenessGet.js.map +1 -0
  156. package/funcs/{externalGet.d.ts → locationGet.d.ts} +2 -2
  157. package/funcs/{externalGet.d.ts.map → locationGet.d.ts.map} +1 -1
  158. package/funcs/{locationsGet.js → locationGet.js} +3 -3
  159. package/funcs/{externalGet.js.map → locationGet.js.map} +1 -1
  160. package/jsr.json +1 -1
  161. package/lib/config.d.ts +2 -2
  162. package/lib/config.js +2 -2
  163. package/package.json +1 -1
  164. package/sdk/account.d.ts +31 -5
  165. package/sdk/account.d.ts.map +1 -1
  166. package/sdk/account.js +88 -16
  167. package/sdk/account.js.map +1 -1
  168. package/sdk/admin.d.ts +5 -1
  169. package/sdk/admin.d.ts.map +1 -1
  170. package/sdk/admin.js +11 -3
  171. package/sdk/admin.js.map +1 -1
  172. package/sdk/app.d.ts +1 -1
  173. package/sdk/app.d.ts.map +1 -1
  174. package/sdk/app.js +3 -3
  175. package/sdk/app.js.map +1 -1
  176. package/sdk/badge.d.ts +4 -2
  177. package/sdk/badge.d.ts.map +1 -1
  178. package/sdk/badge.js +14 -6
  179. package/sdk/badge.js.map +1 -1
  180. package/sdk/badges.d.ts +1 -6
  181. package/sdk/badges.d.ts.map +1 -1
  182. package/sdk/badges.js +3 -19
  183. package/sdk/badges.js.map +1 -1
  184. package/sdk/connection.d.ts +0 -3
  185. package/sdk/connection.d.ts.map +1 -1
  186. package/sdk/connection.js +2 -14
  187. package/sdk/connection.js.map +1 -1
  188. package/sdk/developerapps.d.ts +8 -0
  189. package/sdk/developerapps.d.ts.map +1 -0
  190. package/sdk/developerapps.js +20 -0
  191. package/sdk/developerapps.js.map +1 -0
  192. package/sdk/events.d.ts +0 -2
  193. package/sdk/events.d.ts.map +1 -1
  194. package/sdk/events.js +2 -6
  195. package/sdk/events.js.map +1 -1
  196. package/sdk/leaderboard.d.ts +4 -2
  197. package/sdk/leaderboard.d.ts.map +1 -1
  198. package/sdk/leaderboard.js +7 -7
  199. package/sdk/leaderboard.js.map +1 -1
  200. package/sdk/liveness.d.ts +1 -1
  201. package/sdk/liveness.d.ts.map +1 -1
  202. package/sdk/liveness.js +3 -3
  203. package/sdk/liveness.js.map +1 -1
  204. package/sdk/{locations.d.ts → location.d.ts} +2 -2
  205. package/sdk/location.d.ts.map +1 -0
  206. package/sdk/location.js +16 -0
  207. package/sdk/location.js.map +1 -0
  208. package/sdk/roles.d.ts +7 -0
  209. package/sdk/roles.d.ts.map +1 -0
  210. package/sdk/roles.js +16 -0
  211. package/sdk/roles.js.map +1 -0
  212. package/sdk/sdk.d.ts +3 -45
  213. package/sdk/sdk.d.ts.map +1 -1
  214. package/sdk/sdk.js +3 -59
  215. package/sdk/sdk.js.map +1 -1
  216. package/sdk/session.d.ts +2 -2
  217. package/sdk/session.d.ts.map +1 -1
  218. package/sdk/session.js +3 -7
  219. package/sdk/session.js.map +1 -1
  220. package/src/funcs/{badgesBookmark.ts → accountBookmarkBadge.ts} +1 -1
  221. package/src/funcs/{connectionsConnect.ts → accountConnect.ts} +1 -1
  222. package/src/funcs/{connectionUpdate.ts → accountConnectionUpdate.ts} +1 -1
  223. package/src/funcs/{sessionCreate.ts → accountCreateSession.ts} +1 -1
  224. package/src/funcs/{connectionDelete.ts → accountDeleteConnection.ts} +1 -1
  225. package/src/funcs/{internalDeleteDeveloperApp.ts → accountDeveloperAppsDelete.ts} +1 -1
  226. package/src/funcs/{accountUpdateApp.ts → accountDeveloperAppsUpdate.ts} +1 -1
  227. package/src/funcs/{settingsSendVerification.ts → accountEmailSendVerification.ts} +1 -1
  228. package/src/funcs/{settingsSubscribeEmail.ts → accountEmailSubscription.ts} +1 -1
  229. package/src/funcs/{settingsVerifyEmail.ts → accountEmailVerify.ts} +1 -1
  230. package/src/funcs/{badgesGetBookmarks.ts → accountGetBadgeBookmarks.ts} +1 -1
  231. package/src/funcs/{imagesGet.ts → accountGetImages.ts} +1 -1
  232. package/src/funcs/{dataAccountV1GetMeta.ts → accountGetMeta.ts} +1 -1
  233. package/src/funcs/{badgesGetOwned.ts → accountGetOwnedBadges.ts} +1 -1
  234. package/src/funcs/{sessionsGet.ts → accountGetSession.ts} +1 -1
  235. package/src/funcs/{settingsGet.ts → accountGetSettings.ts} +1 -1
  236. package/src/funcs/{sessionLogin.ts → accountLogin.ts} +1 -1
  237. package/src/funcs/{accountsQueue.ts → accountQueue.ts} +1 -1
  238. package/src/funcs/{connectionReconnect.ts → accountReconnect.ts} +1 -1
  239. package/src/funcs/{settingsUpdateRole.ts → accountRolesUpdate.ts} +1 -1
  240. package/src/funcs/{sessionsDelete.ts → accountSessionDelete.ts} +1 -1
  241. package/src/funcs/{imagesUpdate.ts → accountUpdateImages.ts} +1 -1
  242. package/src/funcs/{settingsUpdate.ts → accountUpdateSettings.ts} +1 -1
  243. package/src/funcs/{connectionVerify.ts → accountVerifyConnection.ts} +1 -1
  244. package/src/funcs/{eventsGet.ts → adminEventsGet.ts} +1 -1
  245. package/src/funcs/{eventAdminV1RemoveVanity.ts → adminRemoveVanity.ts} +1 -1
  246. package/src/funcs/{eventsUpdate.ts → adminUpdateEvent.ts} +1 -1
  247. package/src/funcs/{appAppV1ListBadges.ts → appListBadges.ts} +1 -1
  248. package/src/funcs/{badgesSearch.ts → badgeSearch.ts} +1 -1
  249. package/src/funcs/{badgeBadgeV1SearchSuggest.ts → badgeSuggest.ts} +1 -1
  250. package/src/funcs/{badgeBadgeV1TagsSuggest.ts → badgeSuggestTags.ts} +1 -1
  251. package/src/funcs/{badgesTag.ts → badgeTag.ts} +1 -1
  252. package/src/funcs/{leaderboardGetBadges.ts → leaderboardBadgesGetList.ts} +1 -1
  253. package/src/funcs/{accountLeaderboardV1GetLeaderboardAccountMeta.ts → leaderboardGetAccountMeta.ts} +1 -1
  254. package/src/funcs/{livenessCheck.ts → livenessGet.ts} +1 -1
  255. package/src/funcs/{locationsGet.ts → locationGet.ts} +1 -1
  256. package/src/lib/config.ts +2 -2
  257. package/src/sdk/account.ts +209 -27
  258. package/src/sdk/admin.ts +21 -3
  259. package/src/sdk/app.ts +3 -3
  260. package/src/sdk/badge.ts +30 -6
  261. package/src/sdk/badges.ts +4 -51
  262. package/src/sdk/connection.ts +2 -38
  263. package/src/sdk/{developer.ts → developerapps.ts} +7 -19
  264. package/src/sdk/events.ts +2 -15
  265. package/src/sdk/leaderboard.ts +9 -13
  266. package/src/sdk/liveness.ts +3 -3
  267. package/src/sdk/{locations.ts → location.ts} +3 -3
  268. package/src/sdk/{connections.ts → roles.ts} +6 -6
  269. package/src/sdk/sdk.ts +4 -88
  270. package/src/sdk/session.ts +6 -17
  271. package/docs/sdks/connections/README.md +0 -86
  272. package/docs/sdks/data/README.md +0 -520
  273. package/docs/sdks/developer/README.md +0 -252
  274. package/docs/sdks/event/README.md +0 -80
  275. package/docs/sdks/external/README.md +0 -596
  276. package/docs/sdks/images/README.md +0 -323
  277. package/docs/sdks/internal/README.md +0 -1137
  278. package/docs/sdks/settings/README.md +0 -471
  279. package/funcs/accountAccountV1GetMeta.js +0 -118
  280. package/funcs/accountDeleteDeveloperApp.js +0 -116
  281. package/funcs/accountDeleteDeveloperApp.js.map +0 -1
  282. package/funcs/accountGetAccount.js +0 -118
  283. package/funcs/accountLeaderboardV1GetLeaderboardAccountMeta.d.ts +0 -12
  284. package/funcs/accountLeaderboardV1GetLeaderboardAccountMeta.d.ts.map +0 -1
  285. package/funcs/accountLeaderboardV1GetLeaderboardAccountMeta.js.map +0 -1
  286. package/funcs/accountUpdateApp.js +0 -116
  287. package/funcs/accountUpdateApp.js.map +0 -1
  288. package/funcs/adminAdminV1RemoveVanity.d.ts +0 -12
  289. package/funcs/adminAdminV1RemoveVanity.d.ts.map +0 -1
  290. package/funcs/adminAdminV1RemoveVanity.js +0 -118
  291. package/funcs/adminAdminV1RemoveVanity.js.map +0 -1
  292. package/funcs/badgeBadgeV1SearchSuggest.d.ts +0 -12
  293. package/funcs/badgeBadgeV1SearchSuggest.d.ts.map +0 -1
  294. package/funcs/badgeBadgeV1SearchSuggest.js.map +0 -1
  295. package/funcs/badgesBookmark.d.ts +0 -12
  296. package/funcs/badgesBookmark.js.map +0 -1
  297. package/funcs/badgesGetBookmarks.js.map +0 -1
  298. package/funcs/badgesSearch.d.ts +0 -12
  299. package/funcs/badgesSearch.d.ts.map +0 -1
  300. package/funcs/badgesTag.d.ts.map +0 -1
  301. package/funcs/badgesTag.js.map +0 -1
  302. package/funcs/connectionDelete.d.ts +0 -12
  303. package/funcs/connectionReconnect.d.ts +0 -12
  304. package/funcs/connectionReconnect.d.ts.map +0 -1
  305. package/funcs/connectionUpdate.d.ts +0 -12
  306. package/funcs/connectionUpdate.d.ts.map +0 -1
  307. package/funcs/connectionVerify.d.ts +0 -12
  308. package/funcs/connectionsConnect.d.ts.map +0 -1
  309. package/funcs/connectionsConnect.js.map +0 -1
  310. package/funcs/dataAccountV1GetMeta.d.ts.map +0 -1
  311. package/funcs/dataGetApps.d.ts.map +0 -1
  312. package/funcs/dataGetApps.js +0 -118
  313. package/funcs/dataGetApps.js.map +0 -1
  314. package/funcs/dataGetBadges.d.ts +0 -12
  315. package/funcs/dataGetBadges.d.ts.map +0 -1
  316. package/funcs/dataGetBadges.js +0 -118
  317. package/funcs/dataGetBadges.js.map +0 -1
  318. package/funcs/dataGetDataPoints.d.ts +0 -12
  319. package/funcs/dataGetDataPoints.d.ts.map +0 -1
  320. package/funcs/dataGetDataPoints.js +0 -118
  321. package/funcs/dataGetDataPoints.js.map +0 -1
  322. package/funcs/dataGetFriends.d.ts +0 -12
  323. package/funcs/dataGetFriends.js +0 -118
  324. package/funcs/dataGetInfo.js +0 -118
  325. package/funcs/dataGetLeaderboardHistory.d.ts.map +0 -1
  326. package/funcs/dataGetLeaderboardHistory.js +0 -116
  327. package/funcs/dataGetLeaderboardHistory.js.map +0 -1
  328. package/funcs/developerCreateDeveloperApp.d.ts.map +0 -1
  329. package/funcs/developerCreateDeveloperApp.js +0 -116
  330. package/funcs/developerCreateDeveloperApp.js.map +0 -1
  331. package/funcs/developerDeleteDeveloperApp.d.ts +0 -12
  332. package/funcs/developerDeleteDeveloperApp.d.ts.map +0 -1
  333. package/funcs/developerDeleteDeveloperApp.js +0 -116
  334. package/funcs/developerDeleteDeveloperApp.js.map +0 -1
  335. package/funcs/developerUpdateApp.d.ts +0 -12
  336. package/funcs/developerUpdateApp.d.ts.map +0 -1
  337. package/funcs/developerUpdateApp.js.map +0 -1
  338. package/funcs/eventAdminV1RemoveVanity.d.ts +0 -12
  339. package/funcs/eventAdminV1RemoveVanity.d.ts.map +0 -1
  340. package/funcs/eventAdminV1RemoveVanity.js.map +0 -1
  341. package/funcs/eventsGet.d.ts.map +0 -1
  342. package/funcs/eventsGet.js.map +0 -1
  343. package/funcs/eventsUpdate.d.ts +0 -12
  344. package/funcs/eventsUpdate.js.map +0 -1
  345. package/funcs/externalAppV1ListBadges.js +0 -118
  346. package/funcs/externalGet.js +0 -107
  347. package/funcs/externalGetApps.d.ts +0 -12
  348. package/funcs/externalGetApps.d.ts.map +0 -1
  349. package/funcs/externalGetApps.js +0 -118
  350. package/funcs/externalGetApps.js.map +0 -1
  351. package/funcs/externalGetBadges.d.ts +0 -12
  352. package/funcs/externalGetBadges.d.ts.map +0 -1
  353. package/funcs/externalGetBadges.js +0 -118
  354. package/funcs/externalGetBadges.js.map +0 -1
  355. package/funcs/externalGetDataPoints.d.ts +0 -12
  356. package/funcs/externalGetDataPoints.d.ts.map +0 -1
  357. package/funcs/externalGetDataPoints.js +0 -118
  358. package/funcs/externalGetDataPoints.js.map +0 -1
  359. package/funcs/externalGetFriends.d.ts +0 -12
  360. package/funcs/externalGetFriends.d.ts.map +0 -1
  361. package/funcs/externalGetFriends.js +0 -118
  362. package/funcs/externalGetFriends.js.map +0 -1
  363. package/funcs/externalGetInfo.d.ts +0 -12
  364. package/funcs/externalGetInfo.d.ts.map +0 -1
  365. package/funcs/externalGetInfo.js +0 -118
  366. package/funcs/externalGetInfo.js.map +0 -1
  367. package/funcs/externalGetLeaderboardHistory.d.ts.map +0 -1
  368. package/funcs/externalGetLeaderboardHistory.js +0 -116
  369. package/funcs/externalGetLeaderboardHistory.js.map +0 -1
  370. package/funcs/imagesDeleteImages.d.ts.map +0 -1
  371. package/funcs/imagesDeleteImages.js +0 -118
  372. package/funcs/imagesDeleteImages.js.map +0 -1
  373. package/funcs/imagesGet.d.ts +0 -11
  374. package/funcs/imagesGet.d.ts.map +0 -1
  375. package/funcs/imagesGet.js.map +0 -1
  376. package/funcs/imagesUpdate.d.ts +0 -12
  377. package/funcs/imagesUploadImages.d.ts +0 -12
  378. package/funcs/imagesUploadImages.d.ts.map +0 -1
  379. package/funcs/imagesUploadImages.js +0 -118
  380. package/funcs/imagesUploadImages.js.map +0 -1
  381. package/funcs/internalAccountV1GetMeta.d.ts.map +0 -1
  382. package/funcs/internalAccountV1GetMeta.js +0 -118
  383. package/funcs/internalAccountV1GetMeta.js.map +0 -1
  384. package/funcs/internalAdminV1RemoveVanity.d.ts +0 -12
  385. package/funcs/internalAdminV1RemoveVanity.d.ts.map +0 -1
  386. package/funcs/internalAdminV1RemoveVanity.js +0 -118
  387. package/funcs/internalAdminV1RemoveVanity.js.map +0 -1
  388. package/funcs/internalBadgeV1SearchSuggest.d.ts +0 -12
  389. package/funcs/internalBadgeV1SearchSuggest.d.ts.map +0 -1
  390. package/funcs/internalBadgeV1SearchSuggest.js +0 -118
  391. package/funcs/internalBadgeV1SearchSuggest.js.map +0 -1
  392. package/funcs/internalBadgeV1TagsSuggest.d.ts +0 -12
  393. package/funcs/internalBadgeV1TagsSuggest.d.ts.map +0 -1
  394. package/funcs/internalBadgeV1TagsSuggest.js +0 -118
  395. package/funcs/internalBadgeV1TagsSuggest.js.map +0 -1
  396. package/funcs/internalCheck.d.ts.map +0 -1
  397. package/funcs/internalCheck.js.map +0 -1
  398. package/funcs/internalCreateDeveloperApp.js +0 -116
  399. package/funcs/internalDeleteImages.js +0 -118
  400. package/funcs/internalGetAccount.d.ts +0 -12
  401. package/funcs/internalGetAccount.d.ts.map +0 -1
  402. package/funcs/internalGetAccount.js +0 -118
  403. package/funcs/internalGetAccount.js.map +0 -1
  404. package/funcs/internalGetStaff.js +0 -107
  405. package/funcs/internalGetStaff.js.map +0 -1
  406. package/funcs/internalGetTags.d.ts +0 -11
  407. package/funcs/internalGetTags.d.ts.map +0 -1
  408. package/funcs/internalGetTags.js +0 -107
  409. package/funcs/internalGetTags.js.map +0 -1
  410. package/funcs/internalLeaderboardV1GetLeaderboardAccountMeta.d.ts +0 -12
  411. package/funcs/internalLeaderboardV1GetLeaderboardAccountMeta.d.ts.map +0 -1
  412. package/funcs/internalLeaderboardV1GetLeaderboardAccountMeta.js +0 -116
  413. package/funcs/internalLeaderboardV1GetLeaderboardAccountMeta.js.map +0 -1
  414. package/funcs/internalUpdateApp.d.ts +0 -12
  415. package/funcs/internalUpdateApp.d.ts.map +0 -1
  416. package/funcs/internalUpdateApp.js +0 -116
  417. package/funcs/internalUpdateApp.js.map +0 -1
  418. package/funcs/internalUploadImages.d.ts +0 -12
  419. package/funcs/internalUploadImages.js +0 -118
  420. package/funcs/internalUploadImages.js.map +0 -1
  421. package/funcs/leaderboardGetBadges.d.ts +0 -11
  422. package/funcs/leaderboardGetBadges.d.ts.map +0 -1
  423. package/funcs/leaderboardGetBadges.js.map +0 -1
  424. package/funcs/leaderboardLeaderboardV1GetLeaderboardAccountMeta.d.ts +0 -12
  425. package/funcs/leaderboardLeaderboardV1GetLeaderboardAccountMeta.d.ts.map +0 -1
  426. package/funcs/leaderboardLeaderboardV1GetLeaderboardAccountMeta.js +0 -116
  427. package/funcs/leaderboardLeaderboardV1GetLeaderboardAccountMeta.js.map +0 -1
  428. package/funcs/livenessCheck.d.ts +0 -17
  429. package/funcs/livenessCheck.d.ts.map +0 -1
  430. package/funcs/livenessCheck.js +0 -111
  431. package/funcs/locationsGet.d.ts.map +0 -1
  432. package/funcs/locationsGet.js.map +0 -1
  433. package/funcs/sessionCreate.d.ts +0 -11
  434. package/funcs/sessionCreate.d.ts.map +0 -1
  435. package/funcs/sessionCreate.js.map +0 -1
  436. package/funcs/sessionsDelete.d.ts +0 -12
  437. package/funcs/sessionsDelete.d.ts.map +0 -1
  438. package/funcs/sessionsGet.d.ts +0 -11
  439. package/funcs/sessionsGet.d.ts.map +0 -1
  440. package/funcs/sessionsGet.js.map +0 -1
  441. package/funcs/settingsGet.d.ts +0 -11
  442. package/funcs/settingsGet.d.ts.map +0 -1
  443. package/funcs/settingsGet.js.map +0 -1
  444. package/funcs/settingsSendVerification.js.map +0 -1
  445. package/funcs/settingsSubscribeEmail.d.ts.map +0 -1
  446. package/funcs/settingsSubscribeEmail.js.map +0 -1
  447. package/funcs/settingsUpdate.d.ts +0 -11
  448. package/funcs/settingsUpdate.d.ts.map +0 -1
  449. package/funcs/settingsUpdate.js.map +0 -1
  450. package/funcs/settingsVerifyEmail.js.map +0 -1
  451. package/sdk/accounts.d.ts +0 -7
  452. package/sdk/accounts.d.ts.map +0 -1
  453. package/sdk/accounts.js +0 -16
  454. package/sdk/accounts.js.map +0 -1
  455. package/sdk/connections.d.ts +0 -7
  456. package/sdk/connections.d.ts.map +0 -1
  457. package/sdk/connections.js +0 -16
  458. package/sdk/connections.js.map +0 -1
  459. package/sdk/data.d.ts +0 -13
  460. package/sdk/data.d.ts.map +0 -1
  461. package/sdk/data.js +0 -40
  462. package/sdk/data.js.map +0 -1
  463. package/sdk/developer.d.ts +0 -9
  464. package/sdk/developer.d.ts.map +0 -1
  465. package/sdk/developer.js +0 -24
  466. package/sdk/developer.js.map +0 -1
  467. package/sdk/event.d.ts +0 -7
  468. package/sdk/event.d.ts.map +0 -1
  469. package/sdk/event.js +0 -16
  470. package/sdk/event.js.map +0 -1
  471. package/sdk/external.d.ts +0 -14
  472. package/sdk/external.d.ts.map +0 -1
  473. package/sdk/external.js +0 -44
  474. package/sdk/external.js.map +0 -1
  475. package/sdk/images.d.ts +0 -10
  476. package/sdk/images.d.ts.map +0 -1
  477. package/sdk/images.js +0 -28
  478. package/sdk/images.js.map +0 -1
  479. package/sdk/internal.d.ts +0 -26
  480. package/sdk/internal.d.ts.map +0 -1
  481. package/sdk/internal.js +0 -74
  482. package/sdk/internal.js.map +0 -1
  483. package/sdk/locations.d.ts.map +0 -1
  484. package/sdk/locations.js +0 -16
  485. package/sdk/locations.js.map +0 -1
  486. package/sdk/sessions.d.ts +0 -8
  487. package/sdk/sessions.d.ts.map +0 -1
  488. package/sdk/sessions.js +0 -20
  489. package/sdk/sessions.js.map +0 -1
  490. package/sdk/settings.d.ts +0 -12
  491. package/sdk/settings.d.ts.map +0 -1
  492. package/sdk/settings.js +0 -36
  493. package/sdk/settings.js.map +0 -1
  494. package/src/funcs/accountAccountV1GetMeta.ts +0 -179
  495. package/src/funcs/accountDeleteDeveloperApp.ts +0 -184
  496. package/src/funcs/accountGetAccount.ts +0 -179
  497. package/src/funcs/adminAdminV1RemoveVanity.ts +0 -179
  498. package/src/funcs/dataGetApps.ts +0 -179
  499. package/src/funcs/dataGetBadges.ts +0 -179
  500. package/src/funcs/dataGetDataPoints.ts +0 -179
  501. package/src/funcs/dataGetFriends.ts +0 -179
  502. package/src/funcs/dataGetInfo.ts +0 -179
  503. package/src/funcs/dataGetLeaderboardHistory.ts +0 -181
  504. package/src/funcs/developerCreateDeveloperApp.ts +0 -182
  505. package/src/funcs/developerDeleteDeveloperApp.ts +0 -184
  506. package/src/funcs/developerUpdateApp.ts +0 -184
  507. package/src/funcs/externalAppV1ListBadges.ts +0 -179
  508. package/src/funcs/externalGet.ts +0 -160
  509. package/src/funcs/externalGetApps.ts +0 -179
  510. package/src/funcs/externalGetBadges.ts +0 -179
  511. package/src/funcs/externalGetDataPoints.ts +0 -179
  512. package/src/funcs/externalGetFriends.ts +0 -179
  513. package/src/funcs/externalGetInfo.ts +0 -179
  514. package/src/funcs/externalGetLeaderboardHistory.ts +0 -181
  515. package/src/funcs/imagesDeleteImages.ts +0 -179
  516. package/src/funcs/imagesUploadImages.ts +0 -179
  517. package/src/funcs/internalAccountV1GetMeta.ts +0 -179
  518. package/src/funcs/internalAdminV1RemoveVanity.ts +0 -179
  519. package/src/funcs/internalBadgeV1SearchSuggest.ts +0 -180
  520. package/src/funcs/internalBadgeV1TagsSuggest.ts +0 -180
  521. package/src/funcs/internalCheck.ts +0 -160
  522. package/src/funcs/internalCreateDeveloperApp.ts +0 -182
  523. package/src/funcs/internalDeleteImages.ts +0 -179
  524. package/src/funcs/internalGetAccount.ts +0 -179
  525. package/src/funcs/internalGetStaff.ts +0 -160
  526. package/src/funcs/internalGetTags.ts +0 -160
  527. package/src/funcs/internalLeaderboardV1GetLeaderboardAccountMeta.ts +0 -186
  528. package/src/funcs/internalUpdateApp.ts +0 -184
  529. package/src/funcs/internalUploadImages.ts +0 -179
  530. package/src/funcs/leaderboardLeaderboardV1GetLeaderboardAccountMeta.ts +0 -186
  531. package/src/sdk/accounts.ts +0 -22
  532. package/src/sdk/data.ts +0 -94
  533. package/src/sdk/event.ts +0 -22
  534. package/src/sdk/external.ts +0 -104
  535. package/src/sdk/images.ts +0 -56
  536. package/src/sdk/internal.ts +0 -178
  537. package/src/sdk/sessions.ts +0 -32
  538. package/src/sdk/settings.ts +0 -80
package/docs/sdks/internal/README.md DELETED
@@ -1,1137 +0,0 @@
1
- # Internal
2
- (*internal*)
3
-
4
- ## Overview
5
-
6
- There requests are just document for documentations sake, they are not meant to be used. If you are looking to use one of these endpoints, please contact us.
7
-
8
- ### Available Operations
9
-
10
- * [createDeveloperApp](#createdeveloperapp)
11
- * [deleteDeveloperApp](#deletedeveloperapp)
12
- * [deleteImages](#deleteimages)
13
- * [updateApp](#updateapp)
14
- * [accountV1GetMeta](#accountv1getmeta)
15
- * [getStaff](#getstaff)
16
- * [uploadImages](#uploadimages)
17
- * [getAccount](#getaccount)
18
- * [adminV1RemoveVanity](#adminv1removevanity)
19
- * [getTags](#gettags)
20
- * [badgeV1SearchSuggest](#badgev1searchsuggest)
21
- * [badgeV1TagsSuggest](#badgev1tagssuggest)
22
- * [leaderboardV1GetLeaderboardAccountMeta](#leaderboardv1getleaderboardaccountmeta)
23
- * [check](#check) - Liveness check
24
-
25
- ## createDeveloperApp
26
-
27
- ### Example Usage
28
-
29
- ```typescript
30
- import { SteamSets } from "@steamsets/client-ts";
31
-
32
- const steamSets = new SteamSets({
33
- token: "<YOUR_BEARER_TOKEN_HERE>",
34
- });
35
-
36
- async function run() {
37
- const result = await steamSets.internal.createDeveloperApp({
38
- description: "Your App Description",
39
- environment: "production",
40
- generateKey: true,
41
- name: "Your App",
42
- });
43
-
44
- // Handle the result
45
- console.log(result);
46
- }
47
-
48
- run();
49
- ```
50
-
51
- ### Standalone function
52
-
53
- The standalone function version of this method:
54
-
55
- ```typescript
56
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
57
- import { internalCreateDeveloperApp } from "@steamsets/client-ts/funcs/internalCreateDeveloperApp.js";
58
-
59
- // Use `SteamSetsCore` for best tree-shaking performance.
60
- // You can create one instance of it to use across an application.
61
- const steamSets = new SteamSetsCore({
62
- token: "<YOUR_BEARER_TOKEN_HERE>",
63
- });
64
-
65
- async function run() {
66
- const res = await internalCreateDeveloperApp(steamSets, {
67
- description: "Your App Description",
68
- environment: "production",
69
- generateKey: true,
70
- name: "Your App",
71
- });
72
-
73
- if (!res.ok) {
74
- throw res.error;
75
- }
76
-
77
- const { value: result } = res;
78
-
79
- // Handle the result
80
- console.log(result);
81
- }
82
-
83
- run();
84
- ```
85
-
86
- ### Parameters
87
-
88
- | Parameter | Type | Required | Description |
89
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
90
- | `request` | [components.V1DeveloperAppCreateRequestBody](../../models/components/v1developerappcreaterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
91
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
92
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
93
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
94
-
95
- ### Response
96
-
97
- **Promise\<[operations.AccountV1SettingsDeveloperAppCreateResponse](../../models/operations/accountv1settingsdeveloperappcreateresponse.md)\>**
98
-
99
- ### Errors
100
-
101
- | Error Type | Status Code | Content Type |
102
- | ------------------------ | ------------------------ | ------------------------ |
103
- | errors.ErrorModel | 400, 404, 422 | application/problem+json |
104
- | errors.ErrorModel | 500 | application/problem+json |
105
- | errors.SDKError | 4XX, 5XX | \*/\* |
106
-
107
- ## deleteDeveloperApp
108
-
109
- ### Example Usage
110
-
111
- ```typescript
112
- import { SteamSets } from "@steamsets/client-ts";
113
-
114
- const steamSets = new SteamSets({
115
- token: "<YOUR_BEARER_TOKEN_HERE>",
116
- });
117
-
118
- async function run() {
119
- const result = await steamSets.internal.deleteDeveloperApp({
120
- developerAppId: "da_123456",
121
- });
122
-
123
- // Handle the result
124
- console.log(result);
125
- }
126
-
127
- run();
128
- ```
129
-
130
- ### Standalone function
131
-
132
- The standalone function version of this method:
133
-
134
- ```typescript
135
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
136
- import { internalDeleteDeveloperApp } from "@steamsets/client-ts/funcs/internalDeleteDeveloperApp.js";
137
-
138
- // Use `SteamSetsCore` for best tree-shaking performance.
139
- // You can create one instance of it to use across an application.
140
- const steamSets = new SteamSetsCore({
141
- token: "<YOUR_BEARER_TOKEN_HERE>",
142
- });
143
-
144
- async function run() {
145
- const res = await internalDeleteDeveloperApp(steamSets, {
146
- developerAppId: "da_123456",
147
- });
148
-
149
- if (!res.ok) {
150
- throw res.error;
151
- }
152
-
153
- const { value: result } = res;
154
-
155
- // Handle the result
156
- console.log(result);
157
- }
158
-
159
- run();
160
- ```
161
-
162
- ### Parameters
163
-
164
- | Parameter | Type | Required | Description |
165
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
166
- | `request` | [components.V1AccountDeveloperAppDeleteRequestBody](../../models/components/v1accountdeveloperappdeleterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
167
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
168
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
169
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
170
-
171
- ### Response
172
-
173
- **Promise\<[operations.AccountV1SettingsDeveloperAppDeleteResponse](../../models/operations/accountv1settingsdeveloperappdeleteresponse.md)\>**
174
-
175
- ### Errors
176
-
177
- | Error Type | Status Code | Content Type |
178
- | ------------------------ | ------------------------ | ------------------------ |
179
- | errors.ErrorModel | 404, 422, 429 | application/problem+json |
180
- | errors.ErrorModel | 500 | application/problem+json |
181
- | errors.SDKError | 4XX, 5XX | \*/\* |
182
-
183
- ## deleteImages
184
-
185
- ### Example Usage
186
-
187
- ```typescript
188
- import { SteamSets } from "@steamsets/client-ts";
189
-
190
- const steamSets = new SteamSets({
191
- token: "<YOUR_BEARER_TOKEN_HERE>",
192
- });
193
-
194
- async function run() {
195
- const result = await steamSets.internal.deleteImages({
196
- imageIds: [
197
- "<value>",
198
- "<value>",
199
- ],
200
- });
201
-
202
- // Handle the result
203
- console.log(result);
204
- }
205
-
206
- run();
207
- ```
208
-
209
- ### Standalone function
210
-
211
- The standalone function version of this method:
212
-
213
- ```typescript
214
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
215
- import { internalDeleteImages } from "@steamsets/client-ts/funcs/internalDeleteImages.js";
216
-
217
- // Use `SteamSetsCore` for best tree-shaking performance.
218
- // You can create one instance of it to use across an application.
219
- const steamSets = new SteamSetsCore({
220
- token: "<YOUR_BEARER_TOKEN_HERE>",
221
- });
222
-
223
- async function run() {
224
- const res = await internalDeleteImages(steamSets, {
225
- imageIds: [
226
- "<value>",
227
- "<value>",
228
- ],
229
- });
230
-
231
- if (!res.ok) {
232
- throw res.error;
233
- }
234
-
235
- const { value: result } = res;
236
-
237
- // Handle the result
238
- console.log(result);
239
- }
240
-
241
- run();
242
- ```
243
-
244
- ### Parameters
245
-
246
- | Parameter | Type | Required | Description |
247
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
248
- | `request` | [components.V1DeleteImagesRequestBody](../../models/components/v1deleteimagesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
249
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
250
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
251
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
252
-
253
- ### Response
254
-
255
- **Promise\<[operations.AccountV1ImagesDeleteResponse](../../models/operations/accountv1imagesdeleteresponse.md)\>**
256
-
257
- ### Errors
258
-
259
- | Error Type | Status Code | Content Type |
260
- | ------------------------ | ------------------------ | ------------------------ |
261
- | errors.ErrorModel | 404, 422 | application/problem+json |
262
- | errors.ErrorModel | 500 | application/problem+json |
263
- | errors.SDKError | 4XX, 5XX | \*/\* |
264
-
265
- ## updateApp
266
-
267
- ### Example Usage
268
-
269
- ```typescript
270
- import { SteamSets } from "@steamsets/client-ts";
271
-
272
- const steamSets = new SteamSets({
273
- token: "<YOUR_BEARER_TOKEN_HERE>",
274
- });
275
-
276
- async function run() {
277
- const result = await steamSets.internal.updateApp({
278
- description: "My App Description",
279
- developerAppId: "da_123456",
280
- name: "My App",
281
- regenerate: true,
282
- });
283
-
284
- // Handle the result
285
- console.log(result);
286
- }
287
-
288
- run();
289
- ```
290
-
291
- ### Standalone function
292
-
293
- The standalone function version of this method:
294
-
295
- ```typescript
296
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
297
- import { internalUpdateApp } from "@steamsets/client-ts/funcs/internalUpdateApp.js";
298
-
299
- // Use `SteamSetsCore` for best tree-shaking performance.
300
- // You can create one instance of it to use across an application.
301
- const steamSets = new SteamSetsCore({
302
- token: "<YOUR_BEARER_TOKEN_HERE>",
303
- });
304
-
305
- async function run() {
306
- const res = await internalUpdateApp(steamSets, {
307
- description: "My App Description",
308
- developerAppId: "da_123456",
309
- name: "My App",
310
- regenerate: true,
311
- });
312
-
313
- if (!res.ok) {
314
- throw res.error;
315
- }
316
-
317
- const { value: result } = res;
318
-
319
- // Handle the result
320
- console.log(result);
321
- }
322
-
323
- run();
324
- ```
325
-
326
- ### Parameters
327
-
328
- | Parameter | Type | Required | Description |
329
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
330
- | `request` | [components.V1AccountDeveloperAppUpdateRequestBody](../../models/components/v1accountdeveloperappupdaterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
331
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
332
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
333
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
334
-
335
- ### Response
336
-
337
- **Promise\<[operations.AccountV1SettingsDeveloperAppUpdateResponse](../../models/operations/accountv1settingsdeveloperappupdateresponse.md)\>**
338
-
339
- ### Errors
340
-
341
- | Error Type | Status Code | Content Type |
342
- | ------------------------ | ------------------------ | ------------------------ |
343
- | errors.ErrorModel | 404, 422, 429 | application/problem+json |
344
- | errors.ErrorModel | 500 | application/problem+json |
345
- | errors.SDKError | 4XX, 5XX | \*/\* |
346
-
347
- ## accountV1GetMeta
348
-
349
- ### Example Usage
350
-
351
- ```typescript
352
- import { SteamSets } from "@steamsets/client-ts";
353
-
354
- const steamSets = new SteamSets({
355
- token: "<YOUR_BEARER_TOKEN_HERE>",
356
- });
357
-
358
- async function run() {
359
- const result = await steamSets.internal.accountV1GetMeta({});
360
-
361
- // Handle the result
362
- console.log(result);
363
- }
364
-
365
- run();
366
- ```
367
-
368
- ### Standalone function
369
-
370
- The standalone function version of this method:
371
-
372
- ```typescript
373
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
374
- import { internalAccountV1GetMeta } from "@steamsets/client-ts/funcs/internalAccountV1GetMeta.js";
375
-
376
- // Use `SteamSetsCore` for best tree-shaking performance.
377
- // You can create one instance of it to use across an application.
378
- const steamSets = new SteamSetsCore({
379
- token: "<YOUR_BEARER_TOKEN_HERE>",
380
- });
381
-
382
- async function run() {
383
- const res = await internalAccountV1GetMeta(steamSets, {});
384
-
385
- if (!res.ok) {
386
- throw res.error;
387
- }
388
-
389
- const { value: result } = res;
390
-
391
- // Handle the result
392
- console.log(result);
393
- }
394
-
395
- run();
396
- ```
397
-
398
- ### Parameters
399
-
400
- | Parameter | Type | Required | Description |
401
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
402
- | `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
403
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
404
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
405
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
406
-
407
- ### Response
408
-
409
- **Promise\<[operations.AccountV1GetMetaResponse](../../models/operations/accountv1getmetaresponse.md)\>**
410
-
411
- ### Errors
412
-
413
- | Error Type | Status Code | Content Type |
414
- | ------------------------ | ------------------------ | ------------------------ |
415
- | errors.ErrorModel | 404, 422 | application/problem+json |
416
- | errors.ErrorModel | 500 | application/problem+json |
417
- | errors.SDKError | 4XX, 5XX | \*/\* |
418
-
419
- ## getStaff
420
-
421
- ### Example Usage
422
-
423
- ```typescript
424
- import { SteamSets } from "@steamsets/client-ts";
425
-
426
- const steamSets = new SteamSets({
427
- token: "<YOUR_BEARER_TOKEN_HERE>",
428
- });
429
-
430
- async function run() {
431
- const result = await steamSets.internal.getStaff();
432
-
433
- // Handle the result
434
- console.log(result);
435
- }
436
-
437
- run();
438
- ```
439
-
440
- ### Standalone function
441
-
442
- The standalone function version of this method:
443
-
444
- ```typescript
445
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
446
- import { internalGetStaff } from "@steamsets/client-ts/funcs/internalGetStaff.js";
447
-
448
- // Use `SteamSetsCore` for best tree-shaking performance.
449
- // You can create one instance of it to use across an application.
450
- const steamSets = new SteamSetsCore({
451
- token: "<YOUR_BEARER_TOKEN_HERE>",
452
- });
453
-
454
- async function run() {
455
- const res = await internalGetStaff(steamSets);
456
-
457
- if (!res.ok) {
458
- throw res.error;
459
- }
460
-
461
- const { value: result } = res;
462
-
463
- // Handle the result
464
- console.log(result);
465
- }
466
-
467
- run();
468
- ```
469
-
470
- ### Parameters
471
-
472
- | Parameter | Type | Required | Description |
473
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
474
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
475
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
476
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
477
-
478
- ### Response
479
-
480
- **Promise\<[operations.AccountV1GetStaffResponse](../../models/operations/accountv1getstaffresponse.md)\>**
481
-
482
- ### Errors
483
-
484
- | Error Type | Status Code | Content Type |
485
- | ------------------------ | ------------------------ | ------------------------ |
486
- | errors.ErrorModel | 404, 429 | application/problem+json |
487
- | errors.ErrorModel | 500 | application/problem+json |
488
- | errors.SDKError | 4XX, 5XX | \*/\* |
489
-
490
- ## uploadImages
491
-
492
- ### Example Usage
493
-
494
- ```typescript
495
- import { SteamSets } from "@steamsets/client-ts";
496
-
497
- const steamSets = new SteamSets({
498
- token: "<YOUR_BEARER_TOKEN_HERE>",
499
- });
500
-
501
- async function run() {
502
- const result = await steamSets.internal.uploadImages({
503
- images: [
504
-
505
- ],
506
- });
507
-
508
- // Handle the result
509
- console.log(result);
510
- }
511
-
512
- run();
513
- ```
514
-
515
- ### Standalone function
516
-
517
- The standalone function version of this method:
518
-
519
- ```typescript
520
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
521
- import { internalUploadImages } from "@steamsets/client-ts/funcs/internalUploadImages.js";
522
-
523
- // Use `SteamSetsCore` for best tree-shaking performance.
524
- // You can create one instance of it to use across an application.
525
- const steamSets = new SteamSetsCore({
526
- token: "<YOUR_BEARER_TOKEN_HERE>",
527
- });
528
-
529
- async function run() {
530
- const res = await internalUploadImages(steamSets, {
531
- images: [
532
-
533
- ],
534
- });
535
-
536
- if (!res.ok) {
537
- throw res.error;
538
- }
539
-
540
- const { value: result } = res;
541
-
542
- // Handle the result
543
- console.log(result);
544
- }
545
-
546
- run();
547
- ```
548
-
549
- ### Parameters
550
-
551
- | Parameter | Type | Required | Description |
552
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
553
- | `request` | [components.V1UploadImagesRequestBody](../../models/components/v1uploadimagesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
554
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
555
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
556
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
557
-
558
- ### Response
559
-
560
- **Promise\<[operations.AccountV1ImagesUploadResponse](../../models/operations/accountv1imagesuploadresponse.md)\>**
561
-
562
- ### Errors
563
-
564
- | Error Type | Status Code | Content Type |
565
- | ------------------------ | ------------------------ | ------------------------ |
566
- | errors.ErrorModel | 422 | application/problem+json |
567
- | errors.ErrorModel | 500 | application/problem+json |
568
- | errors.SDKError | 4XX, 5XX | \*/\* |
569
-
570
- ## getAccount
571
-
572
- ### Example Usage
573
-
574
- ```typescript
575
- import { SteamSets } from "@steamsets/client-ts";
576
-
577
- const steamSets = new SteamSets({
578
- token: "<YOUR_BEARER_TOKEN_HERE>",
579
- });
580
-
581
- async function run() {
582
- const result = await steamSets.internal.getAccount({});
583
-
584
- // Handle the result
585
- console.log(result);
586
- }
587
-
588
- run();
589
- ```
590
-
591
- ### Standalone function
592
-
593
- The standalone function version of this method:
594
-
595
- ```typescript
596
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
597
- import { internalGetAccount } from "@steamsets/client-ts/funcs/internalGetAccount.js";
598
-
599
- // Use `SteamSetsCore` for best tree-shaking performance.
600
- // You can create one instance of it to use across an application.
601
- const steamSets = new SteamSetsCore({
602
- token: "<YOUR_BEARER_TOKEN_HERE>",
603
- });
604
-
605
- async function run() {
606
- const res = await internalGetAccount(steamSets, {});
607
-
608
- if (!res.ok) {
609
- throw res.error;
610
- }
611
-
612
- const { value: result } = res;
613
-
614
- // Handle the result
615
- console.log(result);
616
- }
617
-
618
- run();
619
- ```
620
-
621
- ### Parameters
622
-
623
- | Parameter | Type | Required | Description |
624
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
625
- | `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
626
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
627
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
628
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
629
-
630
- ### Response
631
-
632
- **Promise\<[operations.AdminV1GetAccountResponse](../../models/operations/adminv1getaccountresponse.md)\>**
633
-
634
- ### Errors
635
-
636
- | Error Type | Status Code | Content Type |
637
- | ------------------------ | ------------------------ | ------------------------ |
638
- | errors.ErrorModel | 403, 404, 422, 429 | application/problem+json |
639
- | errors.ErrorModel | 500 | application/problem+json |
640
- | errors.SDKError | 4XX, 5XX | \*/\* |
641
-
642
- ## adminV1RemoveVanity
643
-
644
- ### Example Usage
645
-
646
- ```typescript
647
- import { SteamSets } from "@steamsets/client-ts";
648
-
649
- const steamSets = new SteamSets({
650
- token: "<YOUR_BEARER_TOKEN_HERE>",
651
- });
652
-
653
- async function run() {
654
- const result = await steamSets.internal.adminV1RemoveVanity({});
655
-
656
- // Handle the result
657
- console.log(result);
658
- }
659
-
660
- run();
661
- ```
662
-
663
- ### Standalone function
664
-
665
- The standalone function version of this method:
666
-
667
- ```typescript
668
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
669
- import { internalAdminV1RemoveVanity } from "@steamsets/client-ts/funcs/internalAdminV1RemoveVanity.js";
670
-
671
- // Use `SteamSetsCore` for best tree-shaking performance.
672
- // You can create one instance of it to use across an application.
673
- const steamSets = new SteamSetsCore({
674
- token: "<YOUR_BEARER_TOKEN_HERE>",
675
- });
676
-
677
- async function run() {
678
- const res = await internalAdminV1RemoveVanity(steamSets, {});
679
-
680
- if (!res.ok) {
681
- throw res.error;
682
- }
683
-
684
- const { value: result } = res;
685
-
686
- // Handle the result
687
- console.log(result);
688
- }
689
-
690
- run();
691
- ```
692
-
693
- ### Parameters
694
-
695
- | Parameter | Type | Required | Description |
696
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
697
- | `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
698
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
699
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
700
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
701
-
702
- ### Response
703
-
704
- **Promise\<[operations.AdminV1RemoveVanityResponse](../../models/operations/adminv1removevanityresponse.md)\>**
705
-
706
- ### Errors
707
-
708
- | Error Type | Status Code | Content Type |
709
- | ------------------------ | ------------------------ | ------------------------ |
710
- | errors.ErrorModel | 403, 404, 422, 429 | application/problem+json |
711
- | errors.ErrorModel | 500 | application/problem+json |
712
- | errors.SDKError | 4XX, 5XX | \*/\* |
713
-
714
- ## getTags
715
-
716
- ### Example Usage
717
-
718
- ```typescript
719
- import { SteamSets } from "@steamsets/client-ts";
720
-
721
- const steamSets = new SteamSets({
722
- token: "<YOUR_BEARER_TOKEN_HERE>",
723
- });
724
-
725
- async function run() {
726
- const result = await steamSets.internal.getTags();
727
-
728
- // Handle the result
729
- console.log(result);
730
- }
731
-
732
- run();
733
- ```
734
-
735
- ### Standalone function
736
-
737
- The standalone function version of this method:
738
-
739
- ```typescript
740
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
741
- import { internalGetTags } from "@steamsets/client-ts/funcs/internalGetTags.js";
742
-
743
- // Use `SteamSetsCore` for best tree-shaking performance.
744
- // You can create one instance of it to use across an application.
745
- const steamSets = new SteamSetsCore({
746
- token: "<YOUR_BEARER_TOKEN_HERE>",
747
- });
748
-
749
- async function run() {
750
- const res = await internalGetTags(steamSets);
751
-
752
- if (!res.ok) {
753
- throw res.error;
754
- }
755
-
756
- const { value: result } = res;
757
-
758
- // Handle the result
759
- console.log(result);
760
- }
761
-
762
- run();
763
- ```
764
-
765
- ### Parameters
766
-
767
- | Parameter | Type | Required | Description |
768
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
769
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
770
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
771
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
772
-
773
- ### Response
774
-
775
- **Promise\<[operations.BadgeV1TagsResponse](../../models/operations/badgev1tagsresponse.md)\>**
776
-
777
- ### Errors
778
-
779
- | Error Type | Status Code | Content Type |
780
- | ------------------------ | ------------------------ | ------------------------ |
781
- | errors.ErrorModel | 403, 404 | application/problem+json |
782
- | errors.ErrorModel | 500 | application/problem+json |
783
- | errors.SDKError | 4XX, 5XX | \*/\* |
784
-
785
- ## badgeV1SearchSuggest
786
-
787
- ### Example Usage
788
-
789
- ```typescript
790
- import { SteamSets } from "@steamsets/client-ts";
791
-
792
- const steamSets = new SteamSets({
793
- token: "<YOUR_BEARER_TOKEN_HERE>",
794
- });
795
-
796
- async function run() {
797
- const result = await steamSets.internal.badgeV1SearchSuggest({
798
- query: "<value>",
799
- });
800
-
801
- // Handle the result
802
- console.log(result);
803
- }
804
-
805
- run();
806
- ```
807
-
808
- ### Standalone function
809
-
810
- The standalone function version of this method:
811
-
812
- ```typescript
813
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
814
- import { internalBadgeV1SearchSuggest } from "@steamsets/client-ts/funcs/internalBadgeV1SearchSuggest.js";
815
-
816
- // Use `SteamSetsCore` for best tree-shaking performance.
817
- // You can create one instance of it to use across an application.
818
- const steamSets = new SteamSetsCore({
819
- token: "<YOUR_BEARER_TOKEN_HERE>",
820
- });
821
-
822
- async function run() {
823
- const res = await internalBadgeV1SearchSuggest(steamSets, {
824
- query: "<value>",
825
- });
826
-
827
- if (!res.ok) {
828
- throw res.error;
829
- }
830
-
831
- const { value: result } = res;
832
-
833
- // Handle the result
834
- console.log(result);
835
- }
836
-
837
- run();
838
- ```
839
-
840
- ### Parameters
841
-
842
- | Parameter | Type | Required | Description |
843
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
844
- | `request` | [components.V1BadgeSearchSuggesttRequestBody](../../models/components/v1badgesearchsuggesttrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
845
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
846
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
847
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
848
-
849
- ### Response
850
-
851
- **Promise\<[operations.BadgeV1SearchSuggestResponse](../../models/operations/badgev1searchsuggestresponse.md)\>**
852
-
853
- ### Errors
854
-
855
- | Error Type | Status Code | Content Type |
856
- | ------------------------ | ------------------------ | ------------------------ |
857
- | errors.ErrorModel | 403, 404, 422 | application/problem+json |
858
- | errors.ErrorModel | 500 | application/problem+json |
859
- | errors.SDKError | 4XX, 5XX | \*/\* |
860
-
861
- ## badgeV1TagsSuggest
862
-
863
- ### Example Usage
864
-
865
- ```typescript
866
- import { SteamSets } from "@steamsets/client-ts";
867
-
868
- const steamSets = new SteamSets({
869
- token: "<YOUR_BEARER_TOKEN_HERE>",
870
- });
871
-
872
- async function run() {
873
- const result = await steamSets.internal.badgeV1TagsSuggest({
874
- badgeId: "<id>",
875
- });
876
-
877
- // Handle the result
878
- console.log(result);
879
- }
880
-
881
- run();
882
- ```
883
-
884
- ### Standalone function
885
-
886
- The standalone function version of this method:
887
-
888
- ```typescript
889
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
890
- import { internalBadgeV1TagsSuggest } from "@steamsets/client-ts/funcs/internalBadgeV1TagsSuggest.js";
891
-
892
- // Use `SteamSetsCore` for best tree-shaking performance.
893
- // You can create one instance of it to use across an application.
894
- const steamSets = new SteamSetsCore({
895
- token: "<YOUR_BEARER_TOKEN_HERE>",
896
- });
897
-
898
- async function run() {
899
- const res = await internalBadgeV1TagsSuggest(steamSets, {
900
- badgeId: "<id>",
901
- });
902
-
903
- if (!res.ok) {
904
- throw res.error;
905
- }
906
-
907
- const { value: result } = res;
908
-
909
- // Handle the result
910
- console.log(result);
911
- }
912
-
913
- run();
914
- ```
915
-
916
- ### Parameters
917
-
918
- | Parameter | Type | Required | Description |
919
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
920
- | `request` | [components.V1BadgeTagsSuggestRequestBody](../../models/components/v1badgetagssuggestrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
921
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
922
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
923
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
924
-
925
- ### Response
926
-
927
- **Promise\<[operations.BadgeV1TagsSuggestResponse](../../models/operations/badgev1tagssuggestresponse.md)\>**
928
-
929
- ### Errors
930
-
931
- | Error Type | Status Code | Content Type |
932
- | ------------------------ | ------------------------ | ------------------------ |
933
- | errors.ErrorModel | 403, 404, 422 | application/problem+json |
934
- | errors.ErrorModel | 500 | application/problem+json |
935
- | errors.SDKError | 4XX, 5XX | \*/\* |
936
-
937
- ## leaderboardV1GetLeaderboardAccountMeta
938
-
939
- ### Example Usage
940
-
941
- ```typescript
942
- import { SteamSets } from "@steamsets/client-ts";
943
-
944
- const steamSets = new SteamSets({
945
- token: "<YOUR_BEARER_TOKEN_HERE>",
946
- });
947
-
948
- async function run() {
949
- const result = await steamSets.internal.leaderboardV1GetLeaderboardAccountMeta({
950
- app: {
951
- appId: 730,
952
- },
953
- badge: {
954
- id: 75458,
955
- isFoil: true,
956
- },
957
- leaderboard: "xp",
958
- location: [
959
- {
960
- city: "Bad Krozingen",
961
- country: "Germany",
962
- region: "Europe",
963
- state: "Baden-Wurttemberg",
964
- },
965
- {
966
- city: "Bad Krozingen",
967
- country: "Germany",
968
- region: "Europe",
969
- state: "Baden-Wurttemberg",
970
- },
971
- {
972
- city: "Bad Krozingen",
973
- country: "Germany",
974
- region: "Europe",
975
- state: "Baden-Wurttemberg",
976
- },
977
- ],
978
- });
979
-
980
- // Handle the result
981
- console.log(result);
982
- }
983
-
984
- run();
985
- ```
986
-
987
- ### Standalone function
988
-
989
- The standalone function version of this method:
990
-
991
- ```typescript
992
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
993
- import { internalLeaderboardV1GetLeaderboardAccountMeta } from "@steamsets/client-ts/funcs/internalLeaderboardV1GetLeaderboardAccountMeta.js";
994
-
995
- // Use `SteamSetsCore` for best tree-shaking performance.
996
- // You can create one instance of it to use across an application.
997
- const steamSets = new SteamSetsCore({
998
- token: "<YOUR_BEARER_TOKEN_HERE>",
999
- });
1000
-
1001
- async function run() {
1002
- const res = await internalLeaderboardV1GetLeaderboardAccountMeta(steamSets, {
1003
- app: {
1004
- appId: 730,
1005
- },
1006
- badge: {
1007
- id: 75458,
1008
- isFoil: true,
1009
- },
1010
- leaderboard: "xp",
1011
- location: [
1012
- {
1013
- city: "Bad Krozingen",
1014
- country: "Germany",
1015
- region: "Europe",
1016
- state: "Baden-Wurttemberg",
1017
- },
1018
- {
1019
- city: "Bad Krozingen",
1020
- country: "Germany",
1021
- region: "Europe",
1022
- state: "Baden-Wurttemberg",
1023
- },
1024
- {
1025
- city: "Bad Krozingen",
1026
- country: "Germany",
1027
- region: "Europe",
1028
- state: "Baden-Wurttemberg",
1029
- },
1030
- ],
1031
- });
1032
-
1033
- if (!res.ok) {
1034
- throw res.error;
1035
- }
1036
-
1037
- const { value: result } = res;
1038
-
1039
- // Handle the result
1040
- console.log(result);
1041
- }
1042
-
1043
- run();
1044
- ```
1045
-
1046
- ### Parameters
1047
-
1048
- | Parameter | Type | Required | Description |
1049
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1050
- | `request` | [components.V1LeaderboardAccountMetaRequestBody](../../models/components/v1leaderboardaccountmetarequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1051
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1052
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1053
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1054
-
1055
- ### Response
1056
-
1057
- **Promise\<[operations.LeaderboardV1GetLeaderboardAccountMetaResponse](../../models/operations/leaderboardv1getleaderboardaccountmetaresponse.md)\>**
1058
-
1059
- ### Errors
1060
-
1061
- | Error Type | Status Code | Content Type |
1062
- | ------------------------ | ------------------------ | ------------------------ |
1063
- | errors.ErrorModel | 404, 422 | application/problem+json |
1064
- | errors.ErrorModel | 500 | application/problem+json |
1065
- | errors.SDKError | 4XX, 5XX | \*/\* |
1066
-
1067
- ## check
1068
-
1069
- This endpoint checks if the service is alive.
1070
-
1071
- ### Example Usage
1072
-
1073
- ```typescript
1074
- import { SteamSets } from "@steamsets/client-ts";
1075
-
1076
- const steamSets = new SteamSets({
1077
- token: "<YOUR_BEARER_TOKEN_HERE>",
1078
- });
1079
-
1080
- async function run() {
1081
- const result = await steamSets.internal.check();
1082
-
1083
- // Handle the result
1084
- console.log(result);
1085
- }
1086
-
1087
- run();
1088
- ```
1089
-
1090
- ### Standalone function
1091
-
1092
- The standalone function version of this method:
1093
-
1094
- ```typescript
1095
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
1096
- import { internalCheck } from "@steamsets/client-ts/funcs/internalCheck.js";
1097
-
1098
- // Use `SteamSetsCore` for best tree-shaking performance.
1099
- // You can create one instance of it to use across an application.
1100
- const steamSets = new SteamSetsCore({
1101
- token: "<YOUR_BEARER_TOKEN_HERE>",
1102
- });
1103
-
1104
- async function run() {
1105
- const res = await internalCheck(steamSets);
1106
-
1107
- if (!res.ok) {
1108
- throw res.error;
1109
- }
1110
-
1111
- const { value: result } = res;
1112
-
1113
- // Handle the result
1114
- console.log(result);
1115
- }
1116
-
1117
- run();
1118
- ```
1119
-
1120
- ### Parameters
1121
-
1122
- | Parameter | Type | Required | Description |
1123
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1124
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1125
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
1126
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1127
-
1128
- ### Response
1129
-
1130
- **Promise\<[operations.LivenessResponse](../../models/operations/livenessresponse.md)\>**
1131
-
1132
- ### Errors
1133
-
1134
- | Error Type | Status Code | Content Type |
1135
- | ------------------------ | ------------------------ | ------------------------ |
1136
- | errors.ErrorModel | 500 | application/problem+json |
1137
- | errors.SDKError | 4XX, 5XX | \*/\* |