@steamsets/client-ts 0.5.3 → 0.5.5

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 (89) hide show
  1. package/README.md +9 -3
  2. package/docs/sdks/account/README.md +83 -10
  3. package/docs/sdks/data/README.md +79 -0
  4. package/docs/sdks/public/README.md +79 -0
  5. package/docs/sdks/settings/README.md +4 -10
  6. package/funcs/accountAccountV1GetDataPoints.d.ts +13 -0
  7. package/funcs/accountAccountV1GetDataPoints.d.ts.map +1 -0
  8. package/funcs/accountAccountV1GetDataPoints.js +105 -0
  9. package/funcs/accountAccountV1GetDataPoints.js.map +1 -0
  10. package/funcs/dataAccountV1GetDataPoints.d.ts +13 -0
  11. package/funcs/dataAccountV1GetDataPoints.d.ts.map +1 -0
  12. package/funcs/dataAccountV1GetDataPoints.js +105 -0
  13. package/funcs/dataAccountV1GetDataPoints.js.map +1 -0
  14. package/funcs/publicAccountV1GetDataPoints.d.ts +13 -0
  15. package/funcs/publicAccountV1GetDataPoints.d.ts.map +1 -0
  16. package/funcs/publicAccountV1GetDataPoints.js +105 -0
  17. package/funcs/publicAccountV1GetDataPoints.js.map +1 -0
  18. package/lib/config.d.ts +3 -3
  19. package/lib/config.js +3 -3
  20. package/lib/config.js.map +1 -1
  21. package/models/components/accountbadgemostxpdatapoint.d.ts +83 -0
  22. package/models/components/accountbadgemostxpdatapoint.d.ts.map +1 -0
  23. package/models/components/accountbadgemostxpdatapoint.js +75 -0
  24. package/models/components/accountbadgemostxpdatapoint.js.map +1 -0
  25. package/models/components/accountbadgescarcitydatapoint.d.ts +68 -0
  26. package/models/components/accountbadgescarcitydatapoint.d.ts.map +1 -0
  27. package/models/components/accountbadgescarcitydatapoint.js +66 -0
  28. package/models/components/accountbadgescarcitydatapoint.js.map +1 -0
  29. package/models/components/accountplaytimedatapoint.d.ts +43 -0
  30. package/models/components/accountplaytimedatapoint.d.ts.map +1 -0
  31. package/models/components/{item.js → accountplaytimedatapoint.js} +19 -15
  32. package/models/components/accountplaytimedatapoint.js.map +1 -0
  33. package/models/components/image.d.ts +0 -10
  34. package/models/components/image.d.ts.map +1 -1
  35. package/models/components/image.js +0 -4
  36. package/models/components/image.js.map +1 -1
  37. package/models/components/index.d.ts +4 -1
  38. package/models/components/index.d.ts.map +1 -1
  39. package/models/components/index.js +4 -1
  40. package/models/components/index.js.map +1 -1
  41. package/models/components/v1accountdatapointsresponsebody.d.ts +47 -0
  42. package/models/components/v1accountdatapointsresponsebody.d.ts.map +1 -0
  43. package/models/components/v1accountdatapointsresponsebody.js +74 -0
  44. package/models/components/v1accountdatapointsresponsebody.js.map +1 -0
  45. package/models/components/v1deleteimagesrequestbody.d.ts +3 -4
  46. package/models/components/v1deleteimagesrequestbody.d.ts.map +1 -1
  47. package/models/components/v1deleteimagesrequestbody.js +2 -3
  48. package/models/components/v1deleteimagesrequestbody.js.map +1 -1
  49. package/models/operations/accountv1getdatapoints.d.ts +58 -0
  50. package/models/operations/accountv1getdatapoints.d.ts.map +1 -0
  51. package/models/operations/accountv1getdatapoints.js +107 -0
  52. package/models/operations/accountv1getdatapoints.js.map +1 -0
  53. package/models/operations/index.d.ts +1 -0
  54. package/models/operations/index.d.ts.map +1 -1
  55. package/models/operations/index.js +1 -0
  56. package/models/operations/index.js.map +1 -1
  57. package/package.json +1 -1
  58. package/sdk/account.d.ts +4 -0
  59. package/sdk/account.d.ts.map +1 -1
  60. package/sdk/account.js +7 -0
  61. package/sdk/account.js.map +1 -1
  62. package/sdk/data.d.ts +4 -0
  63. package/sdk/data.d.ts.map +1 -1
  64. package/sdk/data.js +7 -0
  65. package/sdk/data.js.map +1 -1
  66. package/sdk/public.d.ts +4 -0
  67. package/sdk/public.d.ts.map +1 -1
  68. package/sdk/public.js +7 -0
  69. package/sdk/public.js.map +1 -1
  70. package/src/funcs/accountAccountV1GetDataPoints.ts +139 -0
  71. package/src/funcs/dataAccountV1GetDataPoints.ts +139 -0
  72. package/src/funcs/publicAccountV1GetDataPoints.ts +139 -0
  73. package/src/lib/config.ts +3 -3
  74. package/src/models/components/accountbadgemostxpdatapoint.ts +128 -0
  75. package/src/models/components/accountbadgescarcitydatapoint.ts +104 -0
  76. package/src/models/components/accountplaytimedatapoint.ts +69 -0
  77. package/src/models/components/image.ts +0 -14
  78. package/src/models/components/index.ts +4 -1
  79. package/src/models/components/v1accountdatapointsresponsebody.ts +95 -0
  80. package/src/models/components/v1deleteimagesrequestbody.ts +5 -6
  81. package/src/models/operations/accountv1getdatapoints.ts +136 -0
  82. package/src/models/operations/index.ts +1 -0
  83. package/src/sdk/account.ts +11 -0
  84. package/src/sdk/data.ts +11 -0
  85. package/src/sdk/public.ts +11 -0
  86. package/models/components/item.d.ts +0 -33
  87. package/models/components/item.d.ts.map +0 -1
  88. package/models/components/item.js.map +0 -1
  89. package/src/models/components/item.ts +0 -47
package/README.md CHANGED
@@ -89,6 +89,7 @@ run();
89
89
  * [accountV1SettingsGenerateApiKey](docs/sdks/account/README.md#accountv1settingsgenerateapikey) - Generate a new API key for the account
90
90
  * [accountV1GetApps](docs/sdks/account/README.md#accountv1getapps) - Get Account Apps
91
91
  * [accountV1GetBadges](docs/sdks/account/README.md#accountv1getbadges) - Get Account Badges
92
+ * [accountV1GetDataPoints](docs/sdks/account/README.md#accountv1getdatapoints) - Get Account DataPoints
92
93
  * [accountV1GetFriends](docs/sdks/account/README.md#accountv1getfriends) - Get Account Friends
93
94
  * [accountV1GetInfo](docs/sdks/account/README.md#accountv1getinfo) - Get Account Info
94
95
  * [accountV1GetLeaderboardHistory](docs/sdks/account/README.md#accountv1getleaderboardhistory) - Get Account Leaderboard History
@@ -133,6 +134,7 @@ run();
133
134
 
134
135
  * [accountV1GetApps](docs/sdks/data/README.md#accountv1getapps) - Get Account Apps
135
136
  * [accountV1GetBadges](docs/sdks/data/README.md#accountv1getbadges) - Get Account Badges
137
+ * [accountV1GetDataPoints](docs/sdks/data/README.md#accountv1getdatapoints) - Get Account DataPoints
136
138
  * [accountV1GetFriends](docs/sdks/data/README.md#accountv1getfriends) - Get Account Friends
137
139
  * [accountV1GetInfo](docs/sdks/data/README.md#accountv1getinfo) - Get Account Info
138
140
  * [accountV1GetLeaderboardHistory](docs/sdks/data/README.md#accountv1getleaderboardhistory) - Get Account Leaderboard History
@@ -142,6 +144,7 @@ run();
142
144
 
143
145
  * [accountV1GetApps](docs/sdks/public/README.md#accountv1getapps) - Get Account Apps
144
146
  * [accountV1GetBadges](docs/sdks/public/README.md#accountv1getbadges) - Get Account Badges
147
+ * [accountV1GetDataPoints](docs/sdks/public/README.md#accountv1getdatapoints) - Get Account DataPoints
145
148
  * [accountV1GetFriends](docs/sdks/public/README.md#accountv1getfriends) - Get Account Friends
146
149
  * [accountV1GetInfo](docs/sdks/public/README.md#accountv1getinfo) - Get Account Info
147
150
  * [accountV1GetLeaderboardHistory](docs/sdks/public/README.md#accountv1getleaderboardhistory) - Get Account Leaderboard History
@@ -295,8 +298,8 @@ You can override the default server globally by passing a server index to the `s
295
298
 
296
299
  | # | Server | Variables |
297
300
  | - | ------ | --------- |
298
- | 0 | `http://localhost:8080` | None |
299
- | 1 | `https://api.steamsets.com` | None |
301
+ | 0 | `https://api.steamsets.com` | None |
302
+ | 1 | `http://localhost:8080` | None |
300
303
 
301
304
  ```typescript
302
305
  import { SteamSets } from "@steamsets/client-ts";
@@ -329,7 +332,7 @@ The default server can also be overridden globally by passing a URL to the `serv
329
332
  import { SteamSets } from "@steamsets/client-ts";
330
333
 
331
334
  const steamSets = new SteamSets({
332
- serverURL: "http://localhost:8080",
335
+ serverURL: "https://api.steamsets.com",
333
336
  session: "<YOUR_BEARER_TOKEN_HERE>",
334
337
  });
335
338
 
@@ -464,6 +467,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
464
467
  - [accountAccountV1ConnectionVerifyConnection](docs/sdks/account/README.md#accountv1connectionverifyconnection)
465
468
  - [accountAccountV1GetApps](docs/sdks/account/README.md#accountv1getapps)
466
469
  - [accountAccountV1GetBadges](docs/sdks/account/README.md#accountv1getbadges)
470
+ - [accountAccountV1GetDataPoints](docs/sdks/account/README.md#accountv1getdatapoints)
467
471
  - [accountAccountV1GetFriends](docs/sdks/account/README.md#accountv1getfriends)
468
472
  - [accountAccountV1GetInfo](docs/sdks/account/README.md#accountv1getinfo)
469
473
  - [accountAccountV1GetLeaderboardHistory](docs/sdks/account/README.md#accountv1getleaderboardhistory)
@@ -486,6 +490,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
486
490
  - [connectionAccountV1ConnectionVerifyConnection](docs/sdks/connection/README.md#accountv1connectionverifyconnection)
487
491
  - [dataAccountV1GetApps](docs/sdks/data/README.md#accountv1getapps)
488
492
  - [dataAccountV1GetBadges](docs/sdks/data/README.md#accountv1getbadges)
493
+ - [dataAccountV1GetDataPoints](docs/sdks/data/README.md#accountv1getdatapoints)
489
494
  - [dataAccountV1GetFriends](docs/sdks/data/README.md#accountv1getfriends)
490
495
  - [dataAccountV1GetInfo](docs/sdks/data/README.md#accountv1getinfo)
491
496
  - [dataAccountV1GetLeaderboardHistory](docs/sdks/data/README.md#accountv1getleaderboardhistory)
@@ -494,6 +499,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
494
499
  - [locationLocation](docs/sdks/location/README.md#location)
495
500
  - [publicAccountV1GetApps](docs/sdks/public/README.md#accountv1getapps)
496
501
  - [publicAccountV1GetBadges](docs/sdks/public/README.md#accountv1getbadges)
502
+ - [publicAccountV1GetDataPoints](docs/sdks/public/README.md#accountv1getdatapoints)
497
503
  - [publicAccountV1GetFriends](docs/sdks/public/README.md#accountv1getfriends)
498
504
  - [publicAccountV1GetInfo](docs/sdks/public/README.md#accountv1getinfo)
499
505
  - [publicAccountV1GetLeaderboardHistory](docs/sdks/public/README.md#accountv1getleaderboardhistory)
@@ -15,6 +15,7 @@ Account related operations
15
15
  * [accountV1SettingsGenerateApiKey](#accountv1settingsgenerateapikey) - Generate a new API key for the account
16
16
  * [accountV1GetApps](#accountv1getapps) - Get Account Apps
17
17
  * [accountV1GetBadges](#accountv1getbadges) - Get Account Badges
18
+ * [accountV1GetDataPoints](#accountv1getdatapoints) - Get Account DataPoints
18
19
  * [accountV1GetFriends](#accountv1getfriends) - Get Account Friends
19
20
  * [accountV1GetInfo](#accountv1getinfo) - Get Account Info
20
21
  * [accountV1GetLeaderboardHistory](#accountv1getleaderboardhistory) - Get Account Leaderboard History
@@ -277,11 +278,8 @@ const steamSets = new SteamSets({
277
278
 
278
279
  async function run() {
279
280
  const result = await steamSets.account.accountV1SettingsDeleteImages({
280
- images: [
281
- {
282
- fileId: "123456",
283
- imageId: "123456",
284
- },
281
+ imageIds: [
282
+ "<value>",
285
283
  ],
286
284
  });
287
285
 
@@ -308,11 +306,8 @@ const steamSets = new SteamSetsCore({
308
306
 
309
307
  async function run() {
310
308
  const res = await accountAccountV1SettingsDeleteImages(steamSets, {
311
- images: [
312
- {
313
- fileId: "123456",
314
- imageId: "123456",
315
- },
309
+ imageIds: [
310
+ "<value>",
316
311
  ],
317
312
  });
318
313
 
@@ -657,6 +652,84 @@ run();
657
652
  | errors.SDKError | 4xx-5xx | */* |
658
653
 
659
654
 
655
+ ## accountV1GetDataPoints
656
+
657
+ Get Account DataPoints
658
+
659
+ ### Example Usage
660
+
661
+ ```typescript
662
+ import { SteamSets } from "@steamsets/client-ts";
663
+
664
+ const steamSets = new SteamSets({
665
+ session: "<YOUR_BEARER_TOKEN_HERE>",
666
+ });
667
+
668
+ async function run() {
669
+ const result = await steamSets.account.accountV1GetDataPoints({
670
+ accountSearch: {},
671
+ });
672
+
673
+ // Handle the result
674
+ console.log(result)
675
+ }
676
+
677
+ run();
678
+ ```
679
+
680
+ ### Standalone function
681
+
682
+ The standalone function version of this method:
683
+
684
+ ```typescript
685
+ import { SteamSetsCore } from "@steamsets/client-ts/core.js";
686
+ import { accountAccountV1GetDataPoints } from "@steamsets/client-ts/funcs/accountAccountV1GetDataPoints.js";
687
+
688
+ // Use `SteamSetsCore` for best tree-shaking performance.
689
+ // You can create one instance of it to use across an application.
690
+ const steamSets = new SteamSetsCore({
691
+ session: "<YOUR_BEARER_TOKEN_HERE>",
692
+ });
693
+
694
+ async function run() {
695
+ const res = await accountAccountV1GetDataPoints(steamSets, {
696
+ accountSearch: {},
697
+ });
698
+
699
+ if (!res.ok) {
700
+ throw res.error;
701
+ }
702
+
703
+ const { value: result } = res;
704
+
705
+ // Handle the result
706
+ console.log(result)
707
+ }
708
+
709
+ run();
710
+ ```
711
+
712
+ ### Parameters
713
+
714
+ | Parameter | Type | Required | Description |
715
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
716
+ | `request` | [operations.AccountV1GetDataPointsRequest](../../models/operations/accountv1getdatapointsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
717
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
718
+ | `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. |
719
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
720
+
721
+ ### Response
722
+
723
+ **Promise\<[operations.AccountV1GetDataPointsResponse](../../models/operations/accountv1getdatapointsresponse.md)\>**
724
+
725
+ ### Errors
726
+
727
+ | Error Object | Status Code | Content Type |
728
+ | ------------------------ | ------------------------ | ------------------------ |
729
+ | errors.ErrorModel | 400,404,422,500 | application/problem+json |
730
+ | errors.SDKError | 4xx-5xx | */* |
731
+
732
+
660
733
  ## accountV1GetFriends
661
734
 
662
735
  Get Account Friends
@@ -9,6 +9,7 @@ This is actual data seen by others then yourself
9
9
 
10
10
  * [accountV1GetApps](#accountv1getapps) - Get Account Apps
11
11
  * [accountV1GetBadges](#accountv1getbadges) - Get Account Badges
12
+ * [accountV1GetDataPoints](#accountv1getdatapoints) - Get Account DataPoints
12
13
  * [accountV1GetFriends](#accountv1getfriends) - Get Account Friends
13
14
  * [accountV1GetInfo](#accountv1getinfo) - Get Account Info
14
15
  * [accountV1GetLeaderboardHistory](#accountv1getleaderboardhistory) - Get Account Leaderboard History
@@ -170,6 +171,84 @@ run();
170
171
  | errors.SDKError | 4xx-5xx | */* |
171
172
 
172
173
 
174
+ ## accountV1GetDataPoints
175
+
176
+ Get Account DataPoints
177
+
178
+ ### Example Usage
179
+
180
+ ```typescript
181
+ import { SteamSets } from "@steamsets/client-ts";
182
+
183
+ const steamSets = new SteamSets({
184
+ session: "<YOUR_BEARER_TOKEN_HERE>",
185
+ });
186
+
187
+ async function run() {
188
+ const result = await steamSets.data.accountV1GetDataPoints({
189
+ accountSearch: {},
190
+ });
191
+
192
+ // Handle the result
193
+ console.log(result)
194
+ }
195
+
196
+ run();
197
+ ```
198
+
199
+ ### Standalone function
200
+
201
+ The standalone function version of this method:
202
+
203
+ ```typescript
204
+ import { SteamSetsCore } from "@steamsets/client-ts/core.js";
205
+ import { dataAccountV1GetDataPoints } from "@steamsets/client-ts/funcs/dataAccountV1GetDataPoints.js";
206
+
207
+ // Use `SteamSetsCore` for best tree-shaking performance.
208
+ // You can create one instance of it to use across an application.
209
+ const steamSets = new SteamSetsCore({
210
+ session: "<YOUR_BEARER_TOKEN_HERE>",
211
+ });
212
+
213
+ async function run() {
214
+ const res = await dataAccountV1GetDataPoints(steamSets, {
215
+ accountSearch: {},
216
+ });
217
+
218
+ if (!res.ok) {
219
+ throw res.error;
220
+ }
221
+
222
+ const { value: result } = res;
223
+
224
+ // Handle the result
225
+ console.log(result)
226
+ }
227
+
228
+ run();
229
+ ```
230
+
231
+ ### Parameters
232
+
233
+ | Parameter | Type | Required | Description |
234
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
235
+ | `request` | [operations.AccountV1GetDataPointsRequest](../../models/operations/accountv1getdatapointsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
236
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
237
+ | `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. |
238
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
239
+
240
+ ### Response
241
+
242
+ **Promise\<[operations.AccountV1GetDataPointsResponse](../../models/operations/accountv1getdatapointsresponse.md)\>**
243
+
244
+ ### Errors
245
+
246
+ | Error Object | Status Code | Content Type |
247
+ | ------------------------ | ------------------------ | ------------------------ |
248
+ | errors.ErrorModel | 400,404,422,500 | application/problem+json |
249
+ | errors.SDKError | 4xx-5xx | */* |
250
+
251
+
173
252
  ## accountV1GetFriends
174
253
 
175
254
  Get Account Friends
@@ -9,6 +9,7 @@ This API can be accessed by anyone with an API Key
9
9
 
10
10
  * [accountV1GetApps](#accountv1getapps) - Get Account Apps
11
11
  * [accountV1GetBadges](#accountv1getbadges) - Get Account Badges
12
+ * [accountV1GetDataPoints](#accountv1getdatapoints) - Get Account DataPoints
12
13
  * [accountV1GetFriends](#accountv1getfriends) - Get Account Friends
13
14
  * [accountV1GetInfo](#accountv1getinfo) - Get Account Info
14
15
  * [accountV1GetLeaderboardHistory](#accountv1getleaderboardhistory) - Get Account Leaderboard History
@@ -169,6 +170,84 @@ run();
169
170
  | errors.SDKError | 4xx-5xx | */* |
170
171
 
171
172
 
173
+ ## accountV1GetDataPoints
174
+
175
+ Get Account DataPoints
176
+
177
+ ### Example Usage
178
+
179
+ ```typescript
180
+ import { SteamSets } from "@steamsets/client-ts";
181
+
182
+ const steamSets = new SteamSets({
183
+ session: "<YOUR_BEARER_TOKEN_HERE>",
184
+ });
185
+
186
+ async function run() {
187
+ const result = await steamSets.public.accountV1GetDataPoints({
188
+ accountSearch: {},
189
+ });
190
+
191
+ // Handle the result
192
+ console.log(result)
193
+ }
194
+
195
+ run();
196
+ ```
197
+
198
+ ### Standalone function
199
+
200
+ The standalone function version of this method:
201
+
202
+ ```typescript
203
+ import { SteamSetsCore } from "@steamsets/client-ts/core.js";
204
+ import { publicAccountV1GetDataPoints } from "@steamsets/client-ts/funcs/publicAccountV1GetDataPoints.js";
205
+
206
+ // Use `SteamSetsCore` for best tree-shaking performance.
207
+ // You can create one instance of it to use across an application.
208
+ const steamSets = new SteamSetsCore({
209
+ session: "<YOUR_BEARER_TOKEN_HERE>",
210
+ });
211
+
212
+ async function run() {
213
+ const res = await publicAccountV1GetDataPoints(steamSets, {
214
+ accountSearch: {},
215
+ });
216
+
217
+ if (!res.ok) {
218
+ throw res.error;
219
+ }
220
+
221
+ const { value: result } = res;
222
+
223
+ // Handle the result
224
+ console.log(result)
225
+ }
226
+
227
+ run();
228
+ ```
229
+
230
+ ### Parameters
231
+
232
+ | Parameter | Type | Required | Description |
233
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
234
+ | `request` | [operations.AccountV1GetDataPointsRequest](../../models/operations/accountv1getdatapointsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
235
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
236
+ | `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. |
237
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
238
+
239
+ ### Response
240
+
241
+ **Promise\<[operations.AccountV1GetDataPointsResponse](../../models/operations/accountv1getdatapointsresponse.md)\>**
242
+
243
+ ### Errors
244
+
245
+ | Error Object | Status Code | Content Type |
246
+ | ------------------------ | ------------------------ | ------------------------ |
247
+ | errors.ErrorModel | 400,404,422,500 | application/problem+json |
248
+ | errors.SDKError | 4xx-5xx | */* |
249
+
250
+
172
251
  ## accountV1GetFriends
173
252
 
174
253
  Get Account Friends
@@ -29,11 +29,8 @@ const steamSets = new SteamSets({
29
29
 
30
30
  async function run() {
31
31
  const result = await steamSets.settings.accountV1SettingsDeleteImages({
32
- images: [
33
- {
34
- fileId: "123456",
35
- imageId: "123456",
36
- },
32
+ imageIds: [
33
+ "<value>",
37
34
  ],
38
35
  });
39
36
 
@@ -60,11 +57,8 @@ const steamSets = new SteamSetsCore({
60
57
 
61
58
  async function run() {
62
59
  const res = await settingsAccountV1SettingsDeleteImages(steamSets, {
63
- images: [
64
- {
65
- fileId: "123456",
66
- imageId: "123456",
67
- },
60
+ imageIds: [
61
+ "<value>",
68
62
  ],
69
63
  });
70
64
 
@@ -0,0 +1,13 @@
1
+ import { SteamSetsCore } from "../core.js";
2
+ import { RequestOptions } from "../lib/sdks.js";
3
+ import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
4
+ import * as errors from "../models/errors/index.js";
5
+ import { SDKError } from "../models/errors/sdkerror.js";
6
+ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
+ import * as operations from "../models/operations/index.js";
8
+ import { Result } from "../types/fp.js";
9
+ /**
10
+ * Get Account DataPoints
11
+ */
12
+ export declare function accountAccountV1GetDataPoints(client$: SteamSetsCore, request: operations.AccountV1GetDataPointsRequest, options?: RequestOptions): Promise<Result<operations.AccountV1GetDataPointsResponse, errors.ErrorModel | SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
13
+ //# sourceMappingURL=accountAccountV1GetDataPoints.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"accountAccountV1GetDataPoints.d.ts","sourceRoot":"","sources":["../src/funcs/accountAccountV1GetDataPoints.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAI3C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACH,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACxB,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;;GAEG;AACH,wBAAsB,6BAA6B,CAC/C,OAAO,EAAE,aAAa,EACtB,OAAO,EAAE,UAAU,CAAC,6BAA6B,EACjD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CACN,MAAM,CACF,UAAU,CAAC,8BAA8B,EACvC,MAAM,CAAC,UAAU,GACjB,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CACpB,CACJ,CA+FA"}
@@ -0,0 +1,105 @@
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.accountAccountV1GetDataPoints = accountAccountV1GetDataPoints;
30
+ const encodings_js_1 = require("../lib/encodings.js");
31
+ const m$ = __importStar(require("../lib/matchers.js"));
32
+ const schemas$ = __importStar(require("../lib/schemas.js"));
33
+ const security_js_1 = require("../lib/security.js");
34
+ const url_js_1 = require("../lib/url.js");
35
+ const errors = __importStar(require("../models/errors/index.js"));
36
+ const operations = __importStar(require("../models/operations/index.js"));
37
+ /**
38
+ * Get Account DataPoints
39
+ */
40
+ async function accountAccountV1GetDataPoints(client$, request, options) {
41
+ const input$ = request;
42
+ const parsed$ = schemas$.safeParse(input$, (value$) => operations.AccountV1GetDataPointsRequest$outboundSchema.parse(value$), "Input validation failed");
43
+ if (!parsed$.ok) {
44
+ return parsed$;
45
+ }
46
+ const payload$ = parsed$.value;
47
+ const body$ = (0, encodings_js_1.encodeJSON)("body", payload$.AccountSearch, { explode: true });
48
+ const path$ = (0, url_js_1.pathToFunc)("/account.v1.AccountService/GetDataPoints")();
49
+ const headers$ = new Headers({
50
+ "Content-Type": "application/json",
51
+ Accept: "application/json",
52
+ "User-Agent": (0, encodings_js_1.encodeSimple)("User-Agent", payload$["User-Agent"], {
53
+ explode: false,
54
+ charEncoding: "none",
55
+ }),
56
+ "X-Forwarded-For": (0, encodings_js_1.encodeSimple)("X-Forwarded-For", payload$["X-Forwarded-For"], {
57
+ explode: false,
58
+ charEncoding: "none",
59
+ }),
60
+ });
61
+ const session$ = await (0, security_js_1.extractSecurity)(client$.options$.session);
62
+ const security$ = session$ == null ? {} : { session: session$ };
63
+ const context = {
64
+ operationID: "account.v1.getDataPoints",
65
+ oAuth2Scopes: [],
66
+ securitySource: client$.options$.session,
67
+ };
68
+ const securitySettings$ = (0, security_js_1.resolveGlobalSecurity)(security$);
69
+ const requestRes = client$.createRequest$(context, {
70
+ security: securitySettings$,
71
+ method: "POST",
72
+ path: path$,
73
+ headers: headers$,
74
+ body: body$,
75
+ uaHeader: "x-speakeasy-user-agent",
76
+ timeoutMs: (options === null || options === void 0 ? void 0 : options.timeoutMs) || client$.options$.timeoutMs || -1,
77
+ }, options);
78
+ if (!requestRes.ok) {
79
+ return requestRes;
80
+ }
81
+ const request$ = requestRes.value;
82
+ const doResult = await client$.do$(request$, {
83
+ context,
84
+ errorCodes: ["400", "404", "422", "4XX", "500", "5XX"],
85
+ retryConfig: (options === null || options === void 0 ? void 0 : options.retries) || client$.options$.retryConfig,
86
+ retryCodes: (options === null || options === void 0 ? void 0 : options.retryCodes) || ["429", "500", "502", "503", "504"],
87
+ });
88
+ if (!doResult.ok) {
89
+ return doResult;
90
+ }
91
+ const response = doResult.value;
92
+ const responseFields$ = {
93
+ HttpMeta: { Response: response, Request: request$ },
94
+ };
95
+ const [result$] = await m$.match(m$.json(200, operations.AccountV1GetDataPointsResponse$inboundSchema, {
96
+ key: "V1AccountDataPointsResponseBody",
97
+ }), m$.jsonErr([400, 404, 422, 500], errors.ErrorModel$inboundSchema, {
98
+ ctype: "application/problem+json",
99
+ }), m$.fail(["4XX", "5XX"]))(response, request$, { extraFields: responseFields$ });
100
+ if (!result$.ok) {
101
+ return result$;
102
+ }
103
+ return result$;
104
+ }
105
+ //# sourceMappingURL=accountAccountV1GetDataPoints.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"accountAccountV1GetDataPoints.js","sourceRoot":"","sources":["../src/funcs/accountAccountV1GetDataPoints.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;AAyBH,sEA+GC;AArID,sDAA+F;AAC/F,uDAAyC;AACzC,4DAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAQ3C,kEAAoD;AAGpD,0EAA4D;AAG5D;;GAEG;AACI,KAAK,UAAU,6BAA6B,CAC/C,OAAsB,EACtB,OAAiD,EACjD,OAAwB;IAcxB,MAAM,MAAM,GAAG,OAAO,CAAC;IAEvB,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAC9B,MAAM,EACN,CAAC,MAAM,EAAE,EAAE,CAAC,UAAU,CAAC,4CAA4C,CAAC,KAAK,CAAC,MAAM,CAAC,EACjF,yBAAyB,CAC5B,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QACd,OAAO,OAAO,CAAC;IACnB,CAAC;IACD,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC;IAC/B,MAAM,KAAK,GAAG,IAAA,yBAAW,EAAC,MAAM,EAAE,QAAQ,CAAC,aAAa,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAE7E,MAAM,KAAK,GAAG,IAAA,mBAAU,EAAC,0CAA0C,CAAC,EAAE,CAAC;IAEvE,MAAM,QAAQ,GAAG,IAAI,OAAO,CAAC;QACzB,cAAc,EAAE,kBAAkB;QAClC,MAAM,EAAE,kBAAkB;QAC1B,YAAY,EAAE,IAAA,2BAAa,EAAC,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC,EAAE;YAC9D,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,MAAM;SACvB,CAAC;QACF,iBAAiB,EAAE,IAAA,2BAAa,EAAC,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB,CAAC,EAAE;YAC7E,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,MAAM;SACvB,CAAC;KACL,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,MAAM,IAAA,6BAAe,EAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACjE,MAAM,SAAS,GAAG,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC;IAChE,MAAM,OAAO,GAAG;QACZ,WAAW,EAAE,0BAA0B;QACvC,YAAY,EAAE,EAAE;QAChB,cAAc,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO;KAC3C,CAAC;IACF,MAAM,iBAAiB,GAAG,IAAA,mCAAqB,EAAC,SAAS,CAAC,CAAC;IAE3D,MAAM,UAAU,GAAG,OAAO,CAAC,cAAc,CACrC,OAAO,EACP;QACI,QAAQ,EAAE,iBAAiB;QAC3B,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,QAAQ;QACjB,IAAI,EAAE,KAAK;QACX,QAAQ,EAAE,wBAAwB;QAClC,SAAS,EAAE,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,KAAI,OAAO,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACpE,EACD,OAAO,CACV,CAAC;IACF,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,UAAU,CAAC;IACtB,CAAC;IACD,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAC;IAElC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE;QACzC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QACtD,WAAW,EAAE,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,KAAI,OAAO,CAAC,QAAQ,CAAC,WAAW;QAC7D,UAAU,EAAE,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,KAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACzE,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,QAAQ,CAAC;IACpB,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,eAAe,GAAG;QACpB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE;KACtD,CAAC;IAEF,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,EAAE,CAAC,KAAK,CAW5B,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,4CAA4C,EAAE;QAClE,GAAG,EAAE,iCAAiC;KACzC,CAAC,EACF,EAAE,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,wBAAwB,EAAE;QAC9D,KAAK,EAAE,0BAA0B;KACpC,CAAC,EACF,EAAE,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAC1B,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;IACxD,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QACd,OAAO,OAAO,CAAC;IACnB,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC"}
@@ -0,0 +1,13 @@
1
+ import { SteamSetsCore } from "../core.js";
2
+ import { RequestOptions } from "../lib/sdks.js";
3
+ import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
4
+ import * as errors from "../models/errors/index.js";
5
+ import { SDKError } from "../models/errors/sdkerror.js";
6
+ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
7
+ import * as operations from "../models/operations/index.js";
8
+ import { Result } from "../types/fp.js";
9
+ /**
10
+ * Get Account DataPoints
11
+ */
12
+ export declare function dataAccountV1GetDataPoints(client$: SteamSetsCore, request: operations.AccountV1GetDataPointsRequest, options?: RequestOptions): Promise<Result<operations.AccountV1GetDataPointsResponse, errors.ErrorModel | SDKError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
13
+ //# sourceMappingURL=dataAccountV1GetDataPoints.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"dataAccountV1GetDataPoints.d.ts","sourceRoot":"","sources":["../src/funcs/dataAccountV1GetDataPoints.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAI3C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EACH,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACxB,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;;GAEG;AACH,wBAAsB,0BAA0B,CAC5C,OAAO,EAAE,aAAa,EACtB,OAAO,EAAE,UAAU,CAAC,6BAA6B,EACjD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CACN,MAAM,CACF,UAAU,CAAC,8BAA8B,EACvC,MAAM,CAAC,UAAU,GACjB,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CACpB,CACJ,CA+FA"}