@steamsets/client-ts 0.3.1 → 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 +41 -0
- package/docs/sdks/account/README.md +133 -44
- 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 +102 -14
- 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/accountAccountV1SettingsUploadImages.d.ts +13 -0
- package/funcs/accountAccountV1SettingsUploadImages.d.ts.map +1 -0
- package/funcs/accountAccountV1SettingsUploadImages.js +96 -0
- package/funcs/accountAccountV1SettingsUploadImages.js.map +1 -0
- 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/funcs/settingsAccountV1SettingsUploadImages.d.ts +13 -0
- package/funcs/settingsAccountV1SettingsUploadImages.d.ts.map +1 -0
- package/funcs/settingsAccountV1SettingsUploadImages.js +96 -0
- package/funcs/settingsAccountV1SettingsUploadImages.js.map +1 -0
- 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 +5 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +5 -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/components/v1uploadimagesrequestbody.d.ts +29 -0
- package/models/components/v1uploadimagesrequestbody.d.ts.map +1 -0
- package/models/components/v1uploadimagesrequestbody.js +51 -0
- package/models/components/v1uploadimagesrequestbody.js.map +1 -0
- package/models/components/v1uploaedimage.d.ts +74 -0
- package/models/components/v1uploaedimage.d.ts.map +1 -0
- package/models/components/v1uploaedimage.js +77 -0
- package/models/components/v1uploaedimage.js.map +1 -0
- 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 +7 -3
- package/sdk/account.d.ts.map +1 -1
- package/sdk/account.js +13 -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/sdk/settings.d.ts +4 -0
- package/sdk/settings.d.ts.map +1 -1
- package/sdk/settings.js +7 -0
- package/sdk/settings.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/accountAccountV1SettingsUploadImages.ts +130 -0
- package/src/funcs/sessionAccountV1SessionLogin.ts +13 -5
- package/src/funcs/settingsAccountV1SettingsUploadImages.ts +130 -0
- 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 +5 -0
- package/src/models/components/security.ts +4 -4
- package/src/models/components/v1uploadimagesrequestbody.ts +54 -0
- package/src/models/components/v1uploaedimage.ts +87 -0
- package/src/models/operations/accountv1sessionlogin.ts +40 -0
- package/src/sdk/account.ts +20 -4
- package/src/sdk/session.ts +2 -1
- package/src/sdk/settings.ts +11 -0
|
@@ -21,6 +21,7 @@ Account related operations
|
|
|
21
21
|
* [accountV1ConnectionUpdateConnection](#accountv1connectionupdateconnection) - Make a connection visible/invisible
|
|
22
22
|
* [accountV1SettingsUpdateImage](#accountv1settingsupdateimage) - Update one of the uploaded images
|
|
23
23
|
* [accountV1SettingsUpdate](#accountv1settingsupdate) - Update settings for the logged in account
|
|
24
|
+
* [accountV1SettingsUploadImages](#accountv1settingsuploadimages) - Multi Upload Endpoint for images
|
|
24
25
|
* [accountV1ConnectionVerifyConnection](#accountv1connectionverifyconnection) - Verify a domain connection only atm
|
|
25
26
|
* [accountV1SettingsVerfyEmail](#accountv1settingsverfyemail) - Verify the email by passing in the code the user should've gotten
|
|
26
27
|
|
|
@@ -50,7 +51,6 @@ async function run() {
|
|
|
50
51
|
run();
|
|
51
52
|
```
|
|
52
53
|
|
|
53
|
-
|
|
54
54
|
### Standalone function
|
|
55
55
|
|
|
56
56
|
The standalone function version of this method:
|
|
@@ -93,10 +93,10 @@ run();
|
|
|
93
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. |
|
|
94
94
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
95
95
|
|
|
96
|
-
|
|
97
96
|
### Response
|
|
98
97
|
|
|
99
98
|
**Promise\<[components.V1ConnectResponseBody](../../models/components/v1connectresponsebody.md)\>**
|
|
99
|
+
|
|
100
100
|
### Errors
|
|
101
101
|
|
|
102
102
|
| Error Object | Status Code | Content Type |
|
|
@@ -104,6 +104,7 @@ run();
|
|
|
104
104
|
| errors.ErrorModel | 400,422,500 | application/problem+json |
|
|
105
105
|
| errors.SDKError | 4xx-5xx | */* |
|
|
106
106
|
|
|
107
|
+
|
|
107
108
|
## accountV1ConnectionDeleteConnection
|
|
108
109
|
|
|
109
110
|
Remove a connection
|
|
@@ -129,7 +130,6 @@ async function run() {
|
|
|
129
130
|
run();
|
|
130
131
|
```
|
|
131
132
|
|
|
132
|
-
|
|
133
133
|
### Standalone function
|
|
134
134
|
|
|
135
135
|
The standalone function version of this method:
|
|
@@ -171,10 +171,10 @@ run();
|
|
|
171
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. |
|
|
172
172
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
173
173
|
|
|
174
|
-
|
|
175
174
|
### Response
|
|
176
175
|
|
|
177
176
|
**Promise\<[components.V1DeleteConnectionResponseBody](../../models/components/v1deleteconnectionresponsebody.md)\>**
|
|
177
|
+
|
|
178
178
|
### Errors
|
|
179
179
|
|
|
180
180
|
| Error Object | Status Code | Content Type |
|
|
@@ -182,6 +182,7 @@ run();
|
|
|
182
182
|
| errors.ErrorModel | 400,422,500 | application/problem+json |
|
|
183
183
|
| errors.SDKError | 4xx-5xx | */* |
|
|
184
184
|
|
|
185
|
+
|
|
185
186
|
## accountV1SettingsDeleteImages
|
|
186
187
|
|
|
187
188
|
Delete mulitple imagest
|
|
@@ -212,7 +213,6 @@ async function run() {
|
|
|
212
213
|
run();
|
|
213
214
|
```
|
|
214
215
|
|
|
215
|
-
|
|
216
216
|
### Standalone function
|
|
217
217
|
|
|
218
218
|
The standalone function version of this method:
|
|
@@ -259,10 +259,10 @@ run();
|
|
|
259
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. |
|
|
260
260
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
261
261
|
|
|
262
|
-
|
|
263
262
|
### Response
|
|
264
263
|
|
|
265
264
|
**Promise\<[components.V1DeleteImagesResponseBody](../../models/components/v1deleteimagesresponsebody.md)\>**
|
|
265
|
+
|
|
266
266
|
### Errors
|
|
267
267
|
|
|
268
268
|
| Error Object | Status Code | Content Type |
|
|
@@ -270,6 +270,7 @@ run();
|
|
|
270
270
|
| errors.ErrorModel | 404,422,500 | application/problem+json |
|
|
271
271
|
| errors.SDKError | 4xx-5xx | */* |
|
|
272
272
|
|
|
273
|
+
|
|
273
274
|
## accountV1SessionDelete
|
|
274
275
|
|
|
275
276
|
Deletes a session, can also be used to logout
|
|
@@ -295,7 +296,6 @@ async function run() {
|
|
|
295
296
|
run();
|
|
296
297
|
```
|
|
297
298
|
|
|
298
|
-
|
|
299
299
|
### Standalone function
|
|
300
300
|
|
|
301
301
|
The standalone function version of this method:
|
|
@@ -337,10 +337,10 @@ run();
|
|
|
337
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. |
|
|
338
338
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
339
339
|
|
|
340
|
-
|
|
341
340
|
### Response
|
|
342
341
|
|
|
343
342
|
**Promise\<[components.V1DeleteSessionResponseBody](../../models/components/v1deletesessionresponsebody.md)\>**
|
|
343
|
+
|
|
344
344
|
### Errors
|
|
345
345
|
|
|
346
346
|
| Error Object | Status Code | Content Type |
|
|
@@ -348,6 +348,7 @@ run();
|
|
|
348
348
|
| errors.ErrorModel | 404,422,500 | application/problem+json |
|
|
349
349
|
| errors.SDKError | 4xx-5xx | */* |
|
|
350
350
|
|
|
351
|
+
|
|
351
352
|
## accountV1SettingsGenerateApiKey
|
|
352
353
|
|
|
353
354
|
Generate a new API key for the account
|
|
@@ -371,7 +372,6 @@ async function run() {
|
|
|
371
372
|
run();
|
|
372
373
|
```
|
|
373
374
|
|
|
374
|
-
|
|
375
375
|
### Standalone function
|
|
376
376
|
|
|
377
377
|
The standalone function version of this method:
|
|
@@ -410,10 +410,10 @@ run();
|
|
|
410
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. |
|
|
411
411
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
412
412
|
|
|
413
|
-
|
|
414
413
|
### Response
|
|
415
414
|
|
|
416
415
|
**Promise\<[components.V1GenerateApiKeyResponseBody](../../models/components/v1generateapikeyresponsebody.md)\>**
|
|
416
|
+
|
|
417
417
|
### Errors
|
|
418
418
|
|
|
419
419
|
| Error Object | Status Code | Content Type |
|
|
@@ -421,6 +421,7 @@ run();
|
|
|
421
421
|
| errors.ErrorModel | 404,429,500 | application/problem+json |
|
|
422
422
|
| errors.SDKError | 4xx-5xx | */* |
|
|
423
423
|
|
|
424
|
+
|
|
424
425
|
## accountV1GetApps
|
|
425
426
|
|
|
426
427
|
Get Account Apps
|
|
@@ -435,7 +436,7 @@ const steamSets = new SteamSets({
|
|
|
435
436
|
});
|
|
436
437
|
|
|
437
438
|
async function run() {
|
|
438
|
-
const result = await steamSets.account.accountV1GetApps();
|
|
439
|
+
const result = await steamSets.account.accountV1GetApps({});
|
|
439
440
|
|
|
440
441
|
// Handle the result
|
|
441
442
|
console.log(result)
|
|
@@ -444,7 +445,6 @@ async function run() {
|
|
|
444
445
|
run();
|
|
445
446
|
```
|
|
446
447
|
|
|
447
|
-
|
|
448
448
|
### Standalone function
|
|
449
449
|
|
|
450
450
|
The standalone function version of this method:
|
|
@@ -460,7 +460,7 @@ const steamSets = new SteamSetsCore({
|
|
|
460
460
|
});
|
|
461
461
|
|
|
462
462
|
async function run() {
|
|
463
|
-
const res = await accountAccountV1GetApps(steamSets);
|
|
463
|
+
const res = await accountAccountV1GetApps(steamSets, {});
|
|
464
464
|
|
|
465
465
|
if (!res.ok) {
|
|
466
466
|
throw res.error;
|
|
@@ -479,21 +479,23 @@ run();
|
|
|
479
479
|
|
|
480
480
|
| Parameter | Type | Required | Description |
|
|
481
481
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
482
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
482
483
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
483
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. |
|
|
484
485
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
485
486
|
|
|
486
|
-
|
|
487
487
|
### Response
|
|
488
488
|
|
|
489
489
|
**Promise\<[components.V1AccountsAppsResponseBody](../../models/components/v1accountsappsresponsebody.md)\>**
|
|
490
|
+
|
|
490
491
|
### Errors
|
|
491
492
|
|
|
492
493
|
| Error Object | Status Code | Content Type |
|
|
493
494
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
494
|
-
| errors.ErrorModel | 400,500
|
|
495
|
+
| errors.ErrorModel | 400,422,500 | application/problem+json |
|
|
495
496
|
| errors.SDKError | 4xx-5xx | */* |
|
|
496
497
|
|
|
498
|
+
|
|
497
499
|
## accountV1GetBadges
|
|
498
500
|
|
|
499
501
|
Get Account Badges
|
|
@@ -508,7 +510,7 @@ const steamSets = new SteamSets({
|
|
|
508
510
|
});
|
|
509
511
|
|
|
510
512
|
async function run() {
|
|
511
|
-
const result = await steamSets.account.accountV1GetBadges();
|
|
513
|
+
const result = await steamSets.account.accountV1GetBadges({});
|
|
512
514
|
|
|
513
515
|
// Handle the result
|
|
514
516
|
console.log(result)
|
|
@@ -517,7 +519,6 @@ async function run() {
|
|
|
517
519
|
run();
|
|
518
520
|
```
|
|
519
521
|
|
|
520
|
-
|
|
521
522
|
### Standalone function
|
|
522
523
|
|
|
523
524
|
The standalone function version of this method:
|
|
@@ -533,7 +534,7 @@ const steamSets = new SteamSetsCore({
|
|
|
533
534
|
});
|
|
534
535
|
|
|
535
536
|
async function run() {
|
|
536
|
-
const res = await accountAccountV1GetBadges(steamSets);
|
|
537
|
+
const res = await accountAccountV1GetBadges(steamSets, {});
|
|
537
538
|
|
|
538
539
|
if (!res.ok) {
|
|
539
540
|
throw res.error;
|
|
@@ -552,21 +553,23 @@ run();
|
|
|
552
553
|
|
|
553
554
|
| Parameter | Type | Required | Description |
|
|
554
555
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
556
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
555
557
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
556
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. |
|
|
557
559
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
558
560
|
|
|
559
|
-
|
|
560
561
|
### Response
|
|
561
562
|
|
|
562
563
|
**Promise\<[components.V1BadgesResponseBody](../../models/components/v1badgesresponsebody.md)\>**
|
|
564
|
+
|
|
563
565
|
### Errors
|
|
564
566
|
|
|
565
567
|
| Error Object | Status Code | Content Type |
|
|
566
568
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
567
|
-
| errors.ErrorModel | 400,500
|
|
569
|
+
| errors.ErrorModel | 400,422,500 | application/problem+json |
|
|
568
570
|
| errors.SDKError | 4xx-5xx | */* |
|
|
569
571
|
|
|
572
|
+
|
|
570
573
|
## accountV1SessionGet
|
|
571
574
|
|
|
572
575
|
Gets all session data
|
|
@@ -590,7 +593,6 @@ async function run() {
|
|
|
590
593
|
run();
|
|
591
594
|
```
|
|
592
595
|
|
|
593
|
-
|
|
594
596
|
### Standalone function
|
|
595
597
|
|
|
596
598
|
The standalone function version of this method:
|
|
@@ -629,10 +631,10 @@ run();
|
|
|
629
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. |
|
|
630
632
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
631
633
|
|
|
632
|
-
|
|
633
634
|
### Response
|
|
634
635
|
|
|
635
636
|
**Promise\<[components.V1GetSessionBody](../../models/components/v1getsessionbody.md)\>**
|
|
637
|
+
|
|
636
638
|
### Errors
|
|
637
639
|
|
|
638
640
|
| Error Object | Status Code | Content Type |
|
|
@@ -640,6 +642,7 @@ run();
|
|
|
640
642
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
641
643
|
| errors.SDKError | 4xx-5xx | */* |
|
|
642
644
|
|
|
645
|
+
|
|
643
646
|
## accountV1SettingsGet
|
|
644
647
|
|
|
645
648
|
Gets all settings for the account
|
|
@@ -663,7 +666,6 @@ async function run() {
|
|
|
663
666
|
run();
|
|
664
667
|
```
|
|
665
668
|
|
|
666
|
-
|
|
667
669
|
### Standalone function
|
|
668
670
|
|
|
669
671
|
The standalone function version of this method:
|
|
@@ -702,10 +704,10 @@ run();
|
|
|
702
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. |
|
|
703
705
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
704
706
|
|
|
705
|
-
|
|
706
707
|
### Response
|
|
707
708
|
|
|
708
709
|
**Promise\<[components.V1GetSettingsBody](../../models/components/v1getsettingsbody.md)\>**
|
|
710
|
+
|
|
709
711
|
### Errors
|
|
710
712
|
|
|
711
713
|
| Error Object | Status Code | Content Type |
|
|
@@ -713,6 +715,7 @@ run();
|
|
|
713
715
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
714
716
|
| errors.SDKError | 4xx-5xx | */* |
|
|
715
717
|
|
|
718
|
+
|
|
716
719
|
## accountV1SessionLogin
|
|
717
720
|
|
|
718
721
|
Logs a user in and creates a new session
|
|
@@ -722,9 +725,7 @@ Logs a user in and creates a new session
|
|
|
722
725
|
```typescript
|
|
723
726
|
import { SteamSets } from "@steamsets/client-ts";
|
|
724
727
|
|
|
725
|
-
const steamSets = new SteamSets(
|
|
726
|
-
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
727
|
-
});
|
|
728
|
+
const steamSets = new SteamSets();
|
|
728
729
|
|
|
729
730
|
async function run() {
|
|
730
731
|
const result = await steamSets.account.accountV1SessionLogin({
|
|
@@ -740,6 +741,8 @@ async function run() {
|
|
|
740
741
|
openidSig: "123456",
|
|
741
742
|
openidSigned: "123456",
|
|
742
743
|
},
|
|
744
|
+
}, {
|
|
745
|
+
anonymous: "<YOUR_BEARER_TOKEN_HERE>",
|
|
743
746
|
});
|
|
744
747
|
|
|
745
748
|
// Handle the result
|
|
@@ -749,7 +752,6 @@ async function run() {
|
|
|
749
752
|
run();
|
|
750
753
|
```
|
|
751
754
|
|
|
752
|
-
|
|
753
755
|
### Standalone function
|
|
754
756
|
|
|
755
757
|
The standalone function version of this method:
|
|
@@ -760,9 +762,7 @@ import { accountAccountV1SessionLogin } from "@steamsets/client-ts/funcs/account
|
|
|
760
762
|
|
|
761
763
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
762
764
|
// You can create one instance of it to use across an application.
|
|
763
|
-
const steamSets = new SteamSetsCore(
|
|
764
|
-
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
765
|
-
});
|
|
765
|
+
const steamSets = new SteamSetsCore();
|
|
766
766
|
|
|
767
767
|
async function run() {
|
|
768
768
|
const res = await accountAccountV1SessionLogin(steamSets, {
|
|
@@ -778,6 +778,8 @@ async function run() {
|
|
|
778
778
|
openidSig: "123456",
|
|
779
779
|
openidSigned: "123456",
|
|
780
780
|
},
|
|
781
|
+
}, {
|
|
782
|
+
anonymous: "<YOUR_BEARER_TOKEN_HERE>",
|
|
781
783
|
});
|
|
782
784
|
|
|
783
785
|
if (!res.ok) {
|
|
@@ -798,14 +800,15 @@ run();
|
|
|
798
800
|
| Parameter | Type | Required | Description |
|
|
799
801
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
800
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. |
|
|
801
804
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
802
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. |
|
|
803
806
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
804
807
|
|
|
805
|
-
|
|
806
808
|
### Response
|
|
807
809
|
|
|
808
810
|
**Promise\<[components.V1LoginResponseBody](../../models/components/v1loginresponsebody.md)\>**
|
|
811
|
+
|
|
809
812
|
### Errors
|
|
810
813
|
|
|
811
814
|
| Error Object | Status Code | Content Type |
|
|
@@ -813,6 +816,7 @@ run();
|
|
|
813
816
|
| errors.ErrorModel | 422,500 | application/problem+json |
|
|
814
817
|
| errors.SDKError | 4xx-5xx | */* |
|
|
815
818
|
|
|
819
|
+
|
|
816
820
|
## accountV1SettingsSendEmailVerification
|
|
817
821
|
|
|
818
822
|
Resend the verification code for an email
|
|
@@ -835,7 +839,6 @@ async function run() {
|
|
|
835
839
|
run();
|
|
836
840
|
```
|
|
837
841
|
|
|
838
|
-
|
|
839
842
|
### Standalone function
|
|
840
843
|
|
|
841
844
|
The standalone function version of this method:
|
|
@@ -874,10 +877,10 @@ run();
|
|
|
874
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. |
|
|
875
878
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
876
879
|
|
|
877
|
-
|
|
878
880
|
### Response
|
|
879
881
|
|
|
880
882
|
**Promise\<void\>**
|
|
883
|
+
|
|
881
884
|
### Errors
|
|
882
885
|
|
|
883
886
|
| Error Object | Status Code | Content Type |
|
|
@@ -885,6 +888,7 @@ run();
|
|
|
885
888
|
| errors.ErrorModel | 404,422,429,500 | application/problem+json |
|
|
886
889
|
| errors.SDKError | 4xx-5xx | */* |
|
|
887
890
|
|
|
891
|
+
|
|
888
892
|
## accountV1ConnectionUpdateConnection
|
|
889
893
|
|
|
890
894
|
Make a connection visible/invisible
|
|
@@ -911,7 +915,6 @@ async function run() {
|
|
|
911
915
|
run();
|
|
912
916
|
```
|
|
913
917
|
|
|
914
|
-
|
|
915
918
|
### Standalone function
|
|
916
919
|
|
|
917
920
|
The standalone function version of this method:
|
|
@@ -954,10 +957,10 @@ run();
|
|
|
954
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. |
|
|
955
958
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
956
959
|
|
|
957
|
-
|
|
958
960
|
### Response
|
|
959
961
|
|
|
960
962
|
**Promise\<[components.V1UpdateConnectionResponseBody](../../models/components/v1updateconnectionresponsebody.md)\>**
|
|
963
|
+
|
|
961
964
|
### Errors
|
|
962
965
|
|
|
963
966
|
| Error Object | Status Code | Content Type |
|
|
@@ -965,6 +968,7 @@ run();
|
|
|
965
968
|
| errors.ErrorModel | 400,404,422,500 | application/problem+json |
|
|
966
969
|
| errors.SDKError | 4xx-5xx | */* |
|
|
967
970
|
|
|
971
|
+
|
|
968
972
|
## accountV1SettingsUpdateImage
|
|
969
973
|
|
|
970
974
|
Update one of the uploaded images
|
|
@@ -991,7 +995,6 @@ async function run() {
|
|
|
991
995
|
run();
|
|
992
996
|
```
|
|
993
997
|
|
|
994
|
-
|
|
995
998
|
### Standalone function
|
|
996
999
|
|
|
997
1000
|
The standalone function version of this method:
|
|
@@ -1034,10 +1037,10 @@ run();
|
|
|
1034
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. |
|
|
1035
1038
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1036
1039
|
|
|
1037
|
-
|
|
1038
1040
|
### Response
|
|
1039
1041
|
|
|
1040
1042
|
**Promise\<[components.V1UpdateImageResponseBody](../../models/components/v1updateimageresponsebody.md)\>**
|
|
1043
|
+
|
|
1041
1044
|
### Errors
|
|
1042
1045
|
|
|
1043
1046
|
| Error Object | Status Code | Content Type |
|
|
@@ -1045,6 +1048,7 @@ run();
|
|
|
1045
1048
|
| errors.ErrorModel | 404,422,500 | application/problem+json |
|
|
1046
1049
|
| errors.SDKError | 4xx-5xx | */* |
|
|
1047
1050
|
|
|
1051
|
+
|
|
1048
1052
|
## accountV1SettingsUpdate
|
|
1049
1053
|
|
|
1050
1054
|
Update settings for the logged in account
|
|
@@ -1084,7 +1088,6 @@ async function run() {
|
|
|
1084
1088
|
run();
|
|
1085
1089
|
```
|
|
1086
1090
|
|
|
1087
|
-
|
|
1088
1091
|
### Standalone function
|
|
1089
1092
|
|
|
1090
1093
|
The standalone function version of this method:
|
|
@@ -1140,10 +1143,10 @@ run();
|
|
|
1140
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. |
|
|
1141
1144
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1142
1145
|
|
|
1143
|
-
|
|
1144
1146
|
### Response
|
|
1145
1147
|
|
|
1146
1148
|
**Promise\<[components.V1UpdateSettingsResponseBody](../../models/components/v1updatesettingsresponsebody.md)\>**
|
|
1149
|
+
|
|
1147
1150
|
### Errors
|
|
1148
1151
|
|
|
1149
1152
|
| Error Object | Status Code | Content Type |
|
|
@@ -1151,6 +1154,93 @@ run();
|
|
|
1151
1154
|
| errors.ErrorModel | 422,429,500 | application/problem+json |
|
|
1152
1155
|
| errors.SDKError | 4xx-5xx | */* |
|
|
1153
1156
|
|
|
1157
|
+
|
|
1158
|
+
## accountV1SettingsUploadImages
|
|
1159
|
+
|
|
1160
|
+
Multi Upload Endpoint for images
|
|
1161
|
+
|
|
1162
|
+
### Example Usage
|
|
1163
|
+
|
|
1164
|
+
```typescript
|
|
1165
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
1166
|
+
|
|
1167
|
+
const steamSets = new SteamSets({
|
|
1168
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1169
|
+
});
|
|
1170
|
+
|
|
1171
|
+
async function run() {
|
|
1172
|
+
await steamSets.account.accountV1SettingsUploadImages({
|
|
1173
|
+
images: [
|
|
1174
|
+
{
|
|
1175
|
+
data: "base64_encoded_image",
|
|
1176
|
+
type: "avatar",
|
|
1177
|
+
},
|
|
1178
|
+
],
|
|
1179
|
+
});
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
}
|
|
1183
|
+
|
|
1184
|
+
run();
|
|
1185
|
+
```
|
|
1186
|
+
|
|
1187
|
+
### Standalone function
|
|
1188
|
+
|
|
1189
|
+
The standalone function version of this method:
|
|
1190
|
+
|
|
1191
|
+
```typescript
|
|
1192
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1193
|
+
import { accountAccountV1SettingsUploadImages } from "@steamsets/client-ts/funcs/accountAccountV1SettingsUploadImages.js";
|
|
1194
|
+
|
|
1195
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1196
|
+
// You can create one instance of it to use across an application.
|
|
1197
|
+
const steamSets = new SteamSetsCore({
|
|
1198
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1199
|
+
});
|
|
1200
|
+
|
|
1201
|
+
async function run() {
|
|
1202
|
+
const res = await accountAccountV1SettingsUploadImages(steamSets, {
|
|
1203
|
+
images: [
|
|
1204
|
+
{
|
|
1205
|
+
data: "base64_encoded_image",
|
|
1206
|
+
type: "avatar",
|
|
1207
|
+
},
|
|
1208
|
+
],
|
|
1209
|
+
});
|
|
1210
|
+
|
|
1211
|
+
if (!res.ok) {
|
|
1212
|
+
throw res.error;
|
|
1213
|
+
}
|
|
1214
|
+
|
|
1215
|
+
const { value: result } = res;
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
}
|
|
1219
|
+
|
|
1220
|
+
run();
|
|
1221
|
+
```
|
|
1222
|
+
|
|
1223
|
+
### Parameters
|
|
1224
|
+
|
|
1225
|
+
| Parameter | Type | Required | Description |
|
|
1226
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1227
|
+
| `request` | [components.V1UploadImagesRequestBody](../../models/components/v1uploadimagesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1228
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
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. |
|
|
1230
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1231
|
+
|
|
1232
|
+
### Response
|
|
1233
|
+
|
|
1234
|
+
**Promise\<void\>**
|
|
1235
|
+
|
|
1236
|
+
### Errors
|
|
1237
|
+
|
|
1238
|
+
| Error Object | Status Code | Content Type |
|
|
1239
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
1240
|
+
| errors.ErrorModel | 422,500 | application/problem+json |
|
|
1241
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
1242
|
+
|
|
1243
|
+
|
|
1154
1244
|
## accountV1ConnectionVerifyConnection
|
|
1155
1245
|
|
|
1156
1246
|
Verify a domain connection only atm
|
|
@@ -1176,7 +1266,6 @@ async function run() {
|
|
|
1176
1266
|
run();
|
|
1177
1267
|
```
|
|
1178
1268
|
|
|
1179
|
-
|
|
1180
1269
|
### Standalone function
|
|
1181
1270
|
|
|
1182
1271
|
The standalone function version of this method:
|
|
@@ -1218,10 +1307,10 @@ run();
|
|
|
1218
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. |
|
|
1219
1308
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1220
1309
|
|
|
1221
|
-
|
|
1222
1310
|
### Response
|
|
1223
1311
|
|
|
1224
1312
|
**Promise\<[components.V1VerifyConnectionResponseBody](../../models/components/v1verifyconnectionresponsebody.md)\>**
|
|
1313
|
+
|
|
1225
1314
|
### Errors
|
|
1226
1315
|
|
|
1227
1316
|
| Error Object | Status Code | Content Type |
|
|
@@ -1229,6 +1318,7 @@ run();
|
|
|
1229
1318
|
| errors.ErrorModel | 400,422,500 | application/problem+json |
|
|
1230
1319
|
| errors.SDKError | 4xx-5xx | */* |
|
|
1231
1320
|
|
|
1321
|
+
|
|
1232
1322
|
## accountV1SettingsVerfyEmail
|
|
1233
1323
|
|
|
1234
1324
|
Verify the email by passing in the code the user should've gotten
|
|
@@ -1254,7 +1344,6 @@ async function run() {
|
|
|
1254
1344
|
run();
|
|
1255
1345
|
```
|
|
1256
1346
|
|
|
1257
|
-
|
|
1258
1347
|
### Standalone function
|
|
1259
1348
|
|
|
1260
1349
|
The standalone function version of this method:
|
|
@@ -1296,10 +1385,10 @@ run();
|
|
|
1296
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. |
|
|
1297
1386
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1298
1387
|
|
|
1299
|
-
|
|
1300
1388
|
### Response
|
|
1301
1389
|
|
|
1302
1390
|
**Promise\<[components.V1VerifyEmailResponseBody](../../models/components/v1verifyemailresponsebody.md)\>**
|
|
1391
|
+
|
|
1303
1392
|
### Errors
|
|
1304
1393
|
|
|
1305
1394
|
| Error Object | Status Code | Content Type |
|