@steamsets/client-ts 0.19.3 → 0.19.5

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 (285) hide show
  1. package/README.md +6 -82
  2. package/docs/sdks/account/README.md +0 -180
  3. package/docs/sdks/admin/README.md +73 -0
  4. package/docs/sdks/badge/README.md +77 -0
  5. package/docs/sdks/images/README.md +0 -164
  6. package/docs/sdks/leaderboard/README.md +32 -8
  7. package/funcs/{externalGetApps.d.ts → adminAdminV1RemoveVanity.d.ts} +2 -2
  8. package/funcs/{internalAccountV1GetMeta.d.ts.map → adminAdminV1RemoveVanity.d.ts.map} +1 -1
  9. package/funcs/{accountGetAccount.js → adminAdminV1RemoveVanity.js} +7 -7
  10. package/funcs/{internalAccountV1GetMeta.js.map → adminAdminV1RemoveVanity.js.map} +1 -1
  11. package/funcs/{accountGetAccount.d.ts → badgeBadgeV1SearchSuggest.d.ts} +2 -2
  12. package/funcs/{dataGetLeaderboardHistory.d.ts.map → badgeBadgeV1SearchSuggest.d.ts.map} +1 -1
  13. package/funcs/{internalBadgeV1TagsSuggest.js → badgeBadgeV1SearchSuggest.js} +8 -8
  14. package/funcs/{dataGetLeaderboardHistory.js.map → badgeBadgeV1SearchSuggest.js.map} +1 -1
  15. package/funcs/{accountLeaderboardV1GetAccountMeta.d.ts → leaderboardLeaderboardV1GetLeaderboardAccountMeta.d.ts} +2 -2
  16. package/funcs/{externalGetBadges.d.ts.map → leaderboardLeaderboardV1GetLeaderboardAccountMeta.d.ts.map} +1 -1
  17. package/funcs/{internalLeaderboardV1GetAccountMeta.js → leaderboardLeaderboardV1GetLeaderboardAccountMeta.js} +5 -7
  18. package/funcs/leaderboardLeaderboardV1GetLeaderboardAccountMeta.js.map +1 -0
  19. package/jsr.json +1 -1
  20. package/lib/config.d.ts +2 -2
  21. package/lib/config.js +2 -2
  22. package/models/components/index.d.ts +3 -0
  23. package/models/components/index.d.ts.map +1 -1
  24. package/models/components/index.js +3 -0
  25. package/models/components/index.js.map +1 -1
  26. package/models/components/v1adminremovevanityresponsebody.d.ts +32 -0
  27. package/models/components/v1adminremovevanityresponsebody.d.ts.map +1 -0
  28. package/models/components/v1adminremovevanityresponsebody.js +68 -0
  29. package/models/components/v1adminremovevanityresponsebody.js.map +1 -0
  30. package/models/components/v1badgesearchsuggestbody.d.ts +37 -0
  31. package/models/components/v1badgesearchsuggestbody.d.ts.map +1 -0
  32. package/models/components/v1badgesearchsuggestbody.js +70 -0
  33. package/models/components/v1badgesearchsuggestbody.js.map +1 -0
  34. package/models/components/v1badgesearchsuggesttrequestbody.d.ts +32 -0
  35. package/models/components/v1badgesearchsuggesttrequestbody.d.ts.map +1 -0
  36. package/models/components/v1badgesearchsuggesttrequestbody.js +59 -0
  37. package/models/components/v1badgesearchsuggesttrequestbody.js.map +1 -0
  38. package/models/operations/adminv1removevanity.d.ts +35 -0
  39. package/models/operations/adminv1removevanity.d.ts.map +1 -0
  40. package/models/operations/adminv1removevanity.js +75 -0
  41. package/models/operations/adminv1removevanity.js.map +1 -0
  42. package/models/operations/badgev1searchsuggest.d.ts +35 -0
  43. package/models/operations/badgev1searchsuggest.d.ts.map +1 -0
  44. package/models/operations/badgev1searchsuggest.js +75 -0
  45. package/models/operations/badgev1searchsuggest.js.map +1 -0
  46. package/models/operations/index.d.ts +3 -1
  47. package/models/operations/index.d.ts.map +1 -1
  48. package/models/operations/index.js +3 -1
  49. package/models/operations/index.js.map +1 -1
  50. package/models/operations/leaderboardv1getleaderboardaccountmeta.d.ts +35 -0
  51. package/models/operations/leaderboardv1getleaderboardaccountmeta.d.ts.map +1 -0
  52. package/models/operations/{leaderboardv1getaccountmeta.js → leaderboardv1getleaderboardaccountmeta.js} +17 -17
  53. package/models/operations/leaderboardv1getleaderboardaccountmeta.js.map +1 -0
  54. package/package.json +1 -1
  55. package/sdk/account.d.ts +0 -2
  56. package/sdk/account.d.ts.map +1 -1
  57. package/sdk/account.js +0 -8
  58. package/sdk/account.js.map +1 -1
  59. package/sdk/admin.d.ts +1 -0
  60. package/sdk/admin.d.ts.map +1 -1
  61. package/sdk/admin.js +4 -0
  62. package/sdk/admin.js.map +1 -1
  63. package/sdk/badge.d.ts +1 -0
  64. package/sdk/badge.d.ts.map +1 -1
  65. package/sdk/badge.js +4 -0
  66. package/sdk/badge.js.map +1 -1
  67. package/sdk/images.d.ts +0 -2
  68. package/sdk/images.d.ts.map +1 -1
  69. package/sdk/images.js +0 -8
  70. package/sdk/images.js.map +1 -1
  71. package/sdk/leaderboard.d.ts +1 -1
  72. package/sdk/leaderboard.d.ts.map +1 -1
  73. package/sdk/leaderboard.js +3 -3
  74. package/sdk/leaderboard.js.map +1 -1
  75. package/sdk/sdk.d.ts +2 -14
  76. package/sdk/sdk.d.ts.map +1 -1
  77. package/sdk/sdk.js +2 -18
  78. package/sdk/sdk.js.map +1 -1
  79. package/src/funcs/{externalGetInfo.ts → adminAdminV1RemoveVanity.ts} +8 -8
  80. package/src/funcs/{internalBadgeV1TagsSuggest.ts → badgeBadgeV1SearchSuggest.ts} +11 -11
  81. package/src/funcs/{internalLeaderboardV1GetAccountMeta.ts → leaderboardLeaderboardV1GetLeaderboardAccountMeta.ts} +10 -8
  82. package/src/lib/config.ts +2 -2
  83. package/src/models/components/index.ts +3 -0
  84. package/src/models/components/v1adminremovevanityresponsebody.ts +80 -0
  85. package/src/models/components/v1badgesearchsuggestbody.ts +85 -0
  86. package/src/models/components/v1badgesearchsuggesttrequestbody.ts +71 -0
  87. package/src/models/operations/adminv1removevanity.ts +93 -0
  88. package/src/models/operations/badgev1searchsuggest.ts +91 -0
  89. package/src/models/operations/index.ts +3 -1
  90. package/src/models/operations/leaderboardv1getleaderboardaccountmeta.ts +107 -0
  91. package/src/sdk/account.ts +0 -24
  92. package/src/sdk/admin.ts +12 -0
  93. package/src/sdk/badge.ts +12 -0
  94. package/src/sdk/images.ts +0 -24
  95. package/src/sdk/leaderboard.ts +4 -4
  96. package/src/sdk/sdk.ts +3 -27
  97. package/docs/sdks/data/README.md +0 -520
  98. package/docs/sdks/developer/README.md +0 -252
  99. package/docs/sdks/external/README.md +0 -596
  100. package/docs/sdks/internal/README.md +0 -963
  101. package/funcs/accountGetAccount.d.ts.map +0 -1
  102. package/funcs/accountGetAccount.js.map +0 -1
  103. package/funcs/accountLeaderboardV1GetAccountMeta.d.ts.map +0 -1
  104. package/funcs/accountLeaderboardV1GetAccountMeta.js +0 -118
  105. package/funcs/accountLeaderboardV1GetAccountMeta.js.map +0 -1
  106. package/funcs/dataAccountV1GetMeta.d.ts +0 -12
  107. package/funcs/dataAccountV1GetMeta.d.ts.map +0 -1
  108. package/funcs/dataAccountV1GetMeta.js +0 -118
  109. package/funcs/dataAccountV1GetMeta.js.map +0 -1
  110. package/funcs/dataGetApps.d.ts +0 -12
  111. package/funcs/dataGetApps.d.ts.map +0 -1
  112. package/funcs/dataGetApps.js +0 -118
  113. package/funcs/dataGetApps.js.map +0 -1
  114. package/funcs/dataGetBadges.d.ts +0 -12
  115. package/funcs/dataGetBadges.d.ts.map +0 -1
  116. package/funcs/dataGetBadges.js +0 -118
  117. package/funcs/dataGetBadges.js.map +0 -1
  118. package/funcs/dataGetDataPoints.d.ts +0 -12
  119. package/funcs/dataGetDataPoints.d.ts.map +0 -1
  120. package/funcs/dataGetDataPoints.js +0 -118
  121. package/funcs/dataGetDataPoints.js.map +0 -1
  122. package/funcs/dataGetFriends.d.ts +0 -12
  123. package/funcs/dataGetFriends.d.ts.map +0 -1
  124. package/funcs/dataGetFriends.js +0 -118
  125. package/funcs/dataGetFriends.js.map +0 -1
  126. package/funcs/dataGetInfo.d.ts +0 -12
  127. package/funcs/dataGetInfo.d.ts.map +0 -1
  128. package/funcs/dataGetInfo.js +0 -118
  129. package/funcs/dataGetInfo.js.map +0 -1
  130. package/funcs/dataGetLeaderboardHistory.d.ts +0 -12
  131. package/funcs/dataGetLeaderboardHistory.js +0 -116
  132. package/funcs/developerCreateDeveloperApp.d.ts +0 -12
  133. package/funcs/developerCreateDeveloperApp.d.ts.map +0 -1
  134. package/funcs/developerCreateDeveloperApp.js +0 -116
  135. package/funcs/developerCreateDeveloperApp.js.map +0 -1
  136. package/funcs/developerDeleteDeveloperApp.d.ts +0 -12
  137. package/funcs/developerDeleteDeveloperApp.d.ts.map +0 -1
  138. package/funcs/developerDeleteDeveloperApp.js +0 -116
  139. package/funcs/developerDeleteDeveloperApp.js.map +0 -1
  140. package/funcs/developerUpdateApp.d.ts +0 -12
  141. package/funcs/developerUpdateApp.d.ts.map +0 -1
  142. package/funcs/developerUpdateApp.js +0 -116
  143. package/funcs/developerUpdateApp.js.map +0 -1
  144. package/funcs/externalAppV1ListBadges.d.ts +0 -12
  145. package/funcs/externalAppV1ListBadges.d.ts.map +0 -1
  146. package/funcs/externalAppV1ListBadges.js +0 -118
  147. package/funcs/externalAppV1ListBadges.js.map +0 -1
  148. package/funcs/externalGet.d.ts +0 -11
  149. package/funcs/externalGet.d.ts.map +0 -1
  150. package/funcs/externalGet.js +0 -107
  151. package/funcs/externalGet.js.map +0 -1
  152. package/funcs/externalGetApps.d.ts.map +0 -1
  153. package/funcs/externalGetApps.js +0 -118
  154. package/funcs/externalGetApps.js.map +0 -1
  155. package/funcs/externalGetBadges.d.ts +0 -12
  156. package/funcs/externalGetBadges.js +0 -118
  157. package/funcs/externalGetBadges.js.map +0 -1
  158. package/funcs/externalGetDataPoints.d.ts +0 -12
  159. package/funcs/externalGetDataPoints.d.ts.map +0 -1
  160. package/funcs/externalGetDataPoints.js +0 -118
  161. package/funcs/externalGetDataPoints.js.map +0 -1
  162. package/funcs/externalGetFriends.d.ts +0 -12
  163. package/funcs/externalGetFriends.d.ts.map +0 -1
  164. package/funcs/externalGetFriends.js +0 -118
  165. package/funcs/externalGetFriends.js.map +0 -1
  166. package/funcs/externalGetInfo.d.ts +0 -12
  167. package/funcs/externalGetInfo.d.ts.map +0 -1
  168. package/funcs/externalGetInfo.js +0 -118
  169. package/funcs/externalGetInfo.js.map +0 -1
  170. package/funcs/externalGetLeaderboardHistory.d.ts +0 -12
  171. package/funcs/externalGetLeaderboardHistory.d.ts.map +0 -1
  172. package/funcs/externalGetLeaderboardHistory.js +0 -116
  173. package/funcs/externalGetLeaderboardHistory.js.map +0 -1
  174. package/funcs/imagesDeleteImages.d.ts +0 -12
  175. package/funcs/imagesDeleteImages.d.ts.map +0 -1
  176. package/funcs/imagesDeleteImages.js +0 -118
  177. package/funcs/imagesDeleteImages.js.map +0 -1
  178. package/funcs/imagesUploadImages.d.ts +0 -12
  179. package/funcs/imagesUploadImages.d.ts.map +0 -1
  180. package/funcs/imagesUploadImages.js +0 -118
  181. package/funcs/imagesUploadImages.js.map +0 -1
  182. package/funcs/internalAccountV1GetMeta.d.ts +0 -12
  183. package/funcs/internalAccountV1GetMeta.js +0 -118
  184. package/funcs/internalBadgeV1TagsSuggest.d.ts +0 -12
  185. package/funcs/internalBadgeV1TagsSuggest.d.ts.map +0 -1
  186. package/funcs/internalBadgeV1TagsSuggest.js.map +0 -1
  187. package/funcs/internalCheck.d.ts +0 -17
  188. package/funcs/internalCheck.d.ts.map +0 -1
  189. package/funcs/internalCheck.js +0 -111
  190. package/funcs/internalCheck.js.map +0 -1
  191. package/funcs/internalCreateDeveloperApp.d.ts +0 -12
  192. package/funcs/internalCreateDeveloperApp.d.ts.map +0 -1
  193. package/funcs/internalCreateDeveloperApp.js +0 -116
  194. package/funcs/internalCreateDeveloperApp.js.map +0 -1
  195. package/funcs/internalDeleteDeveloperApp.d.ts +0 -12
  196. package/funcs/internalDeleteDeveloperApp.d.ts.map +0 -1
  197. package/funcs/internalDeleteDeveloperApp.js +0 -116
  198. package/funcs/internalDeleteDeveloperApp.js.map +0 -1
  199. package/funcs/internalDeleteImages.d.ts +0 -12
  200. package/funcs/internalDeleteImages.d.ts.map +0 -1
  201. package/funcs/internalDeleteImages.js +0 -118
  202. package/funcs/internalDeleteImages.js.map +0 -1
  203. package/funcs/internalGetAccount.d.ts +0 -12
  204. package/funcs/internalGetAccount.d.ts.map +0 -1
  205. package/funcs/internalGetAccount.js +0 -118
  206. package/funcs/internalGetAccount.js.map +0 -1
  207. package/funcs/internalGetStaff.d.ts +0 -11
  208. package/funcs/internalGetStaff.d.ts.map +0 -1
  209. package/funcs/internalGetStaff.js +0 -107
  210. package/funcs/internalGetStaff.js.map +0 -1
  211. package/funcs/internalGetTags.d.ts +0 -11
  212. package/funcs/internalGetTags.d.ts.map +0 -1
  213. package/funcs/internalGetTags.js +0 -107
  214. package/funcs/internalGetTags.js.map +0 -1
  215. package/funcs/internalLeaderboardV1GetAccountMeta.d.ts +0 -12
  216. package/funcs/internalLeaderboardV1GetAccountMeta.d.ts.map +0 -1
  217. package/funcs/internalLeaderboardV1GetAccountMeta.js.map +0 -1
  218. package/funcs/internalUpdateApp.d.ts +0 -12
  219. package/funcs/internalUpdateApp.d.ts.map +0 -1
  220. package/funcs/internalUpdateApp.js +0 -116
  221. package/funcs/internalUpdateApp.js.map +0 -1
  222. package/funcs/internalUploadImages.d.ts +0 -12
  223. package/funcs/internalUploadImages.d.ts.map +0 -1
  224. package/funcs/internalUploadImages.js +0 -118
  225. package/funcs/internalUploadImages.js.map +0 -1
  226. package/funcs/leaderboardLeaderboardV1GetAccountMeta.d.ts +0 -12
  227. package/funcs/leaderboardLeaderboardV1GetAccountMeta.d.ts.map +0 -1
  228. package/funcs/leaderboardLeaderboardV1GetAccountMeta.js +0 -118
  229. package/funcs/leaderboardLeaderboardV1GetAccountMeta.js.map +0 -1
  230. package/models/operations/leaderboardv1getaccountmeta.d.ts +0 -35
  231. package/models/operations/leaderboardv1getaccountmeta.d.ts.map +0 -1
  232. package/models/operations/leaderboardv1getaccountmeta.js.map +0 -1
  233. package/sdk/data.d.ts +0 -13
  234. package/sdk/data.d.ts.map +0 -1
  235. package/sdk/data.js +0 -40
  236. package/sdk/data.js.map +0 -1
  237. package/sdk/developer.d.ts +0 -9
  238. package/sdk/developer.d.ts.map +0 -1
  239. package/sdk/developer.js +0 -24
  240. package/sdk/developer.js.map +0 -1
  241. package/sdk/external.d.ts +0 -14
  242. package/sdk/external.d.ts.map +0 -1
  243. package/sdk/external.js +0 -44
  244. package/sdk/external.js.map +0 -1
  245. package/sdk/internal.d.ts +0 -24
  246. package/sdk/internal.d.ts.map +0 -1
  247. package/sdk/internal.js +0 -66
  248. package/sdk/internal.js.map +0 -1
  249. package/src/funcs/accountGetAccount.ts +0 -179
  250. package/src/funcs/accountLeaderboardV1GetAccountMeta.ts +0 -184
  251. package/src/funcs/dataAccountV1GetMeta.ts +0 -179
  252. package/src/funcs/dataGetApps.ts +0 -179
  253. package/src/funcs/dataGetBadges.ts +0 -179
  254. package/src/funcs/dataGetDataPoints.ts +0 -179
  255. package/src/funcs/dataGetFriends.ts +0 -179
  256. package/src/funcs/dataGetInfo.ts +0 -179
  257. package/src/funcs/dataGetLeaderboardHistory.ts +0 -181
  258. package/src/funcs/developerCreateDeveloperApp.ts +0 -182
  259. package/src/funcs/developerDeleteDeveloperApp.ts +0 -184
  260. package/src/funcs/developerUpdateApp.ts +0 -184
  261. package/src/funcs/externalAppV1ListBadges.ts +0 -179
  262. package/src/funcs/externalGet.ts +0 -160
  263. package/src/funcs/externalGetApps.ts +0 -179
  264. package/src/funcs/externalGetBadges.ts +0 -179
  265. package/src/funcs/externalGetDataPoints.ts +0 -179
  266. package/src/funcs/externalGetFriends.ts +0 -179
  267. package/src/funcs/externalGetLeaderboardHistory.ts +0 -181
  268. package/src/funcs/imagesDeleteImages.ts +0 -179
  269. package/src/funcs/imagesUploadImages.ts +0 -179
  270. package/src/funcs/internalAccountV1GetMeta.ts +0 -179
  271. package/src/funcs/internalCheck.ts +0 -160
  272. package/src/funcs/internalCreateDeveloperApp.ts +0 -182
  273. package/src/funcs/internalDeleteDeveloperApp.ts +0 -184
  274. package/src/funcs/internalDeleteImages.ts +0 -179
  275. package/src/funcs/internalGetAccount.ts +0 -179
  276. package/src/funcs/internalGetStaff.ts +0 -160
  277. package/src/funcs/internalGetTags.ts +0 -160
  278. package/src/funcs/internalUpdateApp.ts +0 -184
  279. package/src/funcs/internalUploadImages.ts +0 -179
  280. package/src/funcs/leaderboardLeaderboardV1GetAccountMeta.ts +0 -184
  281. package/src/models/operations/leaderboardv1getaccountmeta.ts +0 -98
  282. package/src/sdk/data.ts +0 -94
  283. package/src/sdk/developer.ts +0 -46
  284. package/src/sdk/external.ts +0 -104
  285. package/src/sdk/internal.ts +0 -154
@@ -1,596 +0,0 @@
1
- # External
2
- (*external*)
3
-
4
- ## Overview
5
-
6
- Any requests here may be accessed by anyone with an API Key.
7
-
8
- ### Available Operations
9
-
10
- * [getApps](#getapps)
11
- * [getBadges](#getbadges)
12
- * [getDataPoints](#getdatapoints)
13
- * [getFriends](#getfriends)
14
- * [getInfo](#getinfo)
15
- * [getLeaderboardHistory](#getleaderboardhistory)
16
- * [appV1ListBadges](#appv1listbadges)
17
- * [get](#get)
18
-
19
- ## getApps
20
-
21
- ### Example Usage
22
-
23
- ```typescript
24
- import { SteamSets } from "@steamsets/client-ts";
25
-
26
- const steamSets = new SteamSets({
27
- token: "<YOUR_BEARER_TOKEN_HERE>",
28
- });
29
-
30
- async function run() {
31
- const result = await steamSets.external.getApps({});
32
-
33
- // Handle the result
34
- console.log(result);
35
- }
36
-
37
- run();
38
- ```
39
-
40
- ### Standalone function
41
-
42
- The standalone function version of this method:
43
-
44
- ```typescript
45
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
46
- import { externalGetApps } from "@steamsets/client-ts/funcs/externalGetApps.js";
47
-
48
- // Use `SteamSetsCore` for best tree-shaking performance.
49
- // You can create one instance of it to use across an application.
50
- const steamSets = new SteamSetsCore({
51
- token: "<YOUR_BEARER_TOKEN_HERE>",
52
- });
53
-
54
- async function run() {
55
- const res = await externalGetApps(steamSets, {});
56
-
57
- if (!res.ok) {
58
- throw res.error;
59
- }
60
-
61
- const { value: result } = res;
62
-
63
- // Handle the result
64
- console.log(result);
65
- }
66
-
67
- run();
68
- ```
69
-
70
- ### Parameters
71
-
72
- | Parameter | Type | Required | Description |
73
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
74
- | `request` | [components.V1AccountsAppsRequestBody](../../models/components/v1accountsappsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
75
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
76
- | `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. |
77
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
78
-
79
- ### Response
80
-
81
- **Promise\<[operations.AccountV1GetAppsResponse](../../models/operations/accountv1getappsresponse.md)\>**
82
-
83
- ### Errors
84
-
85
- | Error Type | Status Code | Content Type |
86
- | ------------------------ | ------------------------ | ------------------------ |
87
- | errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
88
- | errors.ErrorModel | 500 | application/problem+json |
89
- | errors.SDKError | 4XX, 5XX | \*/\* |
90
-
91
- ## getBadges
92
-
93
- ### Example Usage
94
-
95
- ```typescript
96
- import { SteamSets } from "@steamsets/client-ts";
97
-
98
- const steamSets = new SteamSets({
99
- token: "<YOUR_BEARER_TOKEN_HERE>",
100
- });
101
-
102
- async function run() {
103
- const result = await steamSets.external.getBadges({});
104
-
105
- // Handle the result
106
- console.log(result);
107
- }
108
-
109
- run();
110
- ```
111
-
112
- ### Standalone function
113
-
114
- The standalone function version of this method:
115
-
116
- ```typescript
117
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
118
- import { externalGetBadges } from "@steamsets/client-ts/funcs/externalGetBadges.js";
119
-
120
- // Use `SteamSetsCore` for best tree-shaking performance.
121
- // You can create one instance of it to use across an application.
122
- const steamSets = new SteamSetsCore({
123
- token: "<YOUR_BEARER_TOKEN_HERE>",
124
- });
125
-
126
- async function run() {
127
- const res = await externalGetBadges(steamSets, {});
128
-
129
- if (!res.ok) {
130
- throw res.error;
131
- }
132
-
133
- const { value: result } = res;
134
-
135
- // Handle the result
136
- console.log(result);
137
- }
138
-
139
- run();
140
- ```
141
-
142
- ### Parameters
143
-
144
- | Parameter | Type | Required | Description |
145
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
146
- | `request` | [components.V1BadgesRequestBody](../../models/components/v1badgesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
147
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
148
- | `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. |
149
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
150
-
151
- ### Response
152
-
153
- **Promise\<[operations.AccountV1GetBadgesResponse](../../models/operations/accountv1getbadgesresponse.md)\>**
154
-
155
- ### Errors
156
-
157
- | Error Type | Status Code | Content Type |
158
- | ------------------------ | ------------------------ | ------------------------ |
159
- | errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
160
- | errors.ErrorModel | 500 | application/problem+json |
161
- | errors.SDKError | 4XX, 5XX | \*/\* |
162
-
163
- ## getDataPoints
164
-
165
- ### Example Usage
166
-
167
- ```typescript
168
- import { SteamSets } from "@steamsets/client-ts";
169
-
170
- const steamSets = new SteamSets({
171
- token: "<YOUR_BEARER_TOKEN_HERE>",
172
- });
173
-
174
- async function run() {
175
- const result = await steamSets.external.getDataPoints({});
176
-
177
- // Handle the result
178
- console.log(result);
179
- }
180
-
181
- run();
182
- ```
183
-
184
- ### Standalone function
185
-
186
- The standalone function version of this method:
187
-
188
- ```typescript
189
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
190
- import { externalGetDataPoints } from "@steamsets/client-ts/funcs/externalGetDataPoints.js";
191
-
192
- // Use `SteamSetsCore` for best tree-shaking performance.
193
- // You can create one instance of it to use across an application.
194
- const steamSets = new SteamSetsCore({
195
- token: "<YOUR_BEARER_TOKEN_HERE>",
196
- });
197
-
198
- async function run() {
199
- const res = await externalGetDataPoints(steamSets, {});
200
-
201
- if (!res.ok) {
202
- throw res.error;
203
- }
204
-
205
- const { value: result } = res;
206
-
207
- // Handle the result
208
- console.log(result);
209
- }
210
-
211
- run();
212
- ```
213
-
214
- ### Parameters
215
-
216
- | Parameter | Type | Required | Description |
217
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
218
- | `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
219
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
220
- | `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. |
221
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
222
-
223
- ### Response
224
-
225
- **Promise\<[operations.AccountV1GetDataPointsResponse](../../models/operations/accountv1getdatapointsresponse.md)\>**
226
-
227
- ### Errors
228
-
229
- | Error Type | Status Code | Content Type |
230
- | ------------------------ | ------------------------ | ------------------------ |
231
- | errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
232
- | errors.ErrorModel | 500 | application/problem+json |
233
- | errors.SDKError | 4XX, 5XX | \*/\* |
234
-
235
- ## getFriends
236
-
237
- ### Example Usage
238
-
239
- ```typescript
240
- import { SteamSets } from "@steamsets/client-ts";
241
-
242
- const steamSets = new SteamSets({
243
- token: "<YOUR_BEARER_TOKEN_HERE>",
244
- });
245
-
246
- async function run() {
247
- const result = await steamSets.external.getFriends({});
248
-
249
- // Handle the result
250
- console.log(result);
251
- }
252
-
253
- run();
254
- ```
255
-
256
- ### Standalone function
257
-
258
- The standalone function version of this method:
259
-
260
- ```typescript
261
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
262
- import { externalGetFriends } from "@steamsets/client-ts/funcs/externalGetFriends.js";
263
-
264
- // Use `SteamSetsCore` for best tree-shaking performance.
265
- // You can create one instance of it to use across an application.
266
- const steamSets = new SteamSetsCore({
267
- token: "<YOUR_BEARER_TOKEN_HERE>",
268
- });
269
-
270
- async function run() {
271
- const res = await externalGetFriends(steamSets, {});
272
-
273
- if (!res.ok) {
274
- throw res.error;
275
- }
276
-
277
- const { value: result } = res;
278
-
279
- // Handle the result
280
- console.log(result);
281
- }
282
-
283
- run();
284
- ```
285
-
286
- ### Parameters
287
-
288
- | Parameter | Type | Required | Description |
289
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
290
- | `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
291
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
292
- | `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. |
293
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
294
-
295
- ### Response
296
-
297
- **Promise\<[operations.AccountV1GetFriendsResponse](../../models/operations/accountv1getfriendsresponse.md)\>**
298
-
299
- ### Errors
300
-
301
- | Error Type | Status Code | Content Type |
302
- | ------------------------ | ------------------------ | ------------------------ |
303
- | errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
304
- | errors.ErrorModel | 500 | application/problem+json |
305
- | errors.SDKError | 4XX, 5XX | \*/\* |
306
-
307
- ## getInfo
308
-
309
- ### Example Usage
310
-
311
- ```typescript
312
- import { SteamSets } from "@steamsets/client-ts";
313
-
314
- const steamSets = new SteamSets({
315
- token: "<YOUR_BEARER_TOKEN_HERE>",
316
- });
317
-
318
- async function run() {
319
- const result = await steamSets.external.getInfo({});
320
-
321
- // Handle the result
322
- console.log(result);
323
- }
324
-
325
- run();
326
- ```
327
-
328
- ### Standalone function
329
-
330
- The standalone function version of this method:
331
-
332
- ```typescript
333
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
334
- import { externalGetInfo } from "@steamsets/client-ts/funcs/externalGetInfo.js";
335
-
336
- // Use `SteamSetsCore` for best tree-shaking performance.
337
- // You can create one instance of it to use across an application.
338
- const steamSets = new SteamSetsCore({
339
- token: "<YOUR_BEARER_TOKEN_HERE>",
340
- });
341
-
342
- async function run() {
343
- const res = await externalGetInfo(steamSets, {});
344
-
345
- if (!res.ok) {
346
- throw res.error;
347
- }
348
-
349
- const { value: result } = res;
350
-
351
- // Handle the result
352
- console.log(result);
353
- }
354
-
355
- run();
356
- ```
357
-
358
- ### Parameters
359
-
360
- | Parameter | Type | Required | Description |
361
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
362
- | `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
363
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
364
- | `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. |
365
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
366
-
367
- ### Response
368
-
369
- **Promise\<[operations.AccountV1GetInfoResponse](../../models/operations/accountv1getinforesponse.md)\>**
370
-
371
- ### Errors
372
-
373
- | Error Type | Status Code | Content Type |
374
- | ------------------------ | ------------------------ | ------------------------ |
375
- | errors.ErrorModel | 403, 404, 422, 429 | application/problem+json |
376
- | errors.ErrorModel | 500 | application/problem+json |
377
- | errors.SDKError | 4XX, 5XX | \*/\* |
378
-
379
- ## getLeaderboardHistory
380
-
381
- ### Example Usage
382
-
383
- ```typescript
384
- import { SteamSets } from "@steamsets/client-ts";
385
-
386
- const steamSets = new SteamSets({
387
- token: "<YOUR_BEARER_TOKEN_HERE>",
388
- });
389
-
390
- async function run() {
391
- const result = await steamSets.external.getLeaderboardHistory({});
392
-
393
- // Handle the result
394
- console.log(result);
395
- }
396
-
397
- run();
398
- ```
399
-
400
- ### Standalone function
401
-
402
- The standalone function version of this method:
403
-
404
- ```typescript
405
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
406
- import { externalGetLeaderboardHistory } from "@steamsets/client-ts/funcs/externalGetLeaderboardHistory.js";
407
-
408
- // Use `SteamSetsCore` for best tree-shaking performance.
409
- // You can create one instance of it to use across an application.
410
- const steamSets = new SteamSetsCore({
411
- token: "<YOUR_BEARER_TOKEN_HERE>",
412
- });
413
-
414
- async function run() {
415
- const res = await externalGetLeaderboardHistory(steamSets, {});
416
-
417
- if (!res.ok) {
418
- throw res.error;
419
- }
420
-
421
- const { value: result } = res;
422
-
423
- // Handle the result
424
- console.log(result);
425
- }
426
-
427
- run();
428
- ```
429
-
430
- ### Parameters
431
-
432
- | Parameter | Type | Required | Description |
433
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
434
- | `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
435
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
436
- | `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. |
437
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
438
-
439
- ### Response
440
-
441
- **Promise\<[operations.AccountV1GetLeaderboardHistoryResponse](../../models/operations/accountv1getleaderboardhistoryresponse.md)\>**
442
-
443
- ### Errors
444
-
445
- | Error Type | Status Code | Content Type |
446
- | ------------------------ | ------------------------ | ------------------------ |
447
- | errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
448
- | errors.ErrorModel | 500 | application/problem+json |
449
- | errors.SDKError | 4XX, 5XX | \*/\* |
450
-
451
- ## appV1ListBadges
452
-
453
- ### Example Usage
454
-
455
- ```typescript
456
- import { SteamSets } from "@steamsets/client-ts";
457
-
458
- const steamSets = new SteamSets({
459
- token: "<YOUR_BEARER_TOKEN_HERE>",
460
- });
461
-
462
- async function run() {
463
- const result = await steamSets.external.appV1ListBadges({
464
- appId: 701216,
465
- });
466
-
467
- // Handle the result
468
- console.log(result);
469
- }
470
-
471
- run();
472
- ```
473
-
474
- ### Standalone function
475
-
476
- The standalone function version of this method:
477
-
478
- ```typescript
479
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
480
- import { externalAppV1ListBadges } from "@steamsets/client-ts/funcs/externalAppV1ListBadges.js";
481
-
482
- // Use `SteamSetsCore` for best tree-shaking performance.
483
- // You can create one instance of it to use across an application.
484
- const steamSets = new SteamSetsCore({
485
- token: "<YOUR_BEARER_TOKEN_HERE>",
486
- });
487
-
488
- async function run() {
489
- const res = await externalAppV1ListBadges(steamSets, {
490
- appId: 701216,
491
- });
492
-
493
- if (!res.ok) {
494
- throw res.error;
495
- }
496
-
497
- const { value: result } = res;
498
-
499
- // Handle the result
500
- console.log(result);
501
- }
502
-
503
- run();
504
- ```
505
-
506
- ### Parameters
507
-
508
- | Parameter | Type | Required | Description |
509
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
510
- | `request` | [components.V1AppBadgeListRequestBody](../../models/components/v1appbadgelistrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
511
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
512
- | `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. |
513
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
514
-
515
- ### Response
516
-
517
- **Promise\<[operations.AppV1ListBadgesResponse](../../models/operations/appv1listbadgesresponse.md)\>**
518
-
519
- ### Errors
520
-
521
- | Error Type | Status Code | Content Type |
522
- | ------------------------ | ------------------------ | ------------------------ |
523
- | errors.ErrorModel | 403, 404, 422 | application/problem+json |
524
- | errors.ErrorModel | 500 | application/problem+json |
525
- | errors.SDKError | 4XX, 5XX | \*/\* |
526
-
527
- ## get
528
-
529
- ### Example Usage
530
-
531
- ```typescript
532
- import { SteamSets } from "@steamsets/client-ts";
533
-
534
- const steamSets = new SteamSets({
535
- token: "<YOUR_BEARER_TOKEN_HERE>",
536
- });
537
-
538
- async function run() {
539
- const result = await steamSets.external.get();
540
-
541
- // Handle the result
542
- console.log(result);
543
- }
544
-
545
- run();
546
- ```
547
-
548
- ### Standalone function
549
-
550
- The standalone function version of this method:
551
-
552
- ```typescript
553
- import { SteamSetsCore } from "@steamsets/client-ts/core.js";
554
- import { externalGet } from "@steamsets/client-ts/funcs/externalGet.js";
555
-
556
- // Use `SteamSetsCore` for best tree-shaking performance.
557
- // You can create one instance of it to use across an application.
558
- const steamSets = new SteamSetsCore({
559
- token: "<YOUR_BEARER_TOKEN_HERE>",
560
- });
561
-
562
- async function run() {
563
- const res = await externalGet(steamSets);
564
-
565
- if (!res.ok) {
566
- throw res.error;
567
- }
568
-
569
- const { value: result } = res;
570
-
571
- // Handle the result
572
- console.log(result);
573
- }
574
-
575
- run();
576
- ```
577
-
578
- ### Parameters
579
-
580
- | Parameter | Type | Required | Description |
581
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
582
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
583
- | `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. |
584
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
585
-
586
- ### Response
587
-
588
- **Promise\<[operations.StatsV1StatsGetResponse](../../models/operations/statsv1statsgetresponse.md)\>**
589
-
590
- ### Errors
591
-
592
- | Error Type | Status Code | Content Type |
593
- | ------------------------ | ------------------------ | ------------------------ |
594
- | errors.ErrorModel | 404, 429 | application/problem+json |
595
- | errors.ErrorModel | 500 | application/problem+json |
596
- | errors.SDKError | 4XX, 5XX | \*/\* |