@steamsets/client-ts 0.7.0 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (184) hide show
  1. package/README.md +36 -3
  2. package/docs/sdks/account/README.md +146 -36
  3. package/docs/sdks/app/README.md +14 -0
  4. package/docs/sdks/connection/README.md +24 -8
  5. package/docs/sdks/data/README.md +57 -4
  6. package/docs/sdks/liveness/README.md +6 -2
  7. package/docs/sdks/location/README.md +6 -2
  8. package/docs/sdks/public/README.md +51 -2
  9. package/docs/sdks/session/README.md +24 -8
  10. package/docs/sdks/settings/README.md +48 -16
  11. package/funcs/accountAccountV1GetApps.d.ts +1 -1
  12. package/funcs/accountAccountV1GetApps.d.ts.map +1 -1
  13. package/funcs/accountAccountV1GetApps.js +17 -5
  14. package/funcs/accountAccountV1GetApps.js.map +1 -1
  15. package/funcs/accountAccountV1GetBadges.d.ts +1 -1
  16. package/funcs/accountAccountV1GetBadges.d.ts.map +1 -1
  17. package/funcs/accountAccountV1GetBadges.js +17 -5
  18. package/funcs/accountAccountV1GetBadges.js.map +1 -1
  19. package/funcs/accountAccountV1GetDataPoints.d.ts +1 -1
  20. package/funcs/accountAccountV1GetDataPoints.d.ts.map +1 -1
  21. package/funcs/accountAccountV1GetDataPoints.js +17 -5
  22. package/funcs/accountAccountV1GetDataPoints.js.map +1 -1
  23. package/funcs/accountAccountV1GetFriends.d.ts +1 -1
  24. package/funcs/accountAccountV1GetFriends.d.ts.map +1 -1
  25. package/funcs/accountAccountV1GetFriends.js +17 -5
  26. package/funcs/accountAccountV1GetFriends.js.map +1 -1
  27. package/funcs/accountAccountV1GetInfo.d.ts +1 -1
  28. package/funcs/accountAccountV1GetInfo.d.ts.map +1 -1
  29. package/funcs/accountAccountV1GetInfo.js +17 -5
  30. package/funcs/accountAccountV1GetInfo.js.map +1 -1
  31. package/funcs/accountAccountV1GetLeaderboardHistory.d.ts +1 -1
  32. package/funcs/accountAccountV1GetLeaderboardHistory.d.ts.map +1 -1
  33. package/funcs/accountAccountV1GetLeaderboardHistory.js +17 -5
  34. package/funcs/accountAccountV1GetLeaderboardHistory.js.map +1 -1
  35. package/funcs/appAccountV1Queue.d.ts +1 -1
  36. package/funcs/appAccountV1Queue.d.ts.map +1 -1
  37. package/funcs/appAccountV1Queue.js +17 -5
  38. package/funcs/appAccountV1Queue.js.map +1 -1
  39. package/funcs/appAppV1Get.d.ts +1 -1
  40. package/funcs/appAppV1Get.d.ts.map +1 -1
  41. package/funcs/appAppV1Get.js +17 -5
  42. package/funcs/appAppV1Get.js.map +1 -1
  43. package/funcs/dataAccountV1GetApps.d.ts +1 -1
  44. package/funcs/dataAccountV1GetApps.d.ts.map +1 -1
  45. package/funcs/dataAccountV1GetApps.js +17 -5
  46. package/funcs/dataAccountV1GetApps.js.map +1 -1
  47. package/funcs/dataAccountV1GetBadges.d.ts +1 -1
  48. package/funcs/dataAccountV1GetBadges.d.ts.map +1 -1
  49. package/funcs/dataAccountV1GetBadges.js +17 -5
  50. package/funcs/dataAccountV1GetBadges.js.map +1 -1
  51. package/funcs/dataAccountV1GetDataPoints.d.ts +1 -1
  52. package/funcs/dataAccountV1GetDataPoints.d.ts.map +1 -1
  53. package/funcs/dataAccountV1GetDataPoints.js +17 -5
  54. package/funcs/dataAccountV1GetDataPoints.js.map +1 -1
  55. package/funcs/dataAccountV1GetFriends.d.ts +1 -1
  56. package/funcs/dataAccountV1GetFriends.d.ts.map +1 -1
  57. package/funcs/dataAccountV1GetFriends.js +17 -5
  58. package/funcs/dataAccountV1GetFriends.js.map +1 -1
  59. package/funcs/dataAccountV1GetInfo.d.ts +1 -1
  60. package/funcs/dataAccountV1GetInfo.d.ts.map +1 -1
  61. package/funcs/dataAccountV1GetInfo.js +17 -5
  62. package/funcs/dataAccountV1GetInfo.js.map +1 -1
  63. package/funcs/dataAccountV1GetLeaderboardHistory.d.ts +1 -1
  64. package/funcs/dataAccountV1GetLeaderboardHistory.d.ts.map +1 -1
  65. package/funcs/dataAccountV1GetLeaderboardHistory.js +17 -5
  66. package/funcs/dataAccountV1GetLeaderboardHistory.js.map +1 -1
  67. package/funcs/dataAccountV1Queue.d.ts +1 -1
  68. package/funcs/dataAccountV1Queue.d.ts.map +1 -1
  69. package/funcs/dataAccountV1Queue.js +17 -5
  70. package/funcs/dataAccountV1Queue.js.map +1 -1
  71. package/funcs/publicAccountV1GetApps.d.ts +1 -1
  72. package/funcs/publicAccountV1GetApps.d.ts.map +1 -1
  73. package/funcs/publicAccountV1GetApps.js +17 -5
  74. package/funcs/publicAccountV1GetApps.js.map +1 -1
  75. package/funcs/publicAccountV1GetBadges.d.ts +1 -1
  76. package/funcs/publicAccountV1GetBadges.d.ts.map +1 -1
  77. package/funcs/publicAccountV1GetBadges.js +17 -5
  78. package/funcs/publicAccountV1GetBadges.js.map +1 -1
  79. package/funcs/publicAccountV1GetDataPoints.d.ts +1 -1
  80. package/funcs/publicAccountV1GetDataPoints.d.ts.map +1 -1
  81. package/funcs/publicAccountV1GetDataPoints.js +17 -5
  82. package/funcs/publicAccountV1GetDataPoints.js.map +1 -1
  83. package/funcs/publicAccountV1GetFriends.d.ts +1 -1
  84. package/funcs/publicAccountV1GetFriends.d.ts.map +1 -1
  85. package/funcs/publicAccountV1GetFriends.js +17 -5
  86. package/funcs/publicAccountV1GetFriends.js.map +1 -1
  87. package/funcs/publicAccountV1GetInfo.d.ts +1 -1
  88. package/funcs/publicAccountV1GetInfo.d.ts.map +1 -1
  89. package/funcs/publicAccountV1GetInfo.js +17 -5
  90. package/funcs/publicAccountV1GetInfo.js.map +1 -1
  91. package/funcs/publicAccountV1GetLeaderboardHistory.d.ts +1 -1
  92. package/funcs/publicAccountV1GetLeaderboardHistory.d.ts.map +1 -1
  93. package/funcs/publicAccountV1GetLeaderboardHistory.js +17 -5
  94. package/funcs/publicAccountV1GetLeaderboardHistory.js.map +1 -1
  95. package/funcs/publicAccountV1Queue.d.ts +1 -1
  96. package/funcs/publicAccountV1Queue.d.ts.map +1 -1
  97. package/funcs/publicAccountV1Queue.js +17 -5
  98. package/funcs/publicAccountV1Queue.js.map +1 -1
  99. package/lib/config.d.ts +2 -2
  100. package/lib/config.js +2 -2
  101. package/models/operations/accountv1getapps.d.ts +25 -0
  102. package/models/operations/accountv1getapps.d.ts.map +1 -1
  103. package/models/operations/accountv1getapps.js +22 -1
  104. package/models/operations/accountv1getapps.js.map +1 -1
  105. package/models/operations/accountv1getbadges.d.ts +25 -0
  106. package/models/operations/accountv1getbadges.d.ts.map +1 -1
  107. package/models/operations/accountv1getbadges.js +22 -1
  108. package/models/operations/accountv1getbadges.js.map +1 -1
  109. package/models/operations/accountv1getdatapoints.d.ts +25 -0
  110. package/models/operations/accountv1getdatapoints.d.ts.map +1 -1
  111. package/models/operations/accountv1getdatapoints.js +22 -1
  112. package/models/operations/accountv1getdatapoints.js.map +1 -1
  113. package/models/operations/accountv1getfriends.d.ts +25 -0
  114. package/models/operations/accountv1getfriends.d.ts.map +1 -1
  115. package/models/operations/accountv1getfriends.js +22 -1
  116. package/models/operations/accountv1getfriends.js.map +1 -1
  117. package/models/operations/accountv1getinfo.d.ts +25 -0
  118. package/models/operations/accountv1getinfo.d.ts.map +1 -1
  119. package/models/operations/accountv1getinfo.js +22 -1
  120. package/models/operations/accountv1getinfo.js.map +1 -1
  121. package/models/operations/accountv1getleaderboardhistory.d.ts +25 -0
  122. package/models/operations/accountv1getleaderboardhistory.d.ts.map +1 -1
  123. package/models/operations/accountv1getleaderboardhistory.js +22 -1
  124. package/models/operations/accountv1getleaderboardhistory.js.map +1 -1
  125. package/models/operations/accountv1queue.d.ts +25 -0
  126. package/models/operations/accountv1queue.d.ts.map +1 -1
  127. package/models/operations/accountv1queue.js +22 -1
  128. package/models/operations/accountv1queue.js.map +1 -1
  129. package/models/operations/appv1get.d.ts +25 -0
  130. package/models/operations/appv1get.d.ts.map +1 -1
  131. package/models/operations/appv1get.js +22 -1
  132. package/models/operations/appv1get.js.map +1 -1
  133. package/package.json +1 -1
  134. package/sdk/account.d.ts +6 -6
  135. package/sdk/account.d.ts.map +1 -1
  136. package/sdk/account.js +12 -12
  137. package/sdk/account.js.map +1 -1
  138. package/sdk/app.d.ts +2 -2
  139. package/sdk/app.d.ts.map +1 -1
  140. package/sdk/app.js +4 -4
  141. package/sdk/app.js.map +1 -1
  142. package/sdk/data.d.ts +7 -7
  143. package/sdk/data.d.ts.map +1 -1
  144. package/sdk/data.js +14 -14
  145. package/sdk/data.js.map +1 -1
  146. package/sdk/public.d.ts +7 -7
  147. package/sdk/public.d.ts.map +1 -1
  148. package/sdk/public.js +14 -14
  149. package/sdk/public.js.map +1 -1
  150. package/src/funcs/accountAccountV1GetApps.ts +18 -5
  151. package/src/funcs/accountAccountV1GetBadges.ts +18 -5
  152. package/src/funcs/accountAccountV1GetDataPoints.ts +18 -5
  153. package/src/funcs/accountAccountV1GetFriends.ts +18 -5
  154. package/src/funcs/accountAccountV1GetInfo.ts +18 -5
  155. package/src/funcs/accountAccountV1GetLeaderboardHistory.ts +18 -5
  156. package/src/funcs/appAccountV1Queue.ts +18 -5
  157. package/src/funcs/appAppV1Get.ts +18 -5
  158. package/src/funcs/dataAccountV1GetApps.ts +18 -5
  159. package/src/funcs/dataAccountV1GetBadges.ts +18 -5
  160. package/src/funcs/dataAccountV1GetDataPoints.ts +18 -5
  161. package/src/funcs/dataAccountV1GetFriends.ts +18 -5
  162. package/src/funcs/dataAccountV1GetInfo.ts +18 -5
  163. package/src/funcs/dataAccountV1GetLeaderboardHistory.ts +18 -5
  164. package/src/funcs/dataAccountV1Queue.ts +18 -5
  165. package/src/funcs/publicAccountV1GetApps.ts +18 -5
  166. package/src/funcs/publicAccountV1GetBadges.ts +18 -5
  167. package/src/funcs/publicAccountV1GetDataPoints.ts +18 -5
  168. package/src/funcs/publicAccountV1GetFriends.ts +18 -5
  169. package/src/funcs/publicAccountV1GetInfo.ts +18 -5
  170. package/src/funcs/publicAccountV1GetLeaderboardHistory.ts +18 -5
  171. package/src/funcs/publicAccountV1Queue.ts +18 -5
  172. package/src/lib/config.ts +2 -2
  173. package/src/models/operations/accountv1getapps.ts +44 -0
  174. package/src/models/operations/accountv1getbadges.ts +44 -0
  175. package/src/models/operations/accountv1getdatapoints.ts +44 -0
  176. package/src/models/operations/accountv1getfriends.ts +44 -0
  177. package/src/models/operations/accountv1getinfo.ts +44 -0
  178. package/src/models/operations/accountv1getleaderboardhistory.ts +46 -0
  179. package/src/models/operations/accountv1queue.ts +44 -0
  180. package/src/models/operations/appv1get.ts +44 -0
  181. package/src/sdk/account.ts +12 -0
  182. package/src/sdk/app.ts +4 -0
  183. package/src/sdk/data.ts +14 -0
  184. package/src/sdk/public.ts +14 -0
package/README.md CHANGED
@@ -48,7 +48,9 @@ yarn add @steamsets/client-ts zod
48
48
  ```typescript
49
49
  import { SteamSets } from "@steamsets/client-ts";
50
50
 
51
- const steamSets = new SteamSets();
51
+ const steamSets = new SteamSets({
52
+ session: "<YOUR_BEARER_TOKEN_HERE>",
53
+ });
52
54
 
53
55
  async function run() {
54
56
  const result = await steamSets.account.accountV1ConnectionConnect({
@@ -169,7 +171,9 @@ To change the default retry strategy for a single API call, simply provide a ret
169
171
  ```typescript
170
172
  import { SteamSets } from "@steamsets/client-ts";
171
173
 
172
- const steamSets = new SteamSets();
174
+ const steamSets = new SteamSets({
175
+ session: "<YOUR_BEARER_TOKEN_HERE>",
176
+ });
173
177
 
174
178
  async function run() {
175
179
  const result = await steamSets.account.accountV1ConnectionConnect({
@@ -211,6 +215,7 @@ const steamSets = new SteamSets({
211
215
  },
212
216
  retryConnectionErrors: false,
213
217
  },
218
+ session: "<YOUR_BEARER_TOKEN_HERE>",
214
219
  });
215
220
 
216
221
  async function run() {
@@ -248,7 +253,9 @@ import {
248
253
  SDKValidationError,
249
254
  } from "@steamsets/client-ts/models/errors";
250
255
 
251
- const steamSets = new SteamSets();
256
+ const steamSets = new SteamSets({
257
+ session: "<YOUR_BEARER_TOKEN_HERE>",
258
+ });
252
259
 
253
260
  async function run() {
254
261
  let result;
@@ -303,6 +310,7 @@ import { SteamSets } from "@steamsets/client-ts";
303
310
 
304
311
  const steamSets = new SteamSets({
305
312
  serverIdx: 1,
313
+ session: "<YOUR_BEARER_TOKEN_HERE>",
306
314
  });
307
315
 
308
316
  async function run() {
@@ -329,6 +337,7 @@ import { SteamSets } from "@steamsets/client-ts";
329
337
 
330
338
  const steamSets = new SteamSets({
331
339
  serverURL: "https://api.steamsets.com",
340
+ session: "<YOUR_BEARER_TOKEN_HERE>",
332
341
  });
333
342
 
334
343
  async function run() {
@@ -426,6 +435,30 @@ async function run() {
426
435
 
427
436
  run();
428
437
 
438
+ ```
439
+
440
+ ### Per-Operation Security Schemes
441
+
442
+ Some operations in this SDK require the security scheme to be specified at the request level. For example:
443
+ ```typescript
444
+ import { SteamSets } from "@steamsets/client-ts";
445
+
446
+ const steamSets = new SteamSets();
447
+
448
+ async function run() {
449
+ const result = await steamSets.account.accountV1GetApps({
450
+ accountSearch: {},
451
+ }, {
452
+ apiKey: "<YOUR_API_KEY_HERE>",
453
+ session: "<YOUR_BEARER_TOKEN_HERE>",
454
+ });
455
+
456
+ // Handle the result
457
+ console.log(result);
458
+ }
459
+
460
+ run();
461
+
429
462
  ```
430
463
  <!-- End Authentication [security] -->
431
464
 
@@ -40,7 +40,9 @@ Connect a new Social Provider
40
40
  ```typescript
41
41
  import { SteamSets } from "@steamsets/client-ts";
42
42
 
43
- const steamSets = new SteamSets();
43
+ const steamSets = new SteamSets({
44
+ session: "<YOUR_BEARER_TOKEN_HERE>",
45
+ });
44
46
 
45
47
  async function run() {
46
48
  const result = await steamSets.account.accountV1ConnectionConnect({
@@ -65,7 +67,9 @@ import { accountAccountV1ConnectionConnect } from "@steamsets/client-ts/funcs/ac
65
67
 
66
68
  // Use `SteamSetsCore` for best tree-shaking performance.
67
69
  // You can create one instance of it to use across an application.
68
- const steamSets = new SteamSetsCore();
70
+ const steamSets = new SteamSetsCore({
71
+ session: "<YOUR_BEARER_TOKEN_HERE>",
72
+ });
69
73
 
70
74
  async function run() {
71
75
  const res = await accountAccountV1ConnectionConnect(steamSets, {
@@ -116,7 +120,9 @@ Create a new session for non logged in users
116
120
  ```typescript
117
121
  import { SteamSets } from "@steamsets/client-ts";
118
122
 
119
- const steamSets = new SteamSets();
123
+ const steamSets = new SteamSets({
124
+ session: "<YOUR_BEARER_TOKEN_HERE>",
125
+ });
120
126
 
121
127
  async function run() {
122
128
  const result = await steamSets.account.accountV1SessionCreate({});
@@ -138,7 +144,9 @@ import { accountAccountV1SessionCreate } from "@steamsets/client-ts/funcs/accoun
138
144
 
139
145
  // Use `SteamSetsCore` for best tree-shaking performance.
140
146
  // You can create one instance of it to use across an application.
141
- const steamSets = new SteamSetsCore();
147
+ const steamSets = new SteamSetsCore({
148
+ session: "<YOUR_BEARER_TOKEN_HERE>",
149
+ });
142
150
 
143
151
  async function run() {
144
152
  const res = await accountAccountV1SessionCreate(steamSets, {});
@@ -186,7 +194,9 @@ Remove a connection
186
194
  ```typescript
187
195
  import { SteamSets } from "@steamsets/client-ts";
188
196
 
189
- const steamSets = new SteamSets();
197
+ const steamSets = new SteamSets({
198
+ session: "<YOUR_BEARER_TOKEN_HERE>",
199
+ });
190
200
 
191
201
  async function run() {
192
202
  const result = await steamSets.account.accountV1ConnectionDeleteConnection({
@@ -210,7 +220,9 @@ import { accountAccountV1ConnectionDeleteConnection } from "@steamsets/client-ts
210
220
 
211
221
  // Use `SteamSetsCore` for best tree-shaking performance.
212
222
  // You can create one instance of it to use across an application.
213
- const steamSets = new SteamSetsCore();
223
+ const steamSets = new SteamSetsCore({
224
+ session: "<YOUR_BEARER_TOKEN_HERE>",
225
+ });
214
226
 
215
227
  async function run() {
216
228
  const res = await accountAccountV1ConnectionDeleteConnection(steamSets, {
@@ -260,7 +272,9 @@ Delete mulitple imagest
260
272
  ```typescript
261
273
  import { SteamSets } from "@steamsets/client-ts";
262
274
 
263
- const steamSets = new SteamSets();
275
+ const steamSets = new SteamSets({
276
+ session: "<YOUR_BEARER_TOKEN_HERE>",
277
+ });
264
278
 
265
279
  async function run() {
266
280
  const result = await steamSets.account.accountV1SettingsDeleteImages({
@@ -286,7 +300,9 @@ import { accountAccountV1SettingsDeleteImages } from "@steamsets/client-ts/funcs
286
300
 
287
301
  // Use `SteamSetsCore` for best tree-shaking performance.
288
302
  // You can create one instance of it to use across an application.
289
- const steamSets = new SteamSetsCore();
303
+ const steamSets = new SteamSetsCore({
304
+ session: "<YOUR_BEARER_TOKEN_HERE>",
305
+ });
290
306
 
291
307
  async function run() {
292
308
  const res = await accountAccountV1SettingsDeleteImages(steamSets, {
@@ -338,7 +354,9 @@ Deletes a session, can also be used to logout
338
354
  ```typescript
339
355
  import { SteamSets } from "@steamsets/client-ts";
340
356
 
341
- const steamSets = new SteamSets();
357
+ const steamSets = new SteamSets({
358
+ session: "<YOUR_BEARER_TOKEN_HERE>",
359
+ });
342
360
 
343
361
  async function run() {
344
362
  const result = await steamSets.account.accountV1SessionDelete({
@@ -362,7 +380,9 @@ import { accountAccountV1SessionDelete } from "@steamsets/client-ts/funcs/accoun
362
380
 
363
381
  // Use `SteamSetsCore` for best tree-shaking performance.
364
382
  // You can create one instance of it to use across an application.
365
- const steamSets = new SteamSetsCore();
383
+ const steamSets = new SteamSetsCore({
384
+ session: "<YOUR_BEARER_TOKEN_HERE>",
385
+ });
366
386
 
367
387
  async function run() {
368
388
  const res = await accountAccountV1SessionDelete(steamSets, {
@@ -412,7 +432,9 @@ Generate a new API key for the account
412
432
  ```typescript
413
433
  import { SteamSets } from "@steamsets/client-ts";
414
434
 
415
- const steamSets = new SteamSets();
435
+ const steamSets = new SteamSets({
436
+ session: "<YOUR_BEARER_TOKEN_HERE>",
437
+ });
416
438
 
417
439
  async function run() {
418
440
  const result = await steamSets.account.accountV1SettingsGenerateApiKey();
@@ -434,7 +456,9 @@ import { accountAccountV1SettingsGenerateApiKey } from "@steamsets/client-ts/fun
434
456
 
435
457
  // Use `SteamSetsCore` for best tree-shaking performance.
436
458
  // You can create one instance of it to use across an application.
437
- const steamSets = new SteamSetsCore();
459
+ const steamSets = new SteamSetsCore({
460
+ session: "<YOUR_BEARER_TOKEN_HERE>",
461
+ });
438
462
 
439
463
  async function run() {
440
464
  const res = await accountAccountV1SettingsGenerateApiKey(steamSets);
@@ -486,6 +510,9 @@ const steamSets = new SteamSets();
486
510
  async function run() {
487
511
  const result = await steamSets.account.accountV1GetApps({
488
512
  accountSearch: {},
513
+ }, {
514
+ apiKey: "<YOUR_API_KEY_HERE>",
515
+ session: "<YOUR_BEARER_TOKEN_HERE>",
489
516
  });
490
517
 
491
518
  // Handle the result
@@ -510,6 +537,9 @@ const steamSets = new SteamSetsCore();
510
537
  async function run() {
511
538
  const res = await accountAccountV1GetApps(steamSets, {
512
539
  accountSearch: {},
540
+ }, {
541
+ apiKey: "<YOUR_API_KEY_HERE>",
542
+ session: "<YOUR_BEARER_TOKEN_HERE>",
513
543
  });
514
544
 
515
545
  if (!res.ok) {
@@ -530,6 +560,7 @@ run();
530
560
  | Parameter | Type | Required | Description |
531
561
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
532
562
  | `request` | [operations.AccountV1GetAppsRequest](../../models/operations/accountv1getappsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
563
+ | `security` | [operations.AccountV1GetAppsSecurity](../../models/operations/accountv1getappssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
533
564
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
534
565
  | `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. |
535
566
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
@@ -560,6 +591,9 @@ const steamSets = new SteamSets();
560
591
  async function run() {
561
592
  const result = await steamSets.account.accountV1GetBadges({
562
593
  accountSearch: {},
594
+ }, {
595
+ apiKey: "<YOUR_API_KEY_HERE>",
596
+ session: "<YOUR_BEARER_TOKEN_HERE>",
563
597
  });
564
598
 
565
599
  // Handle the result
@@ -584,6 +618,9 @@ const steamSets = new SteamSetsCore();
584
618
  async function run() {
585
619
  const res = await accountAccountV1GetBadges(steamSets, {
586
620
  accountSearch: {},
621
+ }, {
622
+ apiKey: "<YOUR_API_KEY_HERE>",
623
+ session: "<YOUR_BEARER_TOKEN_HERE>",
587
624
  });
588
625
 
589
626
  if (!res.ok) {
@@ -604,6 +641,7 @@ run();
604
641
  | Parameter | Type | Required | Description |
605
642
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
606
643
  | `request` | [operations.AccountV1GetBadgesRequest](../../models/operations/accountv1getbadgesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
644
+ | `security` | [operations.AccountV1GetBadgesSecurity](../../models/operations/accountv1getbadgessecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
607
645
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
608
646
  | `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. |
609
647
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
@@ -634,6 +672,9 @@ const steamSets = new SteamSets();
634
672
  async function run() {
635
673
  const result = await steamSets.account.accountV1GetDataPoints({
636
674
  accountSearch: {},
675
+ }, {
676
+ apiKey: "<YOUR_API_KEY_HERE>",
677
+ session: "<YOUR_BEARER_TOKEN_HERE>",
637
678
  });
638
679
 
639
680
  // Handle the result
@@ -658,6 +699,9 @@ const steamSets = new SteamSetsCore();
658
699
  async function run() {
659
700
  const res = await accountAccountV1GetDataPoints(steamSets, {
660
701
  accountSearch: {},
702
+ }, {
703
+ apiKey: "<YOUR_API_KEY_HERE>",
704
+ session: "<YOUR_BEARER_TOKEN_HERE>",
661
705
  });
662
706
 
663
707
  if (!res.ok) {
@@ -678,6 +722,7 @@ run();
678
722
  | Parameter | Type | Required | Description |
679
723
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
680
724
  | `request` | [operations.AccountV1GetDataPointsRequest](../../models/operations/accountv1getdatapointsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
725
+ | `security` | [operations.AccountV1GetDataPointsSecurity](../../models/operations/accountv1getdatapointssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
681
726
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
682
727
  | `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. |
683
728
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
@@ -708,6 +753,9 @@ const steamSets = new SteamSets();
708
753
  async function run() {
709
754
  const result = await steamSets.account.accountV1GetFriends({
710
755
  accountSearch: {},
756
+ }, {
757
+ apiKey: "<YOUR_API_KEY_HERE>",
758
+ session: "<YOUR_BEARER_TOKEN_HERE>",
711
759
  });
712
760
 
713
761
  // Handle the result
@@ -732,6 +780,9 @@ const steamSets = new SteamSetsCore();
732
780
  async function run() {
733
781
  const res = await accountAccountV1GetFriends(steamSets, {
734
782
  accountSearch: {},
783
+ }, {
784
+ apiKey: "<YOUR_API_KEY_HERE>",
785
+ session: "<YOUR_BEARER_TOKEN_HERE>",
735
786
  });
736
787
 
737
788
  if (!res.ok) {
@@ -752,6 +803,7 @@ run();
752
803
  | Parameter | Type | Required | Description |
753
804
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
754
805
  | `request` | [operations.AccountV1GetFriendsRequest](../../models/operations/accountv1getfriendsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
806
+ | `security` | [operations.AccountV1GetFriendsSecurity](../../models/operations/accountv1getfriendssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
755
807
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
756
808
  | `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. |
757
809
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
@@ -780,7 +832,10 @@ import { SteamSets } from "@steamsets/client-ts";
780
832
  const steamSets = new SteamSets();
781
833
 
782
834
  async function run() {
783
- const result = await steamSets.account.accountV1GetInfo({});
835
+ const result = await steamSets.account.accountV1GetInfo({}, {
836
+ apiKey: "<YOUR_API_KEY_HERE>",
837
+ session: "<YOUR_BEARER_TOKEN_HERE>",
838
+ });
784
839
 
785
840
  // Handle the result
786
841
  console.log(result)
@@ -802,7 +857,10 @@ import { accountAccountV1GetInfo } from "@steamsets/client-ts/funcs/accountAccou
802
857
  const steamSets = new SteamSetsCore();
803
858
 
804
859
  async function run() {
805
- const res = await accountAccountV1GetInfo(steamSets, {});
860
+ const res = await accountAccountV1GetInfo(steamSets, {}, {
861
+ apiKey: "<YOUR_API_KEY_HERE>",
862
+ session: "<YOUR_BEARER_TOKEN_HERE>",
863
+ });
806
864
 
807
865
  if (!res.ok) {
808
866
  throw res.error;
@@ -822,6 +880,7 @@ run();
822
880
  | Parameter | Type | Required | Description |
823
881
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
824
882
  | `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
883
+ | `security` | [operations.AccountV1GetInfoSecurity](../../models/operations/accountv1getinfosecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
825
884
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
826
885
  | `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. |
827
886
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
@@ -852,6 +911,9 @@ const steamSets = new SteamSets();
852
911
  async function run() {
853
912
  const result = await steamSets.account.accountV1GetLeaderboardHistory({
854
913
  accountSearch: {},
914
+ }, {
915
+ apiKey: "<YOUR_API_KEY_HERE>",
916
+ session: "<YOUR_BEARER_TOKEN_HERE>",
855
917
  });
856
918
 
857
919
  // Handle the result
@@ -876,6 +938,9 @@ const steamSets = new SteamSetsCore();
876
938
  async function run() {
877
939
  const res = await accountAccountV1GetLeaderboardHistory(steamSets, {
878
940
  accountSearch: {},
941
+ }, {
942
+ apiKey: "<YOUR_API_KEY_HERE>",
943
+ session: "<YOUR_BEARER_TOKEN_HERE>",
879
944
  });
880
945
 
881
946
  if (!res.ok) {
@@ -896,6 +961,7 @@ run();
896
961
  | Parameter | Type | Required | Description |
897
962
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
898
963
  | `request` | [operations.AccountV1GetLeaderboardHistoryRequest](../../models/operations/accountv1getleaderboardhistoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
964
+ | `security` | [operations.AccountV1GetLeaderboardHistorySecurity](../../models/operations/accountv1getleaderboardhistorysecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
899
965
  | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
900
966
  | `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. |
901
967
  | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
@@ -921,7 +987,9 @@ Gets all session data
921
987
  ```typescript
922
988
  import { SteamSets } from "@steamsets/client-ts";
923
989
 
924
- const steamSets = new SteamSets();
990
+ const steamSets = new SteamSets({
991
+ session: "<YOUR_BEARER_TOKEN_HERE>",
992
+ });
925
993
 
926
994
  async function run() {
927
995
  const result = await steamSets.account.accountV1SessionGet();
@@ -943,7 +1011,9 @@ import { accountAccountV1SessionGet } from "@steamsets/client-ts/funcs/accountAc
943
1011
 
944
1012
  // Use `SteamSetsCore` for best tree-shaking performance.
945
1013
  // You can create one instance of it to use across an application.
946
- const steamSets = new SteamSetsCore();
1014
+ const steamSets = new SteamSetsCore({
1015
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1016
+ });
947
1017
 
948
1018
  async function run() {
949
1019
  const res = await accountAccountV1SessionGet(steamSets);
@@ -990,7 +1060,9 @@ Gets all settings for the account
990
1060
  ```typescript
991
1061
  import { SteamSets } from "@steamsets/client-ts";
992
1062
 
993
- const steamSets = new SteamSets();
1063
+ const steamSets = new SteamSets({
1064
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1065
+ });
994
1066
 
995
1067
  async function run() {
996
1068
  const result = await steamSets.account.accountV1SettingsGet();
@@ -1012,7 +1084,9 @@ import { accountAccountV1SettingsGet } from "@steamsets/client-ts/funcs/accountA
1012
1084
 
1013
1085
  // Use `SteamSetsCore` for best tree-shaking performance.
1014
1086
  // You can create one instance of it to use across an application.
1015
- const steamSets = new SteamSetsCore();
1087
+ const steamSets = new SteamSetsCore({
1088
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1089
+ });
1016
1090
 
1017
1091
  async function run() {
1018
1092
  const res = await accountAccountV1SettingsGet(steamSets);
@@ -1059,7 +1133,9 @@ Get Staff Members and their info
1059
1133
  ```typescript
1060
1134
  import { SteamSets } from "@steamsets/client-ts";
1061
1135
 
1062
- const steamSets = new SteamSets();
1136
+ const steamSets = new SteamSets({
1137
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1138
+ });
1063
1139
 
1064
1140
  async function run() {
1065
1141
  const result = await steamSets.account.accountV1GetStaff();
@@ -1081,7 +1157,9 @@ import { accountAccountV1GetStaff } from "@steamsets/client-ts/funcs/accountAcco
1081
1157
 
1082
1158
  // Use `SteamSetsCore` for best tree-shaking performance.
1083
1159
  // You can create one instance of it to use across an application.
1084
- const steamSets = new SteamSetsCore();
1160
+ const steamSets = new SteamSetsCore({
1161
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1162
+ });
1085
1163
 
1086
1164
  async function run() {
1087
1165
  const res = await accountAccountV1GetStaff(steamSets);
@@ -1128,7 +1206,9 @@ Logs a user in and creates a new session
1128
1206
  ```typescript
1129
1207
  import { SteamSets } from "@steamsets/client-ts";
1130
1208
 
1131
- const steamSets = new SteamSets();
1209
+ const steamSets = new SteamSets({
1210
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1211
+ });
1132
1212
 
1133
1213
  async function run() {
1134
1214
  const result = await steamSets.account.accountV1SessionLogin({
@@ -1163,7 +1243,9 @@ import { accountAccountV1SessionLogin } from "@steamsets/client-ts/funcs/account
1163
1243
 
1164
1244
  // Use `SteamSetsCore` for best tree-shaking performance.
1165
1245
  // You can create one instance of it to use across an application.
1166
- const steamSets = new SteamSetsCore();
1246
+ const steamSets = new SteamSetsCore({
1247
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1248
+ });
1167
1249
 
1168
1250
  async function run() {
1169
1251
  const res = await accountAccountV1SessionLogin(steamSets, {
@@ -1224,7 +1306,9 @@ Resend the verification code for an email
1224
1306
  ```typescript
1225
1307
  import { SteamSets } from "@steamsets/client-ts";
1226
1308
 
1227
- const steamSets = new SteamSets();
1309
+ const steamSets = new SteamSets({
1310
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1311
+ });
1228
1312
 
1229
1313
  async function run() {
1230
1314
  const result = await steamSets.account.accountV1SettingsSendEmailVerification({});
@@ -1246,7 +1330,9 @@ import { accountAccountV1SettingsSendEmailVerification } from "@steamsets/client
1246
1330
 
1247
1331
  // Use `SteamSetsCore` for best tree-shaking performance.
1248
1332
  // You can create one instance of it to use across an application.
1249
- const steamSets = new SteamSetsCore();
1333
+ const steamSets = new SteamSetsCore({
1334
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1335
+ });
1250
1336
 
1251
1337
  async function run() {
1252
1338
  const res = await accountAccountV1SettingsSendEmailVerification(steamSets, {});
@@ -1294,7 +1380,9 @@ Make a connection visible/invisible
1294
1380
  ```typescript
1295
1381
  import { SteamSets } from "@steamsets/client-ts";
1296
1382
 
1297
- const steamSets = new SteamSets();
1383
+ const steamSets = new SteamSets({
1384
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1385
+ });
1298
1386
 
1299
1387
  async function run() {
1300
1388
  const result = await steamSets.account.accountV1ConnectionUpdateConnection({
@@ -1319,7 +1407,9 @@ import { accountAccountV1ConnectionUpdateConnection } from "@steamsets/client-ts
1319
1407
 
1320
1408
  // Use `SteamSetsCore` for best tree-shaking performance.
1321
1409
  // You can create one instance of it to use across an application.
1322
- const steamSets = new SteamSetsCore();
1410
+ const steamSets = new SteamSetsCore({
1411
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1412
+ });
1323
1413
 
1324
1414
  async function run() {
1325
1415
  const res = await accountAccountV1ConnectionUpdateConnection(steamSets, {
@@ -1370,7 +1460,9 @@ Update one of the uploaded images
1370
1460
  ```typescript
1371
1461
  import { SteamSets } from "@steamsets/client-ts";
1372
1462
 
1373
- const steamSets = new SteamSets();
1463
+ const steamSets = new SteamSets({
1464
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1465
+ });
1374
1466
 
1375
1467
  async function run() {
1376
1468
  const result = await steamSets.account.accountV1SettingsUpdateImage({
@@ -1395,7 +1487,9 @@ import { accountAccountV1SettingsUpdateImage } from "@steamsets/client-ts/funcs/
1395
1487
 
1396
1488
  // Use `SteamSetsCore` for best tree-shaking performance.
1397
1489
  // You can create one instance of it to use across an application.
1398
- const steamSets = new SteamSetsCore();
1490
+ const steamSets = new SteamSetsCore({
1491
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1492
+ });
1399
1493
 
1400
1494
  async function run() {
1401
1495
  const res = await accountAccountV1SettingsUpdateImage(steamSets, {
@@ -1446,7 +1540,9 @@ Update settings for the logged in account
1446
1540
  ```typescript
1447
1541
  import { SteamSets } from "@steamsets/client-ts";
1448
1542
 
1449
- const steamSets = new SteamSets();
1543
+ const steamSets = new SteamSets({
1544
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1545
+ });
1450
1546
 
1451
1547
  async function run() {
1452
1548
  const result = await steamSets.account.accountV1SettingsUpdate({
@@ -1484,7 +1580,9 @@ import { accountAccountV1SettingsUpdate } from "@steamsets/client-ts/funcs/accou
1484
1580
 
1485
1581
  // Use `SteamSetsCore` for best tree-shaking performance.
1486
1582
  // You can create one instance of it to use across an application.
1487
- const steamSets = new SteamSetsCore();
1583
+ const steamSets = new SteamSetsCore({
1584
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1585
+ });
1488
1586
 
1489
1587
  async function run() {
1490
1588
  const res = await accountAccountV1SettingsUpdate(steamSets, {
@@ -1548,7 +1646,9 @@ Multi Upload Endpoint for images
1548
1646
  ```typescript
1549
1647
  import { SteamSets } from "@steamsets/client-ts";
1550
1648
 
1551
- const steamSets = new SteamSets();
1649
+ const steamSets = new SteamSets({
1650
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1651
+ });
1552
1652
 
1553
1653
  async function run() {
1554
1654
  const result = await steamSets.account.accountV1SettingsUploadImages({
@@ -1577,7 +1677,9 @@ import { accountAccountV1SettingsUploadImages } from "@steamsets/client-ts/funcs
1577
1677
 
1578
1678
  // Use `SteamSetsCore` for best tree-shaking performance.
1579
1679
  // You can create one instance of it to use across an application.
1580
- const steamSets = new SteamSetsCore();
1680
+ const steamSets = new SteamSetsCore({
1681
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1682
+ });
1581
1683
 
1582
1684
  async function run() {
1583
1685
  const res = await accountAccountV1SettingsUploadImages(steamSets, {
@@ -1632,7 +1734,9 @@ Verify a domain connection only atm
1632
1734
  ```typescript
1633
1735
  import { SteamSets } from "@steamsets/client-ts";
1634
1736
 
1635
- const steamSets = new SteamSets();
1737
+ const steamSets = new SteamSets({
1738
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1739
+ });
1636
1740
 
1637
1741
  async function run() {
1638
1742
  const result = await steamSets.account.accountV1ConnectionVerifyConnection({
@@ -1656,7 +1760,9 @@ import { accountAccountV1ConnectionVerifyConnection } from "@steamsets/client-ts
1656
1760
 
1657
1761
  // Use `SteamSetsCore` for best tree-shaking performance.
1658
1762
  // You can create one instance of it to use across an application.
1659
- const steamSets = new SteamSetsCore();
1763
+ const steamSets = new SteamSetsCore({
1764
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1765
+ });
1660
1766
 
1661
1767
  async function run() {
1662
1768
  const res = await accountAccountV1ConnectionVerifyConnection(steamSets, {
@@ -1706,7 +1812,9 @@ Verify the email by passing in the code the user should've gotten
1706
1812
  ```typescript
1707
1813
  import { SteamSets } from "@steamsets/client-ts";
1708
1814
 
1709
- const steamSets = new SteamSets();
1815
+ const steamSets = new SteamSets({
1816
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1817
+ });
1710
1818
 
1711
1819
  async function run() {
1712
1820
  const result = await steamSets.account.accountV1SettingsVerfyEmail({
@@ -1730,7 +1838,9 @@ import { accountAccountV1SettingsVerfyEmail } from "@steamsets/client-ts/funcs/a
1730
1838
 
1731
1839
  // Use `SteamSetsCore` for best tree-shaking performance.
1732
1840
  // You can create one instance of it to use across an application.
1733
- const steamSets = new SteamSetsCore();
1841
+ const steamSets = new SteamSetsCore({
1842
+ session: "<YOUR_BEARER_TOKEN_HERE>",
1843
+ });
1734
1844
 
1735
1845
  async function run() {
1736
1846
  const res = await accountAccountV1SettingsVerfyEmail(steamSets, {