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