@steamsets/client-ts 0.14.29 → 0.15.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/FUNCTIONS.md +4 -4
- package/README.md +77 -30
- package/docs/sdks/account/README.md +204 -121
- package/docs/sdks/internal/README.md +166 -83
- package/docs/sdks/settings/README.md +132 -49
- package/docs/sdks/steamsets/README.md +78 -0
- package/funcs/accountAccountV1SettingsEmailSendVerification.d.ts +10 -0
- package/funcs/accountAccountV1SettingsEmailSendVerification.d.ts.map +1 -0
- package/funcs/{settingsSendEmailVerification.js → accountAccountV1SettingsEmailSendVerification.js} +7 -7
- package/funcs/accountAccountV1SettingsEmailSendVerification.js.map +1 -0
- package/funcs/{accountSendEmailVerification.d.ts → accountAccountV1SettingsEmailSubscribe.d.ts} +2 -2
- package/funcs/accountAccountV1SettingsEmailSubscribe.d.ts.map +1 -0
- package/funcs/accountAccountV1SettingsEmailSubscribe.js +113 -0
- package/funcs/accountAccountV1SettingsEmailSubscribe.js.map +1 -0
- package/funcs/{accountVerifyEmail.d.ts → accountAccountV1SettingsEmailVerify.d.ts} +2 -2
- package/funcs/accountAccountV1SettingsEmailVerify.d.ts.map +1 -0
- package/funcs/{accountVerifyEmail.js → accountAccountV1SettingsEmailVerify.js} +6 -6
- package/funcs/accountAccountV1SettingsEmailVerify.js.map +1 -0
- package/funcs/internalAccountV1SettingsEmailSendVerification.d.ts +10 -0
- package/funcs/internalAccountV1SettingsEmailSendVerification.d.ts.map +1 -0
- package/funcs/{internalSendEmailVerification.js → internalAccountV1SettingsEmailSendVerification.js} +7 -7
- package/funcs/internalAccountV1SettingsEmailSendVerification.js.map +1 -0
- package/funcs/{internalSendEmailVerification.d.ts → internalAccountV1SettingsEmailSubscribe.d.ts} +2 -2
- package/funcs/internalAccountV1SettingsEmailSubscribe.d.ts.map +1 -0
- package/funcs/internalAccountV1SettingsEmailSubscribe.js +113 -0
- package/funcs/internalAccountV1SettingsEmailSubscribe.js.map +1 -0
- package/funcs/{internalVerifyEmail.d.ts → internalAccountV1SettingsEmailVerify.d.ts} +2 -2
- package/funcs/internalAccountV1SettingsEmailVerify.d.ts.map +1 -0
- package/funcs/{settingsVerifyEmail.js → internalAccountV1SettingsEmailVerify.js} +6 -6
- package/funcs/internalAccountV1SettingsEmailVerify.js.map +1 -0
- package/funcs/{settingsVerifyEmail.d.ts → resendWebhook.d.ts} +2 -4
- package/funcs/resendWebhook.d.ts.map +1 -0
- package/funcs/resendWebhook.js +114 -0
- package/funcs/resendWebhook.js.map +1 -0
- package/funcs/settingsAccountV1SettingsEmailSendVerification.d.ts +10 -0
- package/funcs/settingsAccountV1SettingsEmailSendVerification.d.ts.map +1 -0
- package/funcs/{accountSendEmailVerification.js → settingsAccountV1SettingsEmailSendVerification.js} +7 -7
- package/funcs/settingsAccountV1SettingsEmailSendVerification.js.map +1 -0
- package/funcs/{settingsSendEmailVerification.d.ts → settingsAccountV1SettingsEmailSubscribe.d.ts} +2 -2
- package/funcs/settingsAccountV1SettingsEmailSubscribe.d.ts.map +1 -0
- package/funcs/settingsAccountV1SettingsEmailSubscribe.js +113 -0
- package/funcs/settingsAccountV1SettingsEmailSubscribe.js.map +1 -0
- package/funcs/settingsAccountV1SettingsEmailVerify.d.ts +11 -0
- package/funcs/settingsAccountV1SettingsEmailVerify.d.ts.map +1 -0
- package/funcs/{internalVerifyEmail.js → settingsAccountV1SettingsEmailVerify.js} +6 -6
- package/funcs/settingsAccountV1SettingsEmailVerify.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/lib/config.js.map +1 -1
- package/models/components/errormodel.d.ts +63 -0
- package/models/components/errormodel.d.ts.map +1 -0
- package/models/components/errormodel.js +81 -0
- package/models/components/errormodel.js.map +1 -0
- package/models/components/index.d.ts +2 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +2 -0
- package/models/components/index.js.map +1 -1
- package/models/components/v1accountinforesponsebody.d.ts +3 -0
- package/models/components/v1accountinforesponsebody.d.ts.map +1 -1
- package/models/components/v1accountinforesponsebody.js +1 -0
- package/models/components/v1accountinforesponsebody.js.map +1 -1
- package/models/components/v1emailsubscriptionrequestbody.d.ts +37 -0
- package/models/components/v1emailsubscriptionrequestbody.d.ts.map +1 -0
- package/models/components/v1emailsubscriptionrequestbody.js +61 -0
- package/models/components/v1emailsubscriptionrequestbody.js.map +1 -0
- package/models/components/v1getsettingsbody.d.ts +5 -0
- package/models/components/v1getsettingsbody.d.ts.map +1 -1
- package/models/components/v1getsettingsbody.js +2 -0
- package/models/components/v1getsettingsbody.js.map +1 -1
- package/models/operations/accountv1settingsemailsendverification.d.ts +61 -0
- package/models/operations/{accountv1settingssendemailverification.d.ts.map → accountv1settingsemailsendverification.d.ts.map} +1 -1
- package/models/operations/accountv1settingsemailsendverification.js +108 -0
- package/models/operations/{accountv1settingssendemailverification.js.map → accountv1settingsemailsendverification.js.map} +1 -1
- package/models/operations/accountv1settingsemailsubscribe.d.ts +63 -0
- package/models/operations/accountv1settingsemailsubscribe.d.ts.map +1 -0
- package/models/operations/accountv1settingsemailsubscribe.js +112 -0
- package/models/operations/accountv1settingsemailsubscribe.js.map +1 -0
- package/models/operations/accountv1settingsemailverify.d.ts +36 -0
- package/models/operations/accountv1settingsemailverify.d.ts.map +1 -0
- package/models/operations/{accountv1settingsverfyemail.js → accountv1settingsemailverify.js} +17 -17
- package/models/operations/accountv1settingsemailverify.js.map +1 -0
- package/models/operations/index.d.ts +4 -2
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +4 -2
- package/models/operations/index.js.map +1 -1
- package/models/operations/resendwebhook.d.ts +66 -0
- package/models/operations/resendwebhook.d.ts.map +1 -0
- package/models/operations/resendwebhook.js +130 -0
- package/models/operations/resendwebhook.js.map +1 -0
- package/package.json +1 -1
- package/sdk/account.d.ts +3 -2
- package/sdk/account.d.ts.map +1 -1
- package/sdk/account.js +12 -8
- package/sdk/account.js.map +1 -1
- package/sdk/internal.d.ts +3 -2
- package/sdk/internal.d.ts.map +1 -1
- package/sdk/internal.js +12 -8
- package/sdk/internal.js.map +1 -1
- package/sdk/sdk.d.ts +5 -3
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +8 -3
- package/sdk/sdk.js.map +1 -1
- package/sdk/settings.d.ts +3 -2
- package/sdk/settings.d.ts.map +1 -1
- package/sdk/settings.js +12 -8
- package/sdk/settings.js.map +1 -1
- package/src/funcs/{internalSendEmailVerification.ts → accountAccountV1SettingsEmailSendVerification.ts} +8 -8
- package/src/funcs/accountAccountV1SettingsEmailSubscribe.ts +160 -0
- package/src/funcs/{settingsVerifyEmail.ts → accountAccountV1SettingsEmailVerify.ts} +6 -6
- package/src/funcs/{accountSendEmailVerification.ts → internalAccountV1SettingsEmailSendVerification.ts} +8 -8
- package/src/funcs/internalAccountV1SettingsEmailSubscribe.ts +160 -0
- package/src/funcs/{internalVerifyEmail.ts → internalAccountV1SettingsEmailVerify.ts} +6 -6
- package/src/funcs/resendWebhook.ts +153 -0
- package/src/funcs/{settingsSendEmailVerification.ts → settingsAccountV1SettingsEmailSendVerification.ts} +8 -8
- package/src/funcs/settingsAccountV1SettingsEmailSubscribe.ts +160 -0
- package/src/funcs/{accountVerifyEmail.ts → settingsAccountV1SettingsEmailVerify.ts} +6 -6
- package/src/lib/config.ts +2 -2
- package/src/models/components/errormodel.ts +122 -0
- package/src/models/components/index.ts +2 -0
- package/src/models/components/v1accountinforesponsebody.ts +1 -0
- package/src/models/components/v1emailsubscriptionrequestbody.ts +78 -0
- package/src/models/components/v1getsettingsbody.ts +7 -0
- package/src/models/operations/{accountv1settingssendemailverification.ts → accountv1settingsemailsendverification.ts} +46 -46
- package/src/models/operations/accountv1settingsemailsubscribe.ts +174 -0
- package/src/models/operations/{accountv1settingsverfyemail.ts → accountv1settingsemailverify.ts} +22 -22
- package/src/models/operations/index.ts +4 -2
- package/src/models/operations/resendwebhook.ts +179 -0
- package/src/sdk/account.ts +36 -24
- package/src/sdk/internal.ts +36 -24
- package/src/sdk/sdk.ts +20 -6
- package/src/sdk/settings.ts +32 -20
- package/funcs/accountSendEmailVerification.d.ts.map +0 -1
- package/funcs/accountSendEmailVerification.js.map +0 -1
- package/funcs/accountVerifyEmail.d.ts.map +0 -1
- package/funcs/accountVerifyEmail.js.map +0 -1
- package/funcs/internalSendEmailVerification.d.ts.map +0 -1
- package/funcs/internalSendEmailVerification.js.map +0 -1
- package/funcs/internalVerifyEmail.d.ts.map +0 -1
- package/funcs/internalVerifyEmail.js.map +0 -1
- package/funcs/settingsSendEmailVerification.d.ts.map +0 -1
- package/funcs/settingsSendEmailVerification.js.map +0 -1
- package/funcs/settingsVerifyEmail.d.ts.map +0 -1
- package/funcs/settingsVerifyEmail.js.map +0 -1
- package/models/operations/accountv1settingssendemailverification.d.ts +0 -61
- package/models/operations/accountv1settingssendemailverification.js +0 -108
- package/models/operations/accountv1settingsverfyemail.d.ts +0 -36
- package/models/operations/accountv1settingsverfyemail.d.ts.map +0 -1
- package/models/operations/accountv1settingsverfyemail.js.map +0 -1
|
@@ -12,16 +12,17 @@ There requests are just document for documentations sake, they are not meant to
|
|
|
12
12
|
* [deleteDeveloperApp](#deletedeveloperapp)
|
|
13
13
|
* [deleteImages](#deleteimages)
|
|
14
14
|
* [updateApp](#updateapp)
|
|
15
|
+
* [accountV1SettingsEmailSendVerification](#accountv1settingsemailsendverification)
|
|
16
|
+
* [accountV1SettingsEmailSubscribe](#accountv1settingsemailsubscribe)
|
|
17
|
+
* [accountV1SettingsEmailVerify](#accountv1settingsemailverify)
|
|
15
18
|
* [accountV1GetBadgeBookmarks](#accountv1getbadgebookmarks)
|
|
16
19
|
* [accountV1ImagesGet](#accountv1imagesget)
|
|
17
20
|
* [accountV1GetOwnedBadges](#accountv1getownedbadges)
|
|
18
21
|
* [getStaff](#getstaff)
|
|
19
22
|
* [accountV1ConnectionReconnect](#accountv1connectionreconnect)
|
|
20
|
-
* [sendEmailVerification](#sendemailverification)
|
|
21
23
|
* [accountV1ImagesUpdate](#accountv1imagesupdate)
|
|
22
24
|
* [accountV1SettingsUpdateRole](#accountv1settingsupdaterole)
|
|
23
25
|
* [uploadImages](#uploadimages)
|
|
24
|
-
* [verifyEmail](#verifyemail)
|
|
25
26
|
* [getAccount](#getaccount)
|
|
26
27
|
* [adminV1GetEvents](#adminv1getevents)
|
|
27
28
|
* [adminV1UpdateEvent](#adminv1updateevent)
|
|
@@ -431,7 +432,7 @@ run();
|
|
|
431
432
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
432
433
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
433
434
|
|
|
434
|
-
##
|
|
435
|
+
## accountV1SettingsEmailSendVerification
|
|
435
436
|
|
|
436
437
|
### Example Usage
|
|
437
438
|
|
|
@@ -443,7 +444,7 @@ const steamSets = new SteamSets({
|
|
|
443
444
|
});
|
|
444
445
|
|
|
445
446
|
async function run() {
|
|
446
|
-
const result = await steamSets.internal.
|
|
447
|
+
const result = await steamSets.internal.accountV1SettingsEmailSendVerification({});
|
|
447
448
|
|
|
448
449
|
// Handle the result
|
|
449
450
|
console.log(result);
|
|
@@ -458,7 +459,7 @@ The standalone function version of this method:
|
|
|
458
459
|
|
|
459
460
|
```typescript
|
|
460
461
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
461
|
-
import {
|
|
462
|
+
import { internalAccountV1SettingsEmailSendVerification } from "@steamsets/client-ts/funcs/internalAccountV1SettingsEmailSendVerification.js";
|
|
462
463
|
|
|
463
464
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
464
465
|
// You can create one instance of it to use across an application.
|
|
@@ -467,7 +468,7 @@ const steamSets = new SteamSetsCore({
|
|
|
467
468
|
});
|
|
468
469
|
|
|
469
470
|
async function run() {
|
|
470
|
-
const res = await
|
|
471
|
+
const res = await internalAccountV1SettingsEmailSendVerification(steamSets, {});
|
|
471
472
|
|
|
472
473
|
if (!res.ok) {
|
|
473
474
|
throw res.error;
|
|
@@ -486,23 +487,24 @@ run();
|
|
|
486
487
|
|
|
487
488
|
| Parameter | Type | Required | Description |
|
|
488
489
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
490
|
+
| `request` | [operations.AccountV1SettingsEmailSendVerificationRequest](../../models/operations/accountv1settingsemailsendverificationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
489
491
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
490
492
|
| `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. |
|
|
491
493
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
492
494
|
|
|
493
495
|
### Response
|
|
494
496
|
|
|
495
|
-
**Promise\<[operations.
|
|
497
|
+
**Promise\<[operations.AccountV1SettingsEmailSendVerificationResponse](../../models/operations/accountv1settingsemailsendverificationresponse.md)\>**
|
|
496
498
|
|
|
497
499
|
### Errors
|
|
498
500
|
|
|
499
501
|
| Error Type | Status Code | Content Type |
|
|
500
502
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
501
|
-
| errors.ErrorModel |
|
|
503
|
+
| errors.ErrorModel | 404, 422, 429 | application/problem+json |
|
|
502
504
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
503
505
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
504
506
|
|
|
505
|
-
##
|
|
507
|
+
## accountV1SettingsEmailSubscribe
|
|
506
508
|
|
|
507
509
|
### Example Usage
|
|
508
510
|
|
|
@@ -514,7 +516,12 @@ const steamSets = new SteamSets({
|
|
|
514
516
|
});
|
|
515
517
|
|
|
516
518
|
async function run() {
|
|
517
|
-
const result = await steamSets.internal.
|
|
519
|
+
const result = await steamSets.internal.accountV1SettingsEmailSubscribe({
|
|
520
|
+
v1EmailSubscriptionRequestBody: {
|
|
521
|
+
email: "steamsets@example.com",
|
|
522
|
+
subscribed: true,
|
|
523
|
+
},
|
|
524
|
+
});
|
|
518
525
|
|
|
519
526
|
// Handle the result
|
|
520
527
|
console.log(result);
|
|
@@ -529,7 +536,7 @@ The standalone function version of this method:
|
|
|
529
536
|
|
|
530
537
|
```typescript
|
|
531
538
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
532
|
-
import {
|
|
539
|
+
import { internalAccountV1SettingsEmailSubscribe } from "@steamsets/client-ts/funcs/internalAccountV1SettingsEmailSubscribe.js";
|
|
533
540
|
|
|
534
541
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
535
542
|
// You can create one instance of it to use across an application.
|
|
@@ -538,7 +545,12 @@ const steamSets = new SteamSetsCore({
|
|
|
538
545
|
});
|
|
539
546
|
|
|
540
547
|
async function run() {
|
|
541
|
-
const res = await
|
|
548
|
+
const res = await internalAccountV1SettingsEmailSubscribe(steamSets, {
|
|
549
|
+
v1EmailSubscriptionRequestBody: {
|
|
550
|
+
email: "steamsets@example.com",
|
|
551
|
+
subscribed: true,
|
|
552
|
+
},
|
|
553
|
+
});
|
|
542
554
|
|
|
543
555
|
if (!res.ok) {
|
|
544
556
|
throw res.error;
|
|
@@ -557,22 +569,24 @@ run();
|
|
|
557
569
|
|
|
558
570
|
| Parameter | Type | Required | Description |
|
|
559
571
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
572
|
+
| `request` | [operations.AccountV1SettingsEmailSubscribeRequest](../../models/operations/accountv1settingsemailsubscriberequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
560
573
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
561
574
|
| `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. |
|
|
562
575
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
563
576
|
|
|
564
577
|
### Response
|
|
565
578
|
|
|
566
|
-
**Promise\<[operations.
|
|
579
|
+
**Promise\<[operations.AccountV1SettingsEmailSubscribeResponse](../../models/operations/accountv1settingsemailsubscriberesponse.md)\>**
|
|
567
580
|
|
|
568
581
|
### Errors
|
|
569
582
|
|
|
570
583
|
| Error Type | Status Code | Content Type |
|
|
571
584
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
585
|
+
| errors.ErrorModel | 422, 429 | application/problem+json |
|
|
572
586
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
573
587
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
574
588
|
|
|
575
|
-
##
|
|
589
|
+
## accountV1SettingsEmailVerify
|
|
576
590
|
|
|
577
591
|
### Example Usage
|
|
578
592
|
|
|
@@ -584,7 +598,9 @@ const steamSets = new SteamSets({
|
|
|
584
598
|
});
|
|
585
599
|
|
|
586
600
|
async function run() {
|
|
587
|
-
const result = await steamSets.internal.
|
|
601
|
+
const result = await steamSets.internal.accountV1SettingsEmailVerify({
|
|
602
|
+
code: "123456",
|
|
603
|
+
});
|
|
588
604
|
|
|
589
605
|
// Handle the result
|
|
590
606
|
console.log(result);
|
|
@@ -599,7 +615,7 @@ The standalone function version of this method:
|
|
|
599
615
|
|
|
600
616
|
```typescript
|
|
601
617
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
602
|
-
import {
|
|
618
|
+
import { internalAccountV1SettingsEmailVerify } from "@steamsets/client-ts/funcs/internalAccountV1SettingsEmailVerify.js";
|
|
603
619
|
|
|
604
620
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
605
621
|
// You can create one instance of it to use across an application.
|
|
@@ -608,7 +624,9 @@ const steamSets = new SteamSetsCore({
|
|
|
608
624
|
});
|
|
609
625
|
|
|
610
626
|
async function run() {
|
|
611
|
-
const res = await
|
|
627
|
+
const res = await internalAccountV1SettingsEmailVerify(steamSets, {
|
|
628
|
+
code: "123456",
|
|
629
|
+
});
|
|
612
630
|
|
|
613
631
|
if (!res.ok) {
|
|
614
632
|
throw res.error;
|
|
@@ -627,23 +645,24 @@ run();
|
|
|
627
645
|
|
|
628
646
|
| Parameter | Type | Required | Description |
|
|
629
647
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
648
|
+
| `request` | [components.V1VerifyEmailRequestBody](../../models/components/v1verifyemailrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
630
649
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
631
650
|
| `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. |
|
|
632
651
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
633
652
|
|
|
634
653
|
### Response
|
|
635
654
|
|
|
636
|
-
**Promise\<[operations.
|
|
655
|
+
**Promise\<[operations.AccountV1SettingsEmailVerifyResponse](../../models/operations/accountv1settingsemailverifyresponse.md)\>**
|
|
637
656
|
|
|
638
657
|
### Errors
|
|
639
658
|
|
|
640
659
|
| Error Type | Status Code | Content Type |
|
|
641
660
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
642
|
-
| errors.ErrorModel |
|
|
661
|
+
| errors.ErrorModel | 404, 422, 429 | application/problem+json |
|
|
643
662
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
644
663
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
645
664
|
|
|
646
|
-
##
|
|
665
|
+
## accountV1GetBadgeBookmarks
|
|
647
666
|
|
|
648
667
|
### Example Usage
|
|
649
668
|
|
|
@@ -655,7 +674,7 @@ const steamSets = new SteamSets({
|
|
|
655
674
|
});
|
|
656
675
|
|
|
657
676
|
async function run() {
|
|
658
|
-
const result = await steamSets.internal.
|
|
677
|
+
const result = await steamSets.internal.accountV1GetBadgeBookmarks();
|
|
659
678
|
|
|
660
679
|
// Handle the result
|
|
661
680
|
console.log(result);
|
|
@@ -670,7 +689,7 @@ The standalone function version of this method:
|
|
|
670
689
|
|
|
671
690
|
```typescript
|
|
672
691
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
673
|
-
import {
|
|
692
|
+
import { internalAccountV1GetBadgeBookmarks } from "@steamsets/client-ts/funcs/internalAccountV1GetBadgeBookmarks.js";
|
|
674
693
|
|
|
675
694
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
676
695
|
// You can create one instance of it to use across an application.
|
|
@@ -679,7 +698,7 @@ const steamSets = new SteamSetsCore({
|
|
|
679
698
|
});
|
|
680
699
|
|
|
681
700
|
async function run() {
|
|
682
|
-
const res = await
|
|
701
|
+
const res = await internalAccountV1GetBadgeBookmarks(steamSets);
|
|
683
702
|
|
|
684
703
|
if (!res.ok) {
|
|
685
704
|
throw res.error;
|
|
@@ -704,17 +723,17 @@ run();
|
|
|
704
723
|
|
|
705
724
|
### Response
|
|
706
725
|
|
|
707
|
-
**Promise\<[operations.
|
|
726
|
+
**Promise\<[operations.AccountV1GetBadgeBookmarksResponse](../../models/operations/accountv1getbadgebookmarksresponse.md)\>**
|
|
708
727
|
|
|
709
728
|
### Errors
|
|
710
729
|
|
|
711
730
|
| Error Type | Status Code | Content Type |
|
|
712
731
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
713
|
-
| errors.ErrorModel |
|
|
732
|
+
| errors.ErrorModel | 403, 404 | application/problem+json |
|
|
714
733
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
715
734
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
716
735
|
|
|
717
|
-
##
|
|
736
|
+
## accountV1ImagesGet
|
|
718
737
|
|
|
719
738
|
### Example Usage
|
|
720
739
|
|
|
@@ -726,10 +745,7 @@ const steamSets = new SteamSets({
|
|
|
726
745
|
});
|
|
727
746
|
|
|
728
747
|
async function run() {
|
|
729
|
-
const result = await steamSets.internal.
|
|
730
|
-
code: "123456",
|
|
731
|
-
connectionId: "123456",
|
|
732
|
-
});
|
|
748
|
+
const result = await steamSets.internal.accountV1ImagesGet();
|
|
733
749
|
|
|
734
750
|
// Handle the result
|
|
735
751
|
console.log(result);
|
|
@@ -744,7 +760,7 @@ The standalone function version of this method:
|
|
|
744
760
|
|
|
745
761
|
```typescript
|
|
746
762
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
747
|
-
import {
|
|
763
|
+
import { internalAccountV1ImagesGet } from "@steamsets/client-ts/funcs/internalAccountV1ImagesGet.js";
|
|
748
764
|
|
|
749
765
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
750
766
|
// You can create one instance of it to use across an application.
|
|
@@ -753,10 +769,7 @@ const steamSets = new SteamSetsCore({
|
|
|
753
769
|
});
|
|
754
770
|
|
|
755
771
|
async function run() {
|
|
756
|
-
const res = await
|
|
757
|
-
code: "123456",
|
|
758
|
-
connectionId: "123456",
|
|
759
|
-
});
|
|
772
|
+
const res = await internalAccountV1ImagesGet(steamSets);
|
|
760
773
|
|
|
761
774
|
if (!res.ok) {
|
|
762
775
|
throw res.error;
|
|
@@ -775,24 +788,22 @@ run();
|
|
|
775
788
|
|
|
776
789
|
| Parameter | Type | Required | Description |
|
|
777
790
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
778
|
-
| `request` | [components.V1ReconnectRequestBody](../../models/components/v1reconnectrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
779
791
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
780
792
|
| `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. |
|
|
781
793
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
782
794
|
|
|
783
795
|
### Response
|
|
784
796
|
|
|
785
|
-
**Promise\<[operations.
|
|
797
|
+
**Promise\<[operations.AccountV1ImagesGetResponse](../../models/operations/accountv1imagesgetresponse.md)\>**
|
|
786
798
|
|
|
787
799
|
### Errors
|
|
788
800
|
|
|
789
801
|
| Error Type | Status Code | Content Type |
|
|
790
802
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
791
|
-
| errors.ErrorModel | 400, 422 | application/problem+json |
|
|
792
803
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
793
804
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
794
805
|
|
|
795
|
-
##
|
|
806
|
+
## accountV1GetOwnedBadges
|
|
796
807
|
|
|
797
808
|
### Example Usage
|
|
798
809
|
|
|
@@ -804,7 +815,7 @@ const steamSets = new SteamSets({
|
|
|
804
815
|
});
|
|
805
816
|
|
|
806
817
|
async function run() {
|
|
807
|
-
const result = await steamSets.internal.
|
|
818
|
+
const result = await steamSets.internal.accountV1GetOwnedBadges();
|
|
808
819
|
|
|
809
820
|
// Handle the result
|
|
810
821
|
console.log(result);
|
|
@@ -819,7 +830,7 @@ The standalone function version of this method:
|
|
|
819
830
|
|
|
820
831
|
```typescript
|
|
821
832
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
822
|
-
import {
|
|
833
|
+
import { internalAccountV1GetOwnedBadges } from "@steamsets/client-ts/funcs/internalAccountV1GetOwnedBadges.js";
|
|
823
834
|
|
|
824
835
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
825
836
|
// You can create one instance of it to use across an application.
|
|
@@ -828,7 +839,7 @@ const steamSets = new SteamSetsCore({
|
|
|
828
839
|
});
|
|
829
840
|
|
|
830
841
|
async function run() {
|
|
831
|
-
const res = await
|
|
842
|
+
const res = await internalAccountV1GetOwnedBadges(steamSets);
|
|
832
843
|
|
|
833
844
|
if (!res.ok) {
|
|
834
845
|
throw res.error;
|
|
@@ -847,24 +858,23 @@ run();
|
|
|
847
858
|
|
|
848
859
|
| Parameter | Type | Required | Description |
|
|
849
860
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
850
|
-
| `request` | [operations.AccountV1SettingsSendEmailVerificationRequest](../../models/operations/accountv1settingssendemailverificationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
851
861
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
852
862
|
| `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. |
|
|
853
863
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
854
864
|
|
|
855
865
|
### Response
|
|
856
866
|
|
|
857
|
-
**Promise\<[operations.
|
|
867
|
+
**Promise\<[operations.AccountV1GetOwnedBadgesResponse](../../models/operations/accountv1getownedbadgesresponse.md)\>**
|
|
858
868
|
|
|
859
869
|
### Errors
|
|
860
870
|
|
|
861
871
|
| Error Type | Status Code | Content Type |
|
|
862
872
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
863
|
-
| errors.ErrorModel |
|
|
873
|
+
| errors.ErrorModel | 403, 404 | application/problem+json |
|
|
864
874
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
865
875
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
866
876
|
|
|
867
|
-
##
|
|
877
|
+
## getStaff
|
|
868
878
|
|
|
869
879
|
### Example Usage
|
|
870
880
|
|
|
@@ -876,11 +886,7 @@ const steamSets = new SteamSets({
|
|
|
876
886
|
});
|
|
877
887
|
|
|
878
888
|
async function run() {
|
|
879
|
-
const result = await steamSets.internal.
|
|
880
|
-
images: [
|
|
881
|
-
|
|
882
|
-
],
|
|
883
|
-
});
|
|
889
|
+
const result = await steamSets.internal.getStaff();
|
|
884
890
|
|
|
885
891
|
// Handle the result
|
|
886
892
|
console.log(result);
|
|
@@ -895,7 +901,7 @@ The standalone function version of this method:
|
|
|
895
901
|
|
|
896
902
|
```typescript
|
|
897
903
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
898
|
-
import {
|
|
904
|
+
import { internalGetStaff } from "@steamsets/client-ts/funcs/internalGetStaff.js";
|
|
899
905
|
|
|
900
906
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
901
907
|
// You can create one instance of it to use across an application.
|
|
@@ -904,11 +910,7 @@ const steamSets = new SteamSetsCore({
|
|
|
904
910
|
});
|
|
905
911
|
|
|
906
912
|
async function run() {
|
|
907
|
-
const res = await
|
|
908
|
-
images: [
|
|
909
|
-
|
|
910
|
-
],
|
|
911
|
-
});
|
|
913
|
+
const res = await internalGetStaff(steamSets);
|
|
912
914
|
|
|
913
915
|
if (!res.ok) {
|
|
914
916
|
throw res.error;
|
|
@@ -927,24 +929,23 @@ run();
|
|
|
927
929
|
|
|
928
930
|
| Parameter | Type | Required | Description |
|
|
929
931
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
930
|
-
| `request` | [components.V1UpdateImageRequestBody](../../models/components/v1updateimagerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
931
932
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
932
933
|
| `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. |
|
|
933
934
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
934
935
|
|
|
935
936
|
### Response
|
|
936
937
|
|
|
937
|
-
**Promise\<[operations.
|
|
938
|
+
**Promise\<[operations.AccountV1GetStaffResponse](../../models/operations/accountv1getstaffresponse.md)\>**
|
|
938
939
|
|
|
939
940
|
### Errors
|
|
940
941
|
|
|
941
942
|
| Error Type | Status Code | Content Type |
|
|
942
943
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
943
|
-
| errors.ErrorModel | 404,
|
|
944
|
+
| errors.ErrorModel | 404, 429 | application/problem+json |
|
|
944
945
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
945
946
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
946
947
|
|
|
947
|
-
##
|
|
948
|
+
## accountV1ConnectionReconnect
|
|
948
949
|
|
|
949
950
|
### Example Usage
|
|
950
951
|
|
|
@@ -956,7 +957,10 @@ const steamSets = new SteamSets({
|
|
|
956
957
|
});
|
|
957
958
|
|
|
958
959
|
async function run() {
|
|
959
|
-
const result = await steamSets.internal.
|
|
960
|
+
const result = await steamSets.internal.accountV1ConnectionReconnect({
|
|
961
|
+
code: "123456",
|
|
962
|
+
connectionId: "123456",
|
|
963
|
+
});
|
|
960
964
|
|
|
961
965
|
// Handle the result
|
|
962
966
|
console.log(result);
|
|
@@ -971,7 +975,7 @@ The standalone function version of this method:
|
|
|
971
975
|
|
|
972
976
|
```typescript
|
|
973
977
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
974
|
-
import {
|
|
978
|
+
import { internalAccountV1ConnectionReconnect } from "@steamsets/client-ts/funcs/internalAccountV1ConnectionReconnect.js";
|
|
975
979
|
|
|
976
980
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
977
981
|
// You can create one instance of it to use across an application.
|
|
@@ -980,7 +984,10 @@ const steamSets = new SteamSetsCore({
|
|
|
980
984
|
});
|
|
981
985
|
|
|
982
986
|
async function run() {
|
|
983
|
-
const res = await
|
|
987
|
+
const res = await internalAccountV1ConnectionReconnect(steamSets, {
|
|
988
|
+
code: "123456",
|
|
989
|
+
connectionId: "123456",
|
|
990
|
+
});
|
|
984
991
|
|
|
985
992
|
if (!res.ok) {
|
|
986
993
|
throw res.error;
|
|
@@ -999,24 +1006,24 @@ run();
|
|
|
999
1006
|
|
|
1000
1007
|
| Parameter | Type | Required | Description |
|
|
1001
1008
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1002
|
-
| `request` | [components.
|
|
1009
|
+
| `request` | [components.V1ReconnectRequestBody](../../models/components/v1reconnectrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1003
1010
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1004
1011
|
| `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. |
|
|
1005
1012
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1006
1013
|
|
|
1007
1014
|
### Response
|
|
1008
1015
|
|
|
1009
|
-
**Promise\<[operations.
|
|
1016
|
+
**Promise\<[operations.AccountV1ConnectionReconnectResponse](../../models/operations/accountv1connectionreconnectresponse.md)\>**
|
|
1010
1017
|
|
|
1011
1018
|
### Errors
|
|
1012
1019
|
|
|
1013
1020
|
| Error Type | Status Code | Content Type |
|
|
1014
1021
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1015
|
-
| errors.ErrorModel |
|
|
1022
|
+
| errors.ErrorModel | 400, 422 | application/problem+json |
|
|
1016
1023
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
1017
1024
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1018
1025
|
|
|
1019
|
-
##
|
|
1026
|
+
## accountV1ImagesUpdate
|
|
1020
1027
|
|
|
1021
1028
|
### Example Usage
|
|
1022
1029
|
|
|
@@ -1028,7 +1035,7 @@ const steamSets = new SteamSets({
|
|
|
1028
1035
|
});
|
|
1029
1036
|
|
|
1030
1037
|
async function run() {
|
|
1031
|
-
const result = await steamSets.internal.
|
|
1038
|
+
const result = await steamSets.internal.accountV1ImagesUpdate({
|
|
1032
1039
|
images: [
|
|
1033
1040
|
|
|
1034
1041
|
],
|
|
@@ -1047,7 +1054,7 @@ The standalone function version of this method:
|
|
|
1047
1054
|
|
|
1048
1055
|
```typescript
|
|
1049
1056
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1050
|
-
import {
|
|
1057
|
+
import { internalAccountV1ImagesUpdate } from "@steamsets/client-ts/funcs/internalAccountV1ImagesUpdate.js";
|
|
1051
1058
|
|
|
1052
1059
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1053
1060
|
// You can create one instance of it to use across an application.
|
|
@@ -1056,7 +1063,7 @@ const steamSets = new SteamSetsCore({
|
|
|
1056
1063
|
});
|
|
1057
1064
|
|
|
1058
1065
|
async function run() {
|
|
1059
|
-
const res = await
|
|
1066
|
+
const res = await internalAccountV1ImagesUpdate(steamSets, {
|
|
1060
1067
|
images: [
|
|
1061
1068
|
|
|
1062
1069
|
],
|
|
@@ -1079,24 +1086,24 @@ run();
|
|
|
1079
1086
|
|
|
1080
1087
|
| Parameter | Type | Required | Description |
|
|
1081
1088
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1082
|
-
| `request` | [components.
|
|
1089
|
+
| `request` | [components.V1UpdateImageRequestBody](../../models/components/v1updateimagerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1083
1090
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1084
1091
|
| `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. |
|
|
1085
1092
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1086
1093
|
|
|
1087
1094
|
### Response
|
|
1088
1095
|
|
|
1089
|
-
**Promise\<[operations.
|
|
1096
|
+
**Promise\<[operations.AccountV1ImagesUpdateResponse](../../models/operations/accountv1imagesupdateresponse.md)\>**
|
|
1090
1097
|
|
|
1091
1098
|
### Errors
|
|
1092
1099
|
|
|
1093
1100
|
| Error Type | Status Code | Content Type |
|
|
1094
1101
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1095
|
-
| errors.ErrorModel | 422
|
|
1102
|
+
| errors.ErrorModel | 404, 422 | application/problem+json |
|
|
1096
1103
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
1097
1104
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1098
1105
|
|
|
1099
|
-
##
|
|
1106
|
+
## accountV1SettingsUpdateRole
|
|
1100
1107
|
|
|
1101
1108
|
### Example Usage
|
|
1102
1109
|
|
|
@@ -1108,8 +1115,82 @@ const steamSets = new SteamSets({
|
|
|
1108
1115
|
});
|
|
1109
1116
|
|
|
1110
1117
|
async function run() {
|
|
1111
|
-
const result = await steamSets.internal.
|
|
1112
|
-
|
|
1118
|
+
const result = await steamSets.internal.accountV1SettingsUpdateRole({});
|
|
1119
|
+
|
|
1120
|
+
// Handle the result
|
|
1121
|
+
console.log(result);
|
|
1122
|
+
}
|
|
1123
|
+
|
|
1124
|
+
run();
|
|
1125
|
+
```
|
|
1126
|
+
|
|
1127
|
+
### Standalone function
|
|
1128
|
+
|
|
1129
|
+
The standalone function version of this method:
|
|
1130
|
+
|
|
1131
|
+
```typescript
|
|
1132
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1133
|
+
import { internalAccountV1SettingsUpdateRole } from "@steamsets/client-ts/funcs/internalAccountV1SettingsUpdateRole.js";
|
|
1134
|
+
|
|
1135
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1136
|
+
// You can create one instance of it to use across an application.
|
|
1137
|
+
const steamSets = new SteamSetsCore({
|
|
1138
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1139
|
+
});
|
|
1140
|
+
|
|
1141
|
+
async function run() {
|
|
1142
|
+
const res = await internalAccountV1SettingsUpdateRole(steamSets, {});
|
|
1143
|
+
|
|
1144
|
+
if (!res.ok) {
|
|
1145
|
+
throw res.error;
|
|
1146
|
+
}
|
|
1147
|
+
|
|
1148
|
+
const { value: result } = res;
|
|
1149
|
+
|
|
1150
|
+
// Handle the result
|
|
1151
|
+
console.log(result);
|
|
1152
|
+
}
|
|
1153
|
+
|
|
1154
|
+
run();
|
|
1155
|
+
```
|
|
1156
|
+
|
|
1157
|
+
### Parameters
|
|
1158
|
+
|
|
1159
|
+
| Parameter | Type | Required | Description |
|
|
1160
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1161
|
+
| `request` | [components.V1UpdateRoleRequestBody](../../models/components/v1updaterolerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1162
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1163
|
+
| `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. |
|
|
1164
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1165
|
+
|
|
1166
|
+
### Response
|
|
1167
|
+
|
|
1168
|
+
**Promise\<[operations.AccountV1SettingsUpdateRoleResponse](../../models/operations/accountv1settingsupdateroleresponse.md)\>**
|
|
1169
|
+
|
|
1170
|
+
### Errors
|
|
1171
|
+
|
|
1172
|
+
| Error Type | Status Code | Content Type |
|
|
1173
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
1174
|
+
| errors.ErrorModel | 422, 429 | application/problem+json |
|
|
1175
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
1176
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1177
|
+
|
|
1178
|
+
## uploadImages
|
|
1179
|
+
|
|
1180
|
+
### Example Usage
|
|
1181
|
+
|
|
1182
|
+
```typescript
|
|
1183
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
1184
|
+
|
|
1185
|
+
const steamSets = new SteamSets({
|
|
1186
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1187
|
+
});
|
|
1188
|
+
|
|
1189
|
+
async function run() {
|
|
1190
|
+
const result = await steamSets.internal.uploadImages({
|
|
1191
|
+
images: [
|
|
1192
|
+
|
|
1193
|
+
],
|
|
1113
1194
|
});
|
|
1114
1195
|
|
|
1115
1196
|
// Handle the result
|
|
@@ -1125,7 +1206,7 @@ The standalone function version of this method:
|
|
|
1125
1206
|
|
|
1126
1207
|
```typescript
|
|
1127
1208
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1128
|
-
import {
|
|
1209
|
+
import { internalUploadImages } from "@steamsets/client-ts/funcs/internalUploadImages.js";
|
|
1129
1210
|
|
|
1130
1211
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1131
1212
|
// You can create one instance of it to use across an application.
|
|
@@ -1134,8 +1215,10 @@ const steamSets = new SteamSetsCore({
|
|
|
1134
1215
|
});
|
|
1135
1216
|
|
|
1136
1217
|
async function run() {
|
|
1137
|
-
const res = await
|
|
1138
|
-
|
|
1218
|
+
const res = await internalUploadImages(steamSets, {
|
|
1219
|
+
images: [
|
|
1220
|
+
|
|
1221
|
+
],
|
|
1139
1222
|
});
|
|
1140
1223
|
|
|
1141
1224
|
if (!res.ok) {
|
|
@@ -1155,20 +1238,20 @@ run();
|
|
|
1155
1238
|
|
|
1156
1239
|
| Parameter | Type | Required | Description |
|
|
1157
1240
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1158
|
-
| `request` | [components.
|
|
1241
|
+
| `request` | [components.V1UploadImagesRequestBody](../../models/components/v1uploadimagesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1159
1242
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1160
1243
|
| `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. |
|
|
1161
1244
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1162
1245
|
|
|
1163
1246
|
### Response
|
|
1164
1247
|
|
|
1165
|
-
**Promise\<[operations.
|
|
1248
|
+
**Promise\<[operations.AccountV1ImagesUploadResponse](../../models/operations/accountv1imagesuploadresponse.md)\>**
|
|
1166
1249
|
|
|
1167
1250
|
### Errors
|
|
1168
1251
|
|
|
1169
1252
|
| Error Type | Status Code | Content Type |
|
|
1170
1253
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1171
|
-
| errors.ErrorModel |
|
|
1254
|
+
| errors.ErrorModel | 422 | application/problem+json |
|
|
1172
1255
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
1173
1256
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1174
1257
|
|