@steamsets/client-ts 0.3.2 → 0.4.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.
- package/README.md +37 -0
- package/docs/sdks/account/README.md +48 -46
- package/docs/sdks/connection/README.md +7 -8
- package/docs/sdks/liveness/README.md +1 -2
- package/docs/sdks/session/README.md +14 -12
- package/docs/sdks/settings/README.md +17 -16
- package/docs/sdks/steamsets/README.md +1 -5
- package/funcs/accountAccountV1GetApps.d.ts +1 -1
- package/funcs/accountAccountV1GetApps.d.ts.map +1 -1
- package/funcs/accountAccountV1GetApps.js +14 -3
- package/funcs/accountAccountV1GetApps.js.map +1 -1
- package/funcs/accountAccountV1GetBadges.d.ts +1 -1
- package/funcs/accountAccountV1GetBadges.d.ts.map +1 -1
- package/funcs/accountAccountV1GetBadges.js +14 -3
- package/funcs/accountAccountV1GetBadges.js.map +1 -1
- package/funcs/accountAccountV1SessionLogin.d.ts +1 -1
- package/funcs/accountAccountV1SessionLogin.d.ts.map +1 -1
- package/funcs/accountAccountV1SessionLogin.js +12 -5
- package/funcs/accountAccountV1SessionLogin.js.map +1 -1
- package/funcs/sessionAccountV1SessionLogin.d.ts +1 -1
- package/funcs/sessionAccountV1SessionLogin.d.ts.map +1 -1
- package/funcs/sessionAccountV1SessionLogin.js +12 -5
- package/funcs/sessionAccountV1SessionLogin.js.map +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/models/components/accountsearch.d.ts +29 -0
- package/models/components/accountsearch.d.ts.map +1 -0
- package/models/components/accountsearch.js +54 -0
- package/models/components/accountsearch.js.map +1 -0
- package/models/components/accountsearchidstruct.d.ts +33 -0
- package/models/components/accountsearchidstruct.d.ts.map +1 -0
- package/models/components/accountsearchidstruct.js +52 -0
- package/models/components/accountsearchidstruct.js.map +1 -0
- package/models/components/accountsearchvanitystruct.d.ts +65 -0
- package/models/components/accountsearchvanitystruct.d.ts.map +1 -0
- package/models/components/accountsearchvanitystruct.js +74 -0
- package/models/components/accountsearchvanitystruct.js.map +1 -0
- package/models/components/emailnotification.d.ts +8 -8
- package/models/components/emailnotification.d.ts.map +1 -1
- package/models/components/emailnotification.js +13 -13
- package/models/components/emailnotification.js.map +1 -1
- package/models/components/index.d.ts +3 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +3 -0
- package/models/components/index.js.map +1 -1
- package/models/components/security.d.ts +2 -2
- package/models/components/security.d.ts.map +1 -1
- package/models/components/security.js +2 -2
- package/models/components/security.js.map +1 -1
- package/models/operations/accountv1sessionlogin.d.ts +23 -0
- package/models/operations/accountv1sessionlogin.d.ts.map +1 -1
- package/models/operations/accountv1sessionlogin.js +20 -1
- package/models/operations/accountv1sessionlogin.js.map +1 -1
- package/package.json +1 -1
- package/sdk/account.d.ts +3 -3
- package/sdk/account.d.ts.map +1 -1
- package/sdk/account.js +6 -6
- package/sdk/account.js.map +1 -1
- package/sdk/session.d.ts +1 -1
- package/sdk/session.d.ts.map +1 -1
- package/sdk/session.js +2 -2
- package/sdk/session.js.map +1 -1
- package/src/funcs/accountAccountV1GetApps.ts +20 -2
- package/src/funcs/accountAccountV1GetBadges.ts +20 -2
- package/src/funcs/accountAccountV1SessionLogin.ts +13 -5
- package/src/funcs/sessionAccountV1SessionLogin.ts +13 -5
- package/src/lib/config.ts +3 -3
- package/src/models/components/accountsearch.ts +58 -0
- package/src/models/components/accountsearchidstruct.ts +55 -0
- package/src/models/components/accountsearchvanitystruct.ts +85 -0
- package/src/models/components/emailnotification.ts +14 -12
- package/src/models/components/index.ts +3 -0
- package/src/models/components/security.ts +4 -4
- package/src/models/operations/accountv1sessionlogin.ts +40 -0
- package/src/sdk/account.ts +9 -4
- package/src/sdk/session.ts +2 -1
package/README.md
CHANGED
|
@@ -398,6 +398,43 @@ async function run() {
|
|
|
398
398
|
|
|
399
399
|
run();
|
|
400
400
|
|
|
401
|
+
```
|
|
402
|
+
|
|
403
|
+
### Per-Operation Security Schemes
|
|
404
|
+
|
|
405
|
+
Some operations in this SDK require the security scheme to be specified at the request level. For example:
|
|
406
|
+
```typescript
|
|
407
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
408
|
+
|
|
409
|
+
const steamSets = new SteamSets();
|
|
410
|
+
|
|
411
|
+
async function run() {
|
|
412
|
+
const result = await steamSets.account.accountV1SessionLogin(
|
|
413
|
+
{
|
|
414
|
+
loginRequestBody: {
|
|
415
|
+
openidAssocHandle: "123456",
|
|
416
|
+
openidClaimedId: "76561198842603734",
|
|
417
|
+
openidIdentity: "https://steamsets.com/api/v1/openid/login",
|
|
418
|
+
openidMode: "checkid_setup",
|
|
419
|
+
openidNs: "http://specs.openid.net/auth/2.0",
|
|
420
|
+
openidOpEndpoint: "https://steamsets.com/api/v1/openid/login",
|
|
421
|
+
openidResponseNonce: "123456",
|
|
422
|
+
openidReturnTo: "https://steamsets.com/api/v1/openid/login",
|
|
423
|
+
openidSig: "123456",
|
|
424
|
+
openidSigned: "123456",
|
|
425
|
+
},
|
|
426
|
+
},
|
|
427
|
+
{
|
|
428
|
+
anonymous: "<YOUR_BEARER_TOKEN_HERE>",
|
|
429
|
+
}
|
|
430
|
+
);
|
|
431
|
+
|
|
432
|
+
// Handle the result
|
|
433
|
+
console.log(result);
|
|
434
|
+
}
|
|
435
|
+
|
|
436
|
+
run();
|
|
437
|
+
|
|
401
438
|
```
|
|
402
439
|
<!-- End Authentication [security] -->
|
|
403
440
|
|
|
@@ -51,7 +51,6 @@ async function run() {
|
|
|
51
51
|
run();
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
-
|
|
55
54
|
### Standalone function
|
|
56
55
|
|
|
57
56
|
The standalone function version of this method:
|
|
@@ -94,10 +93,10 @@ run();
|
|
|
94
93
|
| `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. |
|
|
95
94
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
96
95
|
|
|
97
|
-
|
|
98
96
|
### Response
|
|
99
97
|
|
|
100
98
|
**Promise\<[components.V1ConnectResponseBody](../../models/components/v1connectresponsebody.md)\>**
|
|
99
|
+
|
|
101
100
|
### Errors
|
|
102
101
|
|
|
103
102
|
| Error Object | Status Code | Content Type |
|
|
@@ -105,6 +104,7 @@ run();
|
|
|
105
104
|
| errors.ErrorModel | 400,422,500 | application/problem+json |
|
|
106
105
|
| errors.SDKError | 4xx-5xx | */* |
|
|
107
106
|
|
|
107
|
+
|
|
108
108
|
## accountV1ConnectionDeleteConnection
|
|
109
109
|
|
|
110
110
|
Remove a connection
|
|
@@ -130,7 +130,6 @@ async function run() {
|
|
|
130
130
|
run();
|
|
131
131
|
```
|
|
132
132
|
|
|
133
|
-
|
|
134
133
|
### Standalone function
|
|
135
134
|
|
|
136
135
|
The standalone function version of this method:
|
|
@@ -172,10 +171,10 @@ run();
|
|
|
172
171
|
| `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. |
|
|
173
172
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
174
173
|
|
|
175
|
-
|
|
176
174
|
### Response
|
|
177
175
|
|
|
178
176
|
**Promise\<[components.V1DeleteConnectionResponseBody](../../models/components/v1deleteconnectionresponsebody.md)\>**
|
|
177
|
+
|
|
179
178
|
### Errors
|
|
180
179
|
|
|
181
180
|
| Error Object | Status Code | Content Type |
|
|
@@ -183,6 +182,7 @@ run();
|
|
|
183
182
|
| errors.ErrorModel | 400,422,500 | application/problem+json |
|
|
184
183
|
| errors.SDKError | 4xx-5xx | */* |
|
|
185
184
|
|
|
185
|
+
|
|
186
186
|
## accountV1SettingsDeleteImages
|
|
187
187
|
|
|
188
188
|
Delete mulitple imagest
|
|
@@ -213,7 +213,6 @@ async function run() {
|
|
|
213
213
|
run();
|
|
214
214
|
```
|
|
215
215
|
|
|
216
|
-
|
|
217
216
|
### Standalone function
|
|
218
217
|
|
|
219
218
|
The standalone function version of this method:
|
|
@@ -260,10 +259,10 @@ run();
|
|
|
260
259
|
| `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. |
|
|
261
260
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
262
261
|
|
|
263
|
-
|
|
264
262
|
### Response
|
|
265
263
|
|
|
266
264
|
**Promise\<[components.V1DeleteImagesResponseBody](../../models/components/v1deleteimagesresponsebody.md)\>**
|
|
265
|
+
|
|
267
266
|
### Errors
|
|
268
267
|
|
|
269
268
|
| Error Object | Status Code | Content Type |
|
|
@@ -271,6 +270,7 @@ run();
|
|
|
271
270
|
| errors.ErrorModel | 404,422,500 | application/problem+json |
|
|
272
271
|
| errors.SDKError | 4xx-5xx | */* |
|
|
273
272
|
|
|
273
|
+
|
|
274
274
|
## accountV1SessionDelete
|
|
275
275
|
|
|
276
276
|
Deletes a session, can also be used to logout
|
|
@@ -296,7 +296,6 @@ async function run() {
|
|
|
296
296
|
run();
|
|
297
297
|
```
|
|
298
298
|
|
|
299
|
-
|
|
300
299
|
### Standalone function
|
|
301
300
|
|
|
302
301
|
The standalone function version of this method:
|
|
@@ -338,10 +337,10 @@ run();
|
|
|
338
337
|
| `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. |
|
|
339
338
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
340
339
|
|
|
341
|
-
|
|
342
340
|
### Response
|
|
343
341
|
|
|
344
342
|
**Promise\<[components.V1DeleteSessionResponseBody](../../models/components/v1deletesessionresponsebody.md)\>**
|
|
343
|
+
|
|
345
344
|
### Errors
|
|
346
345
|
|
|
347
346
|
| Error Object | Status Code | Content Type |
|
|
@@ -349,6 +348,7 @@ run();
|
|
|
349
348
|
| errors.ErrorModel | 404,422,500 | application/problem+json |
|
|
350
349
|
| errors.SDKError | 4xx-5xx | */* |
|
|
351
350
|
|
|
351
|
+
|
|
352
352
|
## accountV1SettingsGenerateApiKey
|
|
353
353
|
|
|
354
354
|
Generate a new API key for the account
|
|
@@ -372,7 +372,6 @@ async function run() {
|
|
|
372
372
|
run();
|
|
373
373
|
```
|
|
374
374
|
|
|
375
|
-
|
|
376
375
|
### Standalone function
|
|
377
376
|
|
|
378
377
|
The standalone function version of this method:
|
|
@@ -411,10 +410,10 @@ run();
|
|
|
411
410
|
| `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. |
|
|
412
411
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
413
412
|
|
|
414
|
-
|
|
415
413
|
### Response
|
|
416
414
|
|
|
417
415
|
**Promise\<[components.V1GenerateApiKeyResponseBody](../../models/components/v1generateapikeyresponsebody.md)\>**
|
|
416
|
+
|
|
418
417
|
### Errors
|
|
419
418
|
|
|
420
419
|
| Error Object | Status Code | Content Type |
|
|
@@ -422,6 +421,7 @@ run();
|
|
|
422
421
|
| errors.ErrorModel | 404,429,500 | application/problem+json |
|
|
423
422
|
| errors.SDKError | 4xx-5xx | */* |
|
|
424
423
|
|
|
424
|
+
|
|
425
425
|
## accountV1GetApps
|
|
426
426
|
|
|
427
427
|
Get Account Apps
|
|
@@ -436,7 +436,7 @@ const steamSets = new SteamSets({
|
|
|
436
436
|
});
|
|
437
437
|
|
|
438
438
|
async function run() {
|
|
439
|
-
const result = await steamSets.account.accountV1GetApps();
|
|
439
|
+
const result = await steamSets.account.accountV1GetApps({});
|
|
440
440
|
|
|
441
441
|
// Handle the result
|
|
442
442
|
console.log(result)
|
|
@@ -445,7 +445,6 @@ async function run() {
|
|
|
445
445
|
run();
|
|
446
446
|
```
|
|
447
447
|
|
|
448
|
-
|
|
449
448
|
### Standalone function
|
|
450
449
|
|
|
451
450
|
The standalone function version of this method:
|
|
@@ -461,7 +460,7 @@ const steamSets = new SteamSetsCore({
|
|
|
461
460
|
});
|
|
462
461
|
|
|
463
462
|
async function run() {
|
|
464
|
-
const res = await accountAccountV1GetApps(steamSets);
|
|
463
|
+
const res = await accountAccountV1GetApps(steamSets, {});
|
|
465
464
|
|
|
466
465
|
if (!res.ok) {
|
|
467
466
|
throw res.error;
|
|
@@ -480,21 +479,23 @@ run();
|
|
|
480
479
|
|
|
481
480
|
| Parameter | Type | Required | Description |
|
|
482
481
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
482
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
483
483
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
484
484
|
| `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. |
|
|
485
485
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
486
486
|
|
|
487
|
-
|
|
488
487
|
### Response
|
|
489
488
|
|
|
490
489
|
**Promise\<[components.V1AccountsAppsResponseBody](../../models/components/v1accountsappsresponsebody.md)\>**
|
|
490
|
+
|
|
491
491
|
### Errors
|
|
492
492
|
|
|
493
493
|
| Error Object | Status Code | Content Type |
|
|
494
494
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
495
|
-
| errors.ErrorModel | 400,500
|
|
495
|
+
| errors.ErrorModel | 400,422,500 | application/problem+json |
|
|
496
496
|
| errors.SDKError | 4xx-5xx | */* |
|
|
497
497
|
|
|
498
|
+
|
|
498
499
|
## accountV1GetBadges
|
|
499
500
|
|
|
500
501
|
Get Account Badges
|
|
@@ -509,7 +510,7 @@ const steamSets = new SteamSets({
|
|
|
509
510
|
});
|
|
510
511
|
|
|
511
512
|
async function run() {
|
|
512
|
-
const result = await steamSets.account.accountV1GetBadges();
|
|
513
|
+
const result = await steamSets.account.accountV1GetBadges({});
|
|
513
514
|
|
|
514
515
|
// Handle the result
|
|
515
516
|
console.log(result)
|
|
@@ -518,7 +519,6 @@ async function run() {
|
|
|
518
519
|
run();
|
|
519
520
|
```
|
|
520
521
|
|
|
521
|
-
|
|
522
522
|
### Standalone function
|
|
523
523
|
|
|
524
524
|
The standalone function version of this method:
|
|
@@ -534,7 +534,7 @@ const steamSets = new SteamSetsCore({
|
|
|
534
534
|
});
|
|
535
535
|
|
|
536
536
|
async function run() {
|
|
537
|
-
const res = await accountAccountV1GetBadges(steamSets);
|
|
537
|
+
const res = await accountAccountV1GetBadges(steamSets, {});
|
|
538
538
|
|
|
539
539
|
if (!res.ok) {
|
|
540
540
|
throw res.error;
|
|
@@ -553,21 +553,23 @@ run();
|
|
|
553
553
|
|
|
554
554
|
| Parameter | Type | Required | Description |
|
|
555
555
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
556
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
556
557
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
557
558
|
| `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. |
|
|
558
559
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
559
560
|
|
|
560
|
-
|
|
561
561
|
### Response
|
|
562
562
|
|
|
563
563
|
**Promise\<[components.V1BadgesResponseBody](../../models/components/v1badgesresponsebody.md)\>**
|
|
564
|
+
|
|
564
565
|
### Errors
|
|
565
566
|
|
|
566
567
|
| Error Object | Status Code | Content Type |
|
|
567
568
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
568
|
-
| errors.ErrorModel | 400,500
|
|
569
|
+
| errors.ErrorModel | 400,422,500 | application/problem+json |
|
|
569
570
|
| errors.SDKError | 4xx-5xx | */* |
|
|
570
571
|
|
|
572
|
+
|
|
571
573
|
## accountV1SessionGet
|
|
572
574
|
|
|
573
575
|
Gets all session data
|
|
@@ -591,7 +593,6 @@ async function run() {
|
|
|
591
593
|
run();
|
|
592
594
|
```
|
|
593
595
|
|
|
594
|
-
|
|
595
596
|
### Standalone function
|
|
596
597
|
|
|
597
598
|
The standalone function version of this method:
|
|
@@ -630,10 +631,10 @@ run();
|
|
|
630
631
|
| `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. |
|
|
631
632
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
632
633
|
|
|
633
|
-
|
|
634
634
|
### Response
|
|
635
635
|
|
|
636
636
|
**Promise\<[components.V1GetSessionBody](../../models/components/v1getsessionbody.md)\>**
|
|
637
|
+
|
|
637
638
|
### Errors
|
|
638
639
|
|
|
639
640
|
| Error Object | Status Code | Content Type |
|
|
@@ -641,6 +642,7 @@ run();
|
|
|
641
642
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
642
643
|
| errors.SDKError | 4xx-5xx | */* |
|
|
643
644
|
|
|
645
|
+
|
|
644
646
|
## accountV1SettingsGet
|
|
645
647
|
|
|
646
648
|
Gets all settings for the account
|
|
@@ -664,7 +666,6 @@ async function run() {
|
|
|
664
666
|
run();
|
|
665
667
|
```
|
|
666
668
|
|
|
667
|
-
|
|
668
669
|
### Standalone function
|
|
669
670
|
|
|
670
671
|
The standalone function version of this method:
|
|
@@ -703,10 +704,10 @@ run();
|
|
|
703
704
|
| `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. |
|
|
704
705
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
705
706
|
|
|
706
|
-
|
|
707
707
|
### Response
|
|
708
708
|
|
|
709
709
|
**Promise\<[components.V1GetSettingsBody](../../models/components/v1getsettingsbody.md)\>**
|
|
710
|
+
|
|
710
711
|
### Errors
|
|
711
712
|
|
|
712
713
|
| Error Object | Status Code | Content Type |
|
|
@@ -714,6 +715,7 @@ run();
|
|
|
714
715
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
715
716
|
| errors.SDKError | 4xx-5xx | */* |
|
|
716
717
|
|
|
718
|
+
|
|
717
719
|
## accountV1SessionLogin
|
|
718
720
|
|
|
719
721
|
Logs a user in and creates a new session
|
|
@@ -723,9 +725,7 @@ Logs a user in and creates a new session
|
|
|
723
725
|
```typescript
|
|
724
726
|
import { SteamSets } from "@steamsets/client-ts";
|
|
725
727
|
|
|
726
|
-
const steamSets = new SteamSets(
|
|
727
|
-
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
728
|
-
});
|
|
728
|
+
const steamSets = new SteamSets();
|
|
729
729
|
|
|
730
730
|
async function run() {
|
|
731
731
|
const result = await steamSets.account.accountV1SessionLogin({
|
|
@@ -741,6 +741,8 @@ async function run() {
|
|
|
741
741
|
openidSig: "123456",
|
|
742
742
|
openidSigned: "123456",
|
|
743
743
|
},
|
|
744
|
+
}, {
|
|
745
|
+
anonymous: "<YOUR_BEARER_TOKEN_HERE>",
|
|
744
746
|
});
|
|
745
747
|
|
|
746
748
|
// Handle the result
|
|
@@ -750,7 +752,6 @@ async function run() {
|
|
|
750
752
|
run();
|
|
751
753
|
```
|
|
752
754
|
|
|
753
|
-
|
|
754
755
|
### Standalone function
|
|
755
756
|
|
|
756
757
|
The standalone function version of this method:
|
|
@@ -761,9 +762,7 @@ import { accountAccountV1SessionLogin } from "@steamsets/client-ts/funcs/account
|
|
|
761
762
|
|
|
762
763
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
763
764
|
// You can create one instance of it to use across an application.
|
|
764
|
-
const steamSets = new SteamSetsCore(
|
|
765
|
-
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
766
|
-
});
|
|
765
|
+
const steamSets = new SteamSetsCore();
|
|
767
766
|
|
|
768
767
|
async function run() {
|
|
769
768
|
const res = await accountAccountV1SessionLogin(steamSets, {
|
|
@@ -779,6 +778,8 @@ async function run() {
|
|
|
779
778
|
openidSig: "123456",
|
|
780
779
|
openidSigned: "123456",
|
|
781
780
|
},
|
|
781
|
+
}, {
|
|
782
|
+
anonymous: "<YOUR_BEARER_TOKEN_HERE>",
|
|
782
783
|
});
|
|
783
784
|
|
|
784
785
|
if (!res.ok) {
|
|
@@ -799,14 +800,15 @@ run();
|
|
|
799
800
|
| Parameter | Type | Required | Description |
|
|
800
801
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
801
802
|
| `request` | [operations.AccountV1SessionLoginRequest](../../models/operations/accountv1sessionloginrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
803
|
+
| `security` | [operations.AccountV1SessionLoginSecurity](../../models/operations/accountv1sessionloginsecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
802
804
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
803
805
|
| `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. |
|
|
804
806
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
805
807
|
|
|
806
|
-
|
|
807
808
|
### Response
|
|
808
809
|
|
|
809
810
|
**Promise\<[components.V1LoginResponseBody](../../models/components/v1loginresponsebody.md)\>**
|
|
811
|
+
|
|
810
812
|
### Errors
|
|
811
813
|
|
|
812
814
|
| Error Object | Status Code | Content Type |
|
|
@@ -814,6 +816,7 @@ run();
|
|
|
814
816
|
| errors.ErrorModel | 422,500 | application/problem+json |
|
|
815
817
|
| errors.SDKError | 4xx-5xx | */* |
|
|
816
818
|
|
|
819
|
+
|
|
817
820
|
## accountV1SettingsSendEmailVerification
|
|
818
821
|
|
|
819
822
|
Resend the verification code for an email
|
|
@@ -836,7 +839,6 @@ async function run() {
|
|
|
836
839
|
run();
|
|
837
840
|
```
|
|
838
841
|
|
|
839
|
-
|
|
840
842
|
### Standalone function
|
|
841
843
|
|
|
842
844
|
The standalone function version of this method:
|
|
@@ -875,10 +877,10 @@ run();
|
|
|
875
877
|
| `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. |
|
|
876
878
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
877
879
|
|
|
878
|
-
|
|
879
880
|
### Response
|
|
880
881
|
|
|
881
882
|
**Promise\<void\>**
|
|
883
|
+
|
|
882
884
|
### Errors
|
|
883
885
|
|
|
884
886
|
| Error Object | Status Code | Content Type |
|
|
@@ -886,6 +888,7 @@ run();
|
|
|
886
888
|
| errors.ErrorModel | 404,422,429,500 | application/problem+json |
|
|
887
889
|
| errors.SDKError | 4xx-5xx | */* |
|
|
888
890
|
|
|
891
|
+
|
|
889
892
|
## accountV1ConnectionUpdateConnection
|
|
890
893
|
|
|
891
894
|
Make a connection visible/invisible
|
|
@@ -912,7 +915,6 @@ async function run() {
|
|
|
912
915
|
run();
|
|
913
916
|
```
|
|
914
917
|
|
|
915
|
-
|
|
916
918
|
### Standalone function
|
|
917
919
|
|
|
918
920
|
The standalone function version of this method:
|
|
@@ -955,10 +957,10 @@ run();
|
|
|
955
957
|
| `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. |
|
|
956
958
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
957
959
|
|
|
958
|
-
|
|
959
960
|
### Response
|
|
960
961
|
|
|
961
962
|
**Promise\<[components.V1UpdateConnectionResponseBody](../../models/components/v1updateconnectionresponsebody.md)\>**
|
|
963
|
+
|
|
962
964
|
### Errors
|
|
963
965
|
|
|
964
966
|
| Error Object | Status Code | Content Type |
|
|
@@ -966,6 +968,7 @@ run();
|
|
|
966
968
|
| errors.ErrorModel | 400,404,422,500 | application/problem+json |
|
|
967
969
|
| errors.SDKError | 4xx-5xx | */* |
|
|
968
970
|
|
|
971
|
+
|
|
969
972
|
## accountV1SettingsUpdateImage
|
|
970
973
|
|
|
971
974
|
Update one of the uploaded images
|
|
@@ -992,7 +995,6 @@ async function run() {
|
|
|
992
995
|
run();
|
|
993
996
|
```
|
|
994
997
|
|
|
995
|
-
|
|
996
998
|
### Standalone function
|
|
997
999
|
|
|
998
1000
|
The standalone function version of this method:
|
|
@@ -1035,10 +1037,10 @@ run();
|
|
|
1035
1037
|
| `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. |
|
|
1036
1038
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1037
1039
|
|
|
1038
|
-
|
|
1039
1040
|
### Response
|
|
1040
1041
|
|
|
1041
1042
|
**Promise\<[components.V1UpdateImageResponseBody](../../models/components/v1updateimageresponsebody.md)\>**
|
|
1043
|
+
|
|
1042
1044
|
### Errors
|
|
1043
1045
|
|
|
1044
1046
|
| Error Object | Status Code | Content Type |
|
|
@@ -1046,6 +1048,7 @@ run();
|
|
|
1046
1048
|
| errors.ErrorModel | 404,422,500 | application/problem+json |
|
|
1047
1049
|
| errors.SDKError | 4xx-5xx | */* |
|
|
1048
1050
|
|
|
1051
|
+
|
|
1049
1052
|
## accountV1SettingsUpdate
|
|
1050
1053
|
|
|
1051
1054
|
Update settings for the logged in account
|
|
@@ -1085,7 +1088,6 @@ async function run() {
|
|
|
1085
1088
|
run();
|
|
1086
1089
|
```
|
|
1087
1090
|
|
|
1088
|
-
|
|
1089
1091
|
### Standalone function
|
|
1090
1092
|
|
|
1091
1093
|
The standalone function version of this method:
|
|
@@ -1141,10 +1143,10 @@ run();
|
|
|
1141
1143
|
| `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. |
|
|
1142
1144
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1143
1145
|
|
|
1144
|
-
|
|
1145
1146
|
### Response
|
|
1146
1147
|
|
|
1147
1148
|
**Promise\<[components.V1UpdateSettingsResponseBody](../../models/components/v1updatesettingsresponsebody.md)\>**
|
|
1149
|
+
|
|
1148
1150
|
### Errors
|
|
1149
1151
|
|
|
1150
1152
|
| Error Object | Status Code | Content Type |
|
|
@@ -1152,6 +1154,7 @@ run();
|
|
|
1152
1154
|
| errors.ErrorModel | 422,429,500 | application/problem+json |
|
|
1153
1155
|
| errors.SDKError | 4xx-5xx | */* |
|
|
1154
1156
|
|
|
1157
|
+
|
|
1155
1158
|
## accountV1SettingsUploadImages
|
|
1156
1159
|
|
|
1157
1160
|
Multi Upload Endpoint for images
|
|
@@ -1181,7 +1184,6 @@ async function run() {
|
|
|
1181
1184
|
run();
|
|
1182
1185
|
```
|
|
1183
1186
|
|
|
1184
|
-
|
|
1185
1187
|
### Standalone function
|
|
1186
1188
|
|
|
1187
1189
|
The standalone function version of this method:
|
|
@@ -1227,10 +1229,10 @@ run();
|
|
|
1227
1229
|
| `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. |
|
|
1228
1230
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1229
1231
|
|
|
1230
|
-
|
|
1231
1232
|
### Response
|
|
1232
1233
|
|
|
1233
1234
|
**Promise\<void\>**
|
|
1235
|
+
|
|
1234
1236
|
### Errors
|
|
1235
1237
|
|
|
1236
1238
|
| Error Object | Status Code | Content Type |
|
|
@@ -1238,6 +1240,7 @@ run();
|
|
|
1238
1240
|
| errors.ErrorModel | 422,500 | application/problem+json |
|
|
1239
1241
|
| errors.SDKError | 4xx-5xx | */* |
|
|
1240
1242
|
|
|
1243
|
+
|
|
1241
1244
|
## accountV1ConnectionVerifyConnection
|
|
1242
1245
|
|
|
1243
1246
|
Verify a domain connection only atm
|
|
@@ -1263,7 +1266,6 @@ async function run() {
|
|
|
1263
1266
|
run();
|
|
1264
1267
|
```
|
|
1265
1268
|
|
|
1266
|
-
|
|
1267
1269
|
### Standalone function
|
|
1268
1270
|
|
|
1269
1271
|
The standalone function version of this method:
|
|
@@ -1305,10 +1307,10 @@ run();
|
|
|
1305
1307
|
| `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. |
|
|
1306
1308
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1307
1309
|
|
|
1308
|
-
|
|
1309
1310
|
### Response
|
|
1310
1311
|
|
|
1311
1312
|
**Promise\<[components.V1VerifyConnectionResponseBody](../../models/components/v1verifyconnectionresponsebody.md)\>**
|
|
1313
|
+
|
|
1312
1314
|
### Errors
|
|
1313
1315
|
|
|
1314
1316
|
| Error Object | Status Code | Content Type |
|
|
@@ -1316,6 +1318,7 @@ run();
|
|
|
1316
1318
|
| errors.ErrorModel | 400,422,500 | application/problem+json |
|
|
1317
1319
|
| errors.SDKError | 4xx-5xx | */* |
|
|
1318
1320
|
|
|
1321
|
+
|
|
1319
1322
|
## accountV1SettingsVerfyEmail
|
|
1320
1323
|
|
|
1321
1324
|
Verify the email by passing in the code the user should've gotten
|
|
@@ -1341,7 +1344,6 @@ async function run() {
|
|
|
1341
1344
|
run();
|
|
1342
1345
|
```
|
|
1343
1346
|
|
|
1344
|
-
|
|
1345
1347
|
### Standalone function
|
|
1346
1348
|
|
|
1347
1349
|
The standalone function version of this method:
|
|
@@ -1383,10 +1385,10 @@ run();
|
|
|
1383
1385
|
| `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. |
|
|
1384
1386
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1385
1387
|
|
|
1386
|
-
|
|
1387
1388
|
### Response
|
|
1388
1389
|
|
|
1389
1390
|
**Promise\<[components.V1VerifyEmailResponseBody](../../models/components/v1verifyemailresponsebody.md)\>**
|
|
1391
|
+
|
|
1390
1392
|
### Errors
|
|
1391
1393
|
|
|
1392
1394
|
| Error Object | Status Code | Content Type |
|