@steamsets/client-ts 0.14.27 → 0.14.29

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. package/README.md +6 -0
  2. package/docs/sdks/account/README.md +77 -12
  3. package/docs/sdks/data/README.md +4 -12
  4. package/docs/sdks/external/README.md +4 -12
  5. package/docs/sdks/internal/README.md +73 -0
  6. package/docs/sdks/settings/README.md +73 -0
  7. package/funcs/accountAccountV1SettingsUpdateRole.d.ts +11 -0
  8. package/funcs/accountAccountV1SettingsUpdateRole.d.ts.map +1 -0
  9. package/funcs/accountAccountV1SettingsUpdateRole.js +113 -0
  10. package/funcs/accountAccountV1SettingsUpdateRole.js.map +1 -0
  11. package/funcs/internalAccountV1SettingsUpdateRole.d.ts +11 -0
  12. package/funcs/internalAccountV1SettingsUpdateRole.d.ts.map +1 -0
  13. package/funcs/internalAccountV1SettingsUpdateRole.js +113 -0
  14. package/funcs/internalAccountV1SettingsUpdateRole.js.map +1 -0
  15. package/funcs/settingsAccountV1SettingsUpdateRole.d.ts +11 -0
  16. package/funcs/settingsAccountV1SettingsUpdateRole.d.ts.map +1 -0
  17. package/funcs/settingsAccountV1SettingsUpdateRole.js +113 -0
  18. package/funcs/settingsAccountV1SettingsUpdateRole.js.map +1 -0
  19. package/jsr.json +1 -1
  20. package/lib/config.d.ts +3 -3
  21. package/lib/config.js +3 -3
  22. package/models/components/index.d.ts +1 -0
  23. package/models/components/index.d.ts.map +1 -1
  24. package/models/components/index.js +1 -0
  25. package/models/components/index.js.map +1 -1
  26. package/models/components/leaderboardaccount.d.ts +0 -5
  27. package/models/components/leaderboardaccount.d.ts.map +1 -1
  28. package/models/components/leaderboardaccount.js +0 -2
  29. package/models/components/leaderboardaccount.js.map +1 -1
  30. package/models/components/v1accountfriend.d.ts +0 -5
  31. package/models/components/v1accountfriend.d.ts.map +1 -1
  32. package/models/components/v1accountfriend.js +0 -2
  33. package/models/components/v1accountfriend.js.map +1 -1
  34. package/models/components/v1accountinforesponsebody.d.ts +5 -5
  35. package/models/components/v1accountinforesponsebody.d.ts.map +1 -1
  36. package/models/components/v1accountinforesponsebody.js +2 -2
  37. package/models/components/v1accountinforesponsebody.js.map +1 -1
  38. package/models/components/v1accountleaderboardaccount.d.ts +0 -5
  39. package/models/components/v1accountleaderboardaccount.d.ts.map +1 -1
  40. package/models/components/v1accountleaderboardaccount.js +0 -2
  41. package/models/components/v1accountleaderboardaccount.js.map +1 -1
  42. package/models/components/v1updaterolerequestbody.d.ts +76 -0
  43. package/models/components/v1updaterolerequestbody.d.ts.map +1 -0
  44. package/models/components/v1updaterolerequestbody.js +85 -0
  45. package/models/components/v1updaterolerequestbody.js.map +1 -0
  46. package/models/components/v1updatesettingsrequestbody.d.ts +0 -49
  47. package/models/components/v1updatesettingsrequestbody.d.ts.map +1 -1
  48. package/models/components/v1updatesettingsrequestbody.js +1 -29
  49. package/models/components/v1updatesettingsrequestbody.js.map +1 -1
  50. package/models/operations/accountv1settingsupdaterole.d.ts +36 -0
  51. package/models/operations/accountv1settingsupdaterole.d.ts.map +1 -0
  52. package/models/operations/accountv1settingsupdaterole.js +73 -0
  53. package/models/operations/accountv1settingsupdaterole.js.map +1 -0
  54. package/models/operations/index.d.ts +1 -0
  55. package/models/operations/index.d.ts.map +1 -1
  56. package/models/operations/index.js +1 -0
  57. package/models/operations/index.js.map +1 -1
  58. package/package.json +1 -1
  59. package/sdk/account.d.ts +1 -0
  60. package/sdk/account.d.ts.map +1 -1
  61. package/sdk/account.js +4 -0
  62. package/sdk/account.js.map +1 -1
  63. package/sdk/internal.d.ts +1 -0
  64. package/sdk/internal.d.ts.map +1 -1
  65. package/sdk/internal.js +4 -0
  66. package/sdk/internal.js.map +1 -1
  67. package/sdk/settings.d.ts +1 -0
  68. package/sdk/settings.d.ts.map +1 -1
  69. package/sdk/settings.js +4 -0
  70. package/sdk/settings.js.map +1 -1
  71. package/src/funcs/accountAccountV1SettingsUpdateRole.ts +149 -0
  72. package/src/funcs/internalAccountV1SettingsUpdateRole.ts +149 -0
  73. package/src/funcs/settingsAccountV1SettingsUpdateRole.ts +149 -0
  74. package/src/lib/config.ts +3 -3
  75. package/src/models/components/index.ts +1 -0
  76. package/src/models/components/leaderboardaccount.ts +0 -7
  77. package/src/models/components/v1accountfriend.ts +0 -7
  78. package/src/models/components/v1accountinforesponsebody.ts +9 -7
  79. package/src/models/components/v1accountleaderboardaccount.ts +0 -7
  80. package/src/models/components/v1updaterolerequestbody.ts +109 -0
  81. package/src/models/components/v1updatesettingsrequestbody.ts +0 -47
  82. package/src/models/operations/accountv1settingsupdaterole.ts +87 -0
  83. package/src/models/operations/index.ts +1 -0
  84. package/src/sdk/account.ts +12 -0
  85. package/src/sdk/internal.ts +12 -0
  86. package/src/sdk/settings.ts +12 -0
package/README.md CHANGED
@@ -92,6 +92,7 @@ run();
92
92
  * [accountV1ConnectionReconnect](docs/sdks/account/README.md#accountv1connectionreconnect)
93
93
  * [sendEmailVerification](docs/sdks/account/README.md#sendemailverification)
94
94
  * [accountV1ImagesUpdate](docs/sdks/account/README.md#accountv1imagesupdate)
95
+ * [accountV1SettingsUpdateRole](docs/sdks/account/README.md#accountv1settingsupdaterole)
95
96
  * [uploadImages](docs/sdks/account/README.md#uploadimages)
96
97
  * [verifyEmail](docs/sdks/account/README.md#verifyemail)
97
98
  * [getAccount](docs/sdks/account/README.md#getaccount)
@@ -184,6 +185,7 @@ run();
184
185
  * [accountV1ConnectionReconnect](docs/sdks/internal/README.md#accountv1connectionreconnect)
185
186
  * [sendEmailVerification](docs/sdks/internal/README.md#sendemailverification)
186
187
  * [accountV1ImagesUpdate](docs/sdks/internal/README.md#accountv1imagesupdate)
188
+ * [accountV1SettingsUpdateRole](docs/sdks/internal/README.md#accountv1settingsupdaterole)
187
189
  * [uploadImages](docs/sdks/internal/README.md#uploadimages)
188
190
  * [verifyEmail](docs/sdks/internal/README.md#verifyemail)
189
191
  * [getAccount](docs/sdks/internal/README.md#getaccount)
@@ -223,6 +225,7 @@ run();
223
225
 
224
226
  * [get](docs/sdks/settings/README.md#get)
225
227
  * [sendEmailVerification](docs/sdks/settings/README.md#sendemailverification)
228
+ * [accountV1SettingsUpdateRole](docs/sdks/settings/README.md#accountv1settingsupdaterole)
226
229
  * [update](docs/sdks/settings/README.md#update)
227
230
  * [verifyEmail](docs/sdks/settings/README.md#verifyemail)
228
231
 
@@ -594,6 +597,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
594
597
  - [`accountAccountV1GetOwnedBadges`](docs/sdks/account/README.md#accountv1getownedbadges)
595
598
  - [`accountAccountV1ImagesGet`](docs/sdks/account/README.md#accountv1imagesget)
596
599
  - [`accountAccountV1ImagesUpdate`](docs/sdks/account/README.md#accountv1imagesupdate)
600
+ - [`accountAccountV1SettingsUpdateRole`](docs/sdks/account/README.md#accountv1settingsupdaterole)
597
601
  - [`accountAdminV1UpdateResources`](docs/sdks/account/README.md#adminv1updateresources)
598
602
  - [`accountAdminV1UpdateRoles`](docs/sdks/account/README.md#adminv1updateroles)
599
603
  - [`accountCreateDeveloperApp`](docs/sdks/account/README.md#createdeveloperapp)
@@ -656,6 +660,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
656
660
  - [`internalAccountV1GetOwnedBadges`](docs/sdks/internal/README.md#accountv1getownedbadges)
657
661
  - [`internalAccountV1ImagesGet`](docs/sdks/internal/README.md#accountv1imagesget)
658
662
  - [`internalAccountV1ImagesUpdate`](docs/sdks/internal/README.md#accountv1imagesupdate)
663
+ - [`internalAccountV1SettingsUpdateRole`](docs/sdks/internal/README.md#accountv1settingsupdaterole)
659
664
  - [`internalAdminV1GetEvents`](docs/sdks/internal/README.md#adminv1getevents)
660
665
  - [`internalAdminV1UpdateEvent`](docs/sdks/internal/README.md#adminv1updateevent)
661
666
  - [`internalAdminV1UpdateResources`](docs/sdks/internal/README.md#adminv1updateresources)
@@ -681,6 +686,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
681
686
  - [`sessionLogin`](docs/sdks/session/README.md#login)
682
687
  - [`sessionsDelete`](docs/sdks/sessions/README.md#delete)
683
688
  - [`sessionsGet`](docs/sdks/sessions/README.md#get)
689
+ - [`settingsAccountV1SettingsUpdateRole`](docs/sdks/settings/README.md#accountv1settingsupdaterole)
684
690
  - [`settingsGet`](docs/sdks/settings/README.md#get)
685
691
  - [`settingsSendEmailVerification`](docs/sdks/settings/README.md#sendemailverification)
686
692
  - [`settingsUpdate`](docs/sdks/settings/README.md#update)
@@ -24,6 +24,7 @@ All Requests related to account(s) are grouped here.
24
24
  * [accountV1ConnectionReconnect](#accountv1connectionreconnect)
25
25
  * [sendEmailVerification](#sendemailverification)
26
26
  * [accountV1ImagesUpdate](#accountv1imagesupdate)
27
+ * [accountV1SettingsUpdateRole](#accountv1settingsupdaterole)
27
28
  * [uploadImages](#uploadimages)
28
29
  * [verifyEmail](#verifyemail)
29
30
  * [getAccount](#getaccount)
@@ -364,9 +365,7 @@ const steamSets = new SteamSets({
364
365
  });
365
366
 
366
367
  async function run() {
367
- const result = await steamSets.account.getApps({
368
- page: 1,
369
- });
368
+ const result = await steamSets.account.getApps({});
370
369
 
371
370
  // Handle the result
372
371
  console.log(result);
@@ -390,9 +389,7 @@ const steamSets = new SteamSetsCore({
390
389
  });
391
390
 
392
391
  async function run() {
393
- const res = await accountGetApps(steamSets, {
394
- page: 1,
395
- });
392
+ const res = await accountGetApps(steamSets, {});
396
393
 
397
394
  if (!res.ok) {
398
395
  throw res.error;
@@ -511,9 +508,7 @@ const steamSets = new SteamSets({
511
508
  });
512
509
 
513
510
  async function run() {
514
- const result = await steamSets.account.getBadges({
515
- page: 1,
516
- });
511
+ const result = await steamSets.account.getBadges({});
517
512
 
518
513
  // Handle the result
519
514
  console.log(result);
@@ -537,9 +532,7 @@ const steamSets = new SteamSetsCore({
537
532
  });
538
533
 
539
534
  async function run() {
540
- const res = await accountGetBadges(steamSets, {
541
- page: 1,
542
- });
535
+ const res = await accountGetBadges(steamSets, {});
543
536
 
544
537
  if (!res.ok) {
545
538
  throw res.error;
@@ -1305,6 +1298,78 @@ run();
1305
1298
  | errors.ErrorModel | 500 | application/problem+json |
1306
1299
  | errors.SDKError | 4XX, 5XX | \*/\* |
1307
1300
 
1301
+ ## accountV1SettingsUpdateRole
1302
+
1303
+ ### Example Usage
1304
+
1305
+ ```typescript
1306
+ import { SteamSets } from "@steamsets/client-ts";
1307
+
1308
+ const steamSets = new SteamSets({
1309
+ token: "<YOUR_BEARER_TOKEN_HERE>",
1310
+ });
1311
+
1312
+ async function run() {
1313
+ const result = await steamSets.account.accountV1SettingsUpdateRole({});
1314
+
1315
+ // Handle the result
1316
+ console.log(result);
1317
+ }
1318
+
1319
+ run();
1320
+ ```
1321
+
1322
+ ### Standalone function
1323
+
1324
+ The standalone function version of this method:
1325
+
1326
+ ```typescript
1327
+ import { SteamSetsCore } from "@steamsets/client-ts/core.js";
1328
+ import { accountAccountV1SettingsUpdateRole } from "@steamsets/client-ts/funcs/accountAccountV1SettingsUpdateRole.js";
1329
+
1330
+ // Use `SteamSetsCore` for best tree-shaking performance.
1331
+ // You can create one instance of it to use across an application.
1332
+ const steamSets = new SteamSetsCore({
1333
+ token: "<YOUR_BEARER_TOKEN_HERE>",
1334
+ });
1335
+
1336
+ async function run() {
1337
+ const res = await accountAccountV1SettingsUpdateRole(steamSets, {});
1338
+
1339
+ if (!res.ok) {
1340
+ throw res.error;
1341
+ }
1342
+
1343
+ const { value: result } = res;
1344
+
1345
+ // Handle the result
1346
+ console.log(result);
1347
+ }
1348
+
1349
+ run();
1350
+ ```
1351
+
1352
+ ### Parameters
1353
+
1354
+ | Parameter | Type | Required | Description |
1355
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1356
+ | `request` | [components.V1UpdateRoleRequestBody](../../models/components/v1updaterolerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1357
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1358
+ | `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. |
1359
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1360
+
1361
+ ### Response
1362
+
1363
+ **Promise\<[operations.AccountV1SettingsUpdateRoleResponse](../../models/operations/accountv1settingsupdateroleresponse.md)\>**
1364
+
1365
+ ### Errors
1366
+
1367
+ | Error Type | Status Code | Content Type |
1368
+ | ------------------------ | ------------------------ | ------------------------ |
1369
+ | errors.ErrorModel | 422, 429 | application/problem+json |
1370
+ | errors.ErrorModel | 500 | application/problem+json |
1371
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1372
+
1308
1373
  ## uploadImages
1309
1374
 
1310
1375
  ### Example Usage
@@ -26,9 +26,7 @@ const steamSets = new SteamSets({
26
26
  });
27
27
 
28
28
  async function run() {
29
- const result = await steamSets.data.getApps({
30
- page: 1,
31
- });
29
+ const result = await steamSets.data.getApps({});
32
30
 
33
31
  // Handle the result
34
32
  console.log(result);
@@ -52,9 +50,7 @@ const steamSets = new SteamSetsCore({
52
50
  });
53
51
 
54
52
  async function run() {
55
- const res = await dataGetApps(steamSets, {
56
- page: 1,
57
- });
53
+ const res = await dataGetApps(steamSets, {});
58
54
 
59
55
  if (!res.ok) {
60
56
  throw res.error;
@@ -102,9 +98,7 @@ const steamSets = new SteamSets({
102
98
  });
103
99
 
104
100
  async function run() {
105
- const result = await steamSets.data.getBadges({
106
- page: 1,
107
- });
101
+ const result = await steamSets.data.getBadges({});
108
102
 
109
103
  // Handle the result
110
104
  console.log(result);
@@ -128,9 +122,7 @@ const steamSets = new SteamSetsCore({
128
122
  });
129
123
 
130
124
  async function run() {
131
- const res = await dataGetBadges(steamSets, {
132
- page: 1,
133
- });
125
+ const res = await dataGetBadges(steamSets, {});
134
126
 
135
127
  if (!res.ok) {
136
128
  throw res.error;
@@ -27,9 +27,7 @@ const steamSets = new SteamSets({
27
27
  });
28
28
 
29
29
  async function run() {
30
- const result = await steamSets.external.getApps({
31
- page: 1,
32
- });
30
+ const result = await steamSets.external.getApps({});
33
31
 
34
32
  // Handle the result
35
33
  console.log(result);
@@ -53,9 +51,7 @@ const steamSets = new SteamSetsCore({
53
51
  });
54
52
 
55
53
  async function run() {
56
- const res = await externalGetApps(steamSets, {
57
- page: 1,
58
- });
54
+ const res = await externalGetApps(steamSets, {});
59
55
 
60
56
  if (!res.ok) {
61
57
  throw res.error;
@@ -103,9 +99,7 @@ const steamSets = new SteamSets({
103
99
  });
104
100
 
105
101
  async function run() {
106
- const result = await steamSets.external.getBadges({
107
- page: 1,
108
- });
102
+ const result = await steamSets.external.getBadges({});
109
103
 
110
104
  // Handle the result
111
105
  console.log(result);
@@ -129,9 +123,7 @@ const steamSets = new SteamSetsCore({
129
123
  });
130
124
 
131
125
  async function run() {
132
- const res = await externalGetBadges(steamSets, {
133
- page: 1,
134
- });
126
+ const res = await externalGetBadges(steamSets, {});
135
127
 
136
128
  if (!res.ok) {
137
129
  throw res.error;
@@ -19,6 +19,7 @@ There requests are just document for documentations sake, they are not meant to
19
19
  * [accountV1ConnectionReconnect](#accountv1connectionreconnect)
20
20
  * [sendEmailVerification](#sendemailverification)
21
21
  * [accountV1ImagesUpdate](#accountv1imagesupdate)
22
+ * [accountV1SettingsUpdateRole](#accountv1settingsupdaterole)
22
23
  * [uploadImages](#uploadimages)
23
24
  * [verifyEmail](#verifyemail)
24
25
  * [getAccount](#getaccount)
@@ -943,6 +944,78 @@ run();
943
944
  | errors.ErrorModel | 500 | application/problem+json |
944
945
  | errors.SDKError | 4XX, 5XX | \*/\* |
945
946
 
947
+ ## accountV1SettingsUpdateRole
948
+
949
+ ### Example Usage
950
+
951
+ ```typescript
952
+ import { SteamSets } from "@steamsets/client-ts";
953
+
954
+ const steamSets = new SteamSets({
955
+ token: "<YOUR_BEARER_TOKEN_HERE>",
956
+ });
957
+
958
+ async function run() {
959
+ const result = await steamSets.internal.accountV1SettingsUpdateRole({});
960
+
961
+ // Handle the result
962
+ console.log(result);
963
+ }
964
+
965
+ run();
966
+ ```
967
+
968
+ ### Standalone function
969
+
970
+ The standalone function version of this method:
971
+
972
+ ```typescript
973
+ import { SteamSetsCore } from "@steamsets/client-ts/core.js";
974
+ import { internalAccountV1SettingsUpdateRole } from "@steamsets/client-ts/funcs/internalAccountV1SettingsUpdateRole.js";
975
+
976
+ // Use `SteamSetsCore` for best tree-shaking performance.
977
+ // You can create one instance of it to use across an application.
978
+ const steamSets = new SteamSetsCore({
979
+ token: "<YOUR_BEARER_TOKEN_HERE>",
980
+ });
981
+
982
+ async function run() {
983
+ const res = await internalAccountV1SettingsUpdateRole(steamSets, {});
984
+
985
+ if (!res.ok) {
986
+ throw res.error;
987
+ }
988
+
989
+ const { value: result } = res;
990
+
991
+ // Handle the result
992
+ console.log(result);
993
+ }
994
+
995
+ run();
996
+ ```
997
+
998
+ ### Parameters
999
+
1000
+ | Parameter | Type | Required | Description |
1001
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
1002
+ | `request` | [components.V1UpdateRoleRequestBody](../../models/components/v1updaterolerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
1003
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
1004
+ | `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
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
1006
+
1007
+ ### Response
1008
+
1009
+ **Promise\<[operations.AccountV1SettingsUpdateRoleResponse](../../models/operations/accountv1settingsupdateroleresponse.md)\>**
1010
+
1011
+ ### Errors
1012
+
1013
+ | Error Type | Status Code | Content Type |
1014
+ | ------------------------ | ------------------------ | ------------------------ |
1015
+ | errors.ErrorModel | 422, 429 | application/problem+json |
1016
+ | errors.ErrorModel | 500 | application/problem+json |
1017
+ | errors.SDKError | 4XX, 5XX | \*/\* |
1018
+
946
1019
  ## uploadImages
947
1020
 
948
1021
  ### Example Usage
@@ -7,6 +7,7 @@
7
7
 
8
8
  * [get](#get)
9
9
  * [sendEmailVerification](#sendemailverification)
10
+ * [accountV1SettingsUpdateRole](#accountv1settingsupdaterole)
10
11
  * [update](#update)
11
12
  * [verifyEmail](#verifyemail)
12
13
 
@@ -152,6 +153,78 @@ run();
152
153
  | errors.ErrorModel | 500 | application/problem+json |
153
154
  | errors.SDKError | 4XX, 5XX | \*/\* |
154
155
 
156
+ ## accountV1SettingsUpdateRole
157
+
158
+ ### Example Usage
159
+
160
+ ```typescript
161
+ import { SteamSets } from "@steamsets/client-ts";
162
+
163
+ const steamSets = new SteamSets({
164
+ token: "<YOUR_BEARER_TOKEN_HERE>",
165
+ });
166
+
167
+ async function run() {
168
+ const result = await steamSets.settings.accountV1SettingsUpdateRole({});
169
+
170
+ // Handle the result
171
+ console.log(result);
172
+ }
173
+
174
+ run();
175
+ ```
176
+
177
+ ### Standalone function
178
+
179
+ The standalone function version of this method:
180
+
181
+ ```typescript
182
+ import { SteamSetsCore } from "@steamsets/client-ts/core.js";
183
+ import { settingsAccountV1SettingsUpdateRole } from "@steamsets/client-ts/funcs/settingsAccountV1SettingsUpdateRole.js";
184
+
185
+ // Use `SteamSetsCore` for best tree-shaking performance.
186
+ // You can create one instance of it to use across an application.
187
+ const steamSets = new SteamSetsCore({
188
+ token: "<YOUR_BEARER_TOKEN_HERE>",
189
+ });
190
+
191
+ async function run() {
192
+ const res = await settingsAccountV1SettingsUpdateRole(steamSets, {});
193
+
194
+ if (!res.ok) {
195
+ throw res.error;
196
+ }
197
+
198
+ const { value: result } = res;
199
+
200
+ // Handle the result
201
+ console.log(result);
202
+ }
203
+
204
+ run();
205
+ ```
206
+
207
+ ### Parameters
208
+
209
+ | Parameter | Type | Required | Description |
210
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
211
+ | `request` | [components.V1UpdateRoleRequestBody](../../models/components/v1updaterolerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
212
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
213
+ | `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. |
214
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
215
+
216
+ ### Response
217
+
218
+ **Promise\<[operations.AccountV1SettingsUpdateRoleResponse](../../models/operations/accountv1settingsupdateroleresponse.md)\>**
219
+
220
+ ### Errors
221
+
222
+ | Error Type | Status Code | Content Type |
223
+ | ------------------------ | ------------------------ | ------------------------ |
224
+ | errors.ErrorModel | 422, 429 | application/problem+json |
225
+ | errors.ErrorModel | 500 | application/problem+json |
226
+ | errors.SDKError | 4XX, 5XX | \*/\* |
227
+
155
228
  ## update
156
229
 
157
230
  ### Example Usage
@@ -0,0 +1,11 @@
1
+ import { SteamSetsCore } from "../core.js";
2
+ import { RequestOptions } from "../lib/sdks.js";
3
+ import * as components from "../models/components/index.js";
4
+ import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
5
+ import * as errors from "../models/errors/index.js";
6
+ import { SDKError } from "../models/errors/sdkerror.js";
7
+ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
8
+ import * as operations from "../models/operations/index.js";
9
+ import { Result } from "../types/fp.js";
10
+ export declare function accountAccountV1SettingsUpdateRole(client: SteamSetsCore, request: components.V1UpdateRoleRequestBody, options?: RequestOptions): Promise<Result<operations.AccountV1SettingsUpdateRoleResponse, errors.ErrorModel | errors.ErrorModel | SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
11
+ //# sourceMappingURL=accountAccountV1SettingsUpdateRole.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"accountAccountV1SettingsUpdateRole.d.ts","sourceRoot":"","sources":["../src/funcs/accountAccountV1SettingsUpdateRole.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAK3C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,wBAAsB,kCAAkC,CACtD,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,mCAAmC,EAC5C,MAAM,CAAC,UAAU,GACjB,MAAM,CAAC,UAAU,GACjB,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAyGA"}
@@ -0,0 +1,113 @@
1
+ "use strict";
2
+ /*
3
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
4
+ */
5
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
6
+ if (k2 === undefined) k2 = k;
7
+ var desc = Object.getOwnPropertyDescriptor(m, k);
8
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
9
+ desc = { enumerable: true, get: function() { return m[k]; } };
10
+ }
11
+ Object.defineProperty(o, k2, desc);
12
+ }) : (function(o, m, k, k2) {
13
+ if (k2 === undefined) k2 = k;
14
+ o[k2] = m[k];
15
+ }));
16
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
17
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
18
+ }) : function(o, v) {
19
+ o["default"] = v;
20
+ });
21
+ var __importStar = (this && this.__importStar) || function (mod) {
22
+ if (mod && mod.__esModule) return mod;
23
+ var result = {};
24
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
25
+ __setModuleDefault(result, mod);
26
+ return result;
27
+ };
28
+ Object.defineProperty(exports, "__esModule", { value: true });
29
+ exports.accountAccountV1SettingsUpdateRole = accountAccountV1SettingsUpdateRole;
30
+ const encodings_js_1 = require("../lib/encodings.js");
31
+ const M = __importStar(require("../lib/matchers.js"));
32
+ const primitives_js_1 = require("../lib/primitives.js");
33
+ const schemas_js_1 = require("../lib/schemas.js");
34
+ const security_js_1 = require("../lib/security.js");
35
+ const url_js_1 = require("../lib/url.js");
36
+ const components = __importStar(require("../models/components/index.js"));
37
+ const errors = __importStar(require("../models/errors/index.js"));
38
+ const operations = __importStar(require("../models/operations/index.js"));
39
+ async function accountAccountV1SettingsUpdateRole(client, request, options) {
40
+ const parsed = (0, schemas_js_1.safeParse)(request, (value) => components.V1UpdateRoleRequestBody$outboundSchema.parse(value), "Input validation failed");
41
+ if (!parsed.ok) {
42
+ return parsed;
43
+ }
44
+ const payload = parsed.value;
45
+ const body = (0, encodings_js_1.encodeJSON)("body", payload, { explode: true });
46
+ const path = (0, url_js_1.pathToFunc)("/account.v1.AccountService/UpdateRole")();
47
+ const headers = new Headers((0, primitives_js_1.compactMap)({
48
+ "Content-Type": "application/json",
49
+ Accept: "application/problem+json",
50
+ }));
51
+ const secConfig = await (0, security_js_1.extractSecurity)(client._options.token);
52
+ const securityInput = secConfig == null ? {} : { token: secConfig };
53
+ const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput);
54
+ const context = {
55
+ operationID: "account.v1.settings.update-role",
56
+ oAuth2Scopes: [],
57
+ resolvedSecurity: requestSecurity,
58
+ securitySource: client._options.token,
59
+ retryConfig: options?.retries
60
+ || client._options.retryConfig
61
+ || {
62
+ strategy: "backoff",
63
+ backoff: {
64
+ initialInterval: 500,
65
+ maxInterval: 5000,
66
+ exponent: 1.5,
67
+ maxElapsedTime: 60000,
68
+ },
69
+ retryConnectionErrors: true,
70
+ }
71
+ || { strategy: "none" },
72
+ retryCodes: options?.retryCodes || ["501", "502", "503", "504"],
73
+ };
74
+ const requestRes = client._createRequest(context, {
75
+ security: requestSecurity,
76
+ method: "POST",
77
+ baseURL: options?.serverURL,
78
+ path: path,
79
+ headers: headers,
80
+ body: body,
81
+ uaHeader: "x-speakeasy-user-agent",
82
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
83
+ }, options);
84
+ if (!requestRes.ok) {
85
+ return requestRes;
86
+ }
87
+ const req = requestRes.value;
88
+ const doResult = await client._do(req, {
89
+ context,
90
+ errorCodes: ["422", "429", "4XX", "500", "5XX"],
91
+ retryConfig: context.retryConfig,
92
+ retryCodes: context.retryCodes,
93
+ });
94
+ if (!doResult.ok) {
95
+ return doResult;
96
+ }
97
+ const response = doResult.value;
98
+ const responseFields = {
99
+ HttpMeta: { Response: response, Request: req },
100
+ };
101
+ const [result] = await M.match(M.nil(204, operations.AccountV1SettingsUpdateRoleResponse$inboundSchema, {
102
+ hdrs: true,
103
+ }), M.jsonErr([422, 429], errors.ErrorModel$inboundSchema, {
104
+ ctype: "application/problem+json",
105
+ }), M.jsonErr(500, errors.ErrorModel$inboundSchema, {
106
+ ctype: "application/problem+json",
107
+ }), M.fail("4XX"), M.fail("5XX"))(response, req, { extraFields: responseFields });
108
+ if (!result.ok) {
109
+ return result;
110
+ }
111
+ return result;
112
+ }
113
+ //# sourceMappingURL=accountAccountV1SettingsUpdateRole.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"accountAccountV1SettingsUpdateRole.js","sourceRoot":"","sources":["../src/funcs/accountAccountV1SettingsUpdateRole.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;AAwBH,gFA0HC;AA/ID,sDAAiD;AACjD,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAC3C,0EAA4D;AAQ5D,kEAAoD;AAGpD,0EAA4D;AAGrD,KAAK,UAAU,kCAAkC,CACtD,MAAqB,EACrB,OAA2C,EAC3C,OAAwB;IAexB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,sCAAsC,CAAC,KAAK,CAAC,KAAK,CAAC,EACzE,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAA,yBAAU,EAAC,MAAM,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAE5D,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,uCAAuC,CAAC,EAAE,CAAC;IAEnE,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,0BAA0B;KACnC,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC/D,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;IACpE,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,WAAW,EAAE,iCAAiC;QAC9C,YAAY,EAAE,EAAE;QAEhB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK;QACrC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B;gBACD,QAAQ,EAAE,SAAS;gBACnB,OAAO,EAAE;oBACP,eAAe,EAAE,GAAG;oBACpB,WAAW,EAAE,IAAI;oBACjB,QAAQ,EAAE,GAAG;oBACb,cAAc,EAAE,KAAK;iBACtB;gBACD,qBAAqB,EAAE,IAAI;aAC5B;eACE,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KAChE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,IAAI;QACV,QAAQ,EAAE,wBAAwB;QAClC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QAC/C,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAY5B,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,CAAC,iDAAiD,EAAE;QACvE,IAAI,EAAE,IAAI;KACX,CAAC,EACF,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,wBAAwB,EAAE;QACrD,KAAK,EAAE,0BAA0B;KAClC,CAAC,EACF,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,wBAAwB,EAAE;QAC9C,KAAK,EAAE,0BAA0B;KAClC,CAAC,EACF,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}
@@ -0,0 +1,11 @@
1
+ import { SteamSetsCore } from "../core.js";
2
+ import { RequestOptions } from "../lib/sdks.js";
3
+ import * as components from "../models/components/index.js";
4
+ import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
5
+ import * as errors from "../models/errors/index.js";
6
+ import { SDKError } from "../models/errors/sdkerror.js";
7
+ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
8
+ import * as operations from "../models/operations/index.js";
9
+ import { Result } from "../types/fp.js";
10
+ export declare function internalAccountV1SettingsUpdateRole(client: SteamSetsCore, request: components.V1UpdateRoleRequestBody, options?: RequestOptions): Promise<Result<operations.AccountV1SettingsUpdateRoleResponse, errors.ErrorModel | errors.ErrorModel | SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
11
+ //# sourceMappingURL=internalAccountV1SettingsUpdateRole.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"internalAccountV1SettingsUpdateRole.d.ts","sourceRoot":"","sources":["../src/funcs/internalAccountV1SettingsUpdateRole.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAK3C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC,wBAAsB,mCAAmC,CACvD,MAAM,EAAE,aAAa,EACrB,OAAO,EAAE,UAAU,CAAC,uBAAuB,EAC3C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CACR,MAAM,CACJ,UAAU,CAAC,mCAAmC,EAC5C,MAAM,CAAC,UAAU,GACjB,MAAM,CAAC,UAAU,GACjB,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAyGA"}