@steamsets/client-ts 0.11.4 → 0.11.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -10
- package/docs/sdks/account/README.md +239 -99
- package/docs/sdks/app/README.md +12 -13
- package/docs/sdks/badge/README.md +6 -7
- package/docs/sdks/connection/README.md +12 -15
- package/docs/sdks/data/README.md +106 -35
- package/docs/sdks/developer/README.md +9 -11
- package/docs/sdks/leaderboard/README.md +99 -15
- package/docs/sdks/liveness/README.md +2 -2
- package/docs/sdks/location/README.md +3 -3
- package/docs/sdks/public/README.md +103 -31
- package/docs/sdks/session/README.md +11 -14
- package/docs/sdks/settings/README.md +20 -26
- package/funcs/accountAccountV1LeaderboardPreview.d.ts +14 -0
- package/funcs/accountAccountV1LeaderboardPreview.d.ts.map +1 -0
- package/funcs/accountAccountV1LeaderboardPreview.js +99 -0
- package/funcs/accountAccountV1LeaderboardPreview.js.map +1 -0
- package/funcs/accountAccountV1Queue.d.ts +14 -0
- package/funcs/accountAccountV1Queue.d.ts.map +1 -0
- package/funcs/{appAccountV1Queue.js → accountAccountV1Queue.js} +6 -6
- package/funcs/accountAccountV1Queue.js.map +1 -0
- package/funcs/{appAccountV1Queue.d.ts → appAppV1Queue.d.ts} +2 -2
- package/funcs/appAppV1Queue.d.ts.map +1 -0
- package/funcs/appAppV1Queue.js +97 -0
- package/funcs/appAppV1Queue.js.map +1 -0
- package/funcs/dataAccountV1Queue.d.ts +2 -2
- package/funcs/dataAccountV1Queue.d.ts.map +1 -1
- package/funcs/dataAccountV1Queue.js +3 -3
- package/funcs/dataAccountV1Queue.js.map +1 -1
- package/funcs/dataAppV1Queue.d.ts +14 -0
- package/funcs/dataAppV1Queue.d.ts.map +1 -0
- package/funcs/dataAppV1Queue.js +97 -0
- package/funcs/dataAppV1Queue.js.map +1 -0
- package/funcs/leaderboardAccountV1LeaderboardPreview.d.ts +14 -0
- package/funcs/leaderboardAccountV1LeaderboardPreview.d.ts.map +1 -0
- package/funcs/leaderboardAccountV1LeaderboardPreview.js +99 -0
- package/funcs/leaderboardAccountV1LeaderboardPreview.js.map +1 -0
- package/funcs/publicAccountV1Queue.d.ts +2 -2
- package/funcs/publicAccountV1Queue.d.ts.map +1 -1
- package/funcs/publicAccountV1Queue.js +3 -3
- package/funcs/publicAccountV1Queue.js.map +1 -1
- package/funcs/publicAppV1Queue.d.ts +14 -0
- package/funcs/publicAppV1Queue.d.ts.map +1 -0
- package/funcs/publicAppV1Queue.js +97 -0
- package/funcs/publicAppV1Queue.js.map +1 -0
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- 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/leaderboardapp.d.ts +21 -0
- package/models/components/leaderboardapp.d.ts.map +1 -0
- package/models/components/leaderboardapp.js +46 -0
- package/models/components/leaderboardapp.js.map +1 -0
- package/models/components/v1accountleaderboardpreviewrequestbody.d.ts +110 -0
- package/models/components/v1accountleaderboardpreviewrequestbody.d.ts.map +1 -0
- package/models/components/v1accountleaderboardpreviewrequestbody.js +90 -0
- package/models/components/v1accountleaderboardpreviewrequestbody.js.map +1 -0
- package/models/components/v1accountleaderboardpreviewresponsebody.d.ts +38 -0
- package/models/components/v1accountleaderboardpreviewresponsebody.d.ts.map +1 -0
- package/models/components/v1accountleaderboardpreviewresponsebody.js +63 -0
- package/models/components/v1accountleaderboardpreviewresponsebody.js.map +1 -0
- package/models/components/v1accountleaderboardrequestbody.d.ts +5 -2
- package/models/components/v1accountleaderboardrequestbody.d.ts.map +1 -1
- package/models/components/v1accountleaderboardrequestbody.js +3 -2
- package/models/components/v1accountleaderboardrequestbody.js.map +1 -1
- package/models/components/v1accountleaderboardresponsebody.d.ts +7 -7
- package/models/components/v1accountleaderboardresponsebody.d.ts.map +1 -1
- package/models/components/v1accountleaderboardresponsebody.js +8 -7
- package/models/components/v1accountleaderboardresponsebody.js.map +1 -1
- package/models/operations/accountv1leaderboardpreview.d.ts +31 -0
- package/models/operations/accountv1leaderboardpreview.d.ts.map +1 -0
- package/models/operations/accountv1leaderboardpreview.js +66 -0
- package/models/operations/accountv1leaderboardpreview.js.map +1 -0
- package/models/operations/appv1queue.d.ts +32 -0
- package/models/operations/appv1queue.d.ts.map +1 -0
- package/models/operations/appv1queue.js +64 -0
- package/models/operations/appv1queue.js.map +1 -0
- package/models/operations/index.d.ts +2 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +2 -0
- package/models/operations/index.js.map +1 -1
- package/package.json +1 -1
- package/sdk/account.d.ts +8 -0
- package/sdk/account.d.ts.map +1 -1
- package/sdk/account.js +14 -0
- package/sdk/account.js.map +1 -1
- package/sdk/app.d.ts +1 -1
- package/sdk/app.d.ts.map +1 -1
- package/sdk/app.js +3 -3
- package/sdk/app.js.map +1 -1
- package/sdk/data.d.ts +5 -1
- package/sdk/data.d.ts.map +1 -1
- package/sdk/data.js +8 -1
- package/sdk/data.js.map +1 -1
- package/sdk/leaderboard.d.ts +4 -0
- package/sdk/leaderboard.d.ts.map +1 -1
- package/sdk/leaderboard.js +7 -0
- package/sdk/leaderboard.js.map +1 -1
- package/sdk/public.d.ts +5 -1
- package/sdk/public.d.ts.map +1 -1
- package/sdk/public.js +8 -1
- package/sdk/public.js.map +1 -1
- package/sdk/sdk.d.ts +2 -2
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +4 -4
- package/sdk/sdk.js.map +1 -1
- package/src/funcs/accountAccountV1LeaderboardPreview.ts +132 -0
- package/src/funcs/accountAccountV1Queue.ts +127 -0
- package/src/funcs/{appAccountV1Queue.ts → appAppV1Queue.ts} +5 -5
- package/src/funcs/dataAccountV1Queue.ts +4 -4
- package/src/funcs/dataAppV1Queue.ts +127 -0
- package/src/funcs/leaderboardAccountV1LeaderboardPreview.ts +132 -0
- package/src/funcs/publicAccountV1Queue.ts +4 -4
- package/src/funcs/publicAppV1Queue.ts +127 -0
- package/src/lib/config.ts +3 -3
- package/src/models/components/index.ts +3 -0
- package/src/models/components/leaderboardapp.ts +37 -0
- package/src/models/components/v1accountleaderboardpreviewrequestbody.ts +110 -0
- package/src/models/components/v1accountleaderboardpreviewresponsebody.ts +73 -0
- package/src/models/components/v1accountleaderboardrequestbody.ts +8 -4
- package/src/models/components/v1accountleaderboardresponsebody.ts +18 -17
- package/src/models/operations/accountv1leaderboardpreview.ts +74 -0
- package/src/models/operations/appv1queue.ts +61 -0
- package/src/models/operations/index.ts +2 -0
- package/src/sdk/account.ts +30 -0
- package/src/sdk/app.ts +4 -4
- package/src/sdk/data.ts +17 -2
- package/src/sdk/leaderboard.ts +15 -0
- package/src/sdk/public.ts +17 -2
- package/src/sdk/sdk.ts +5 -5
- package/funcs/appAccountV1Queue.d.ts.map +0 -1
- package/funcs/appAccountV1Queue.js.map +0 -1
|
@@ -18,10 +18,12 @@ Account related operations
|
|
|
18
18
|
* [accountV1GetFriends](#accountv1getfriends) - Get Account Friends
|
|
19
19
|
* [accountV1GetInfo](#accountv1getinfo) - Get Account Info
|
|
20
20
|
* [accountV1GetLeaderboardHistory](#accountv1getleaderboardhistory) - Get Account Leaderboard History
|
|
21
|
+
* [accountV1LeaderboardPreview](#accountv1leaderboardpreview) - Preview what a given score would result in
|
|
21
22
|
* [accountV1SessionGet](#accountv1sessionget) - Gets all session data
|
|
22
23
|
* [accountV1SettingsGet](#accountv1settingsget) - Gets all settings for the account
|
|
23
24
|
* [accountV1GetStaff](#accountv1getstaff) - Get Staff Members and their info
|
|
24
25
|
* [accountV1SessionLogin](#accountv1sessionlogin) - Logs a user in and creates a new session
|
|
26
|
+
* [accountV1Queue](#accountv1queue) - Queue an account for processing
|
|
25
27
|
* [accountV1SettingsSendEmailVerification](#accountv1settingssendemailverification) - Resend the verification code for an email
|
|
26
28
|
* [accountV1ConnectionUpdateConnection](#accountv1connectionupdateconnection) - Make a connection visible/invisible
|
|
27
29
|
* [accountV1SettingsUpdateImage](#accountv1settingsupdateimage) - Update one of the uploaded images
|
|
@@ -105,11 +107,10 @@ run();
|
|
|
105
107
|
|
|
106
108
|
### Errors
|
|
107
109
|
|
|
108
|
-
| Error
|
|
110
|
+
| Error Type | Status Code | Content Type |
|
|
109
111
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
110
|
-
| errors.ErrorModel | 400,422,500
|
|
111
|
-
| errors.SDKError |
|
|
112
|
-
|
|
112
|
+
| errors.ErrorModel | 400, 422, 500 | application/problem+json |
|
|
113
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
113
114
|
|
|
114
115
|
## accountV1SessionCreate
|
|
115
116
|
|
|
@@ -179,11 +180,10 @@ run();
|
|
|
179
180
|
|
|
180
181
|
### Errors
|
|
181
182
|
|
|
182
|
-
| Error
|
|
183
|
+
| Error Type | Status Code | Content Type |
|
|
183
184
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
184
|
-
| errors.ErrorModel | 422,500
|
|
185
|
-
| errors.SDKError |
|
|
186
|
-
|
|
185
|
+
| errors.ErrorModel | 422, 500 | application/problem+json |
|
|
186
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
187
187
|
|
|
188
188
|
## accountV1ConnectionDeleteConnection
|
|
189
189
|
|
|
@@ -257,11 +257,10 @@ run();
|
|
|
257
257
|
|
|
258
258
|
### Errors
|
|
259
259
|
|
|
260
|
-
| Error
|
|
260
|
+
| Error Type | Status Code | Content Type |
|
|
261
261
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
262
|
-
| errors.ErrorModel | 400,422,500
|
|
263
|
-
| errors.SDKError |
|
|
264
|
-
|
|
262
|
+
| errors.ErrorModel | 400, 422, 500 | application/problem+json |
|
|
263
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
265
264
|
|
|
266
265
|
## accountV1SettingsDeleteImages
|
|
267
266
|
|
|
@@ -339,11 +338,10 @@ run();
|
|
|
339
338
|
|
|
340
339
|
### Errors
|
|
341
340
|
|
|
342
|
-
| Error
|
|
341
|
+
| Error Type | Status Code | Content Type |
|
|
343
342
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
344
|
-
| errors.ErrorModel | 404,422,500
|
|
345
|
-
| errors.SDKError |
|
|
346
|
-
|
|
343
|
+
| errors.ErrorModel | 404, 422, 500 | application/problem+json |
|
|
344
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
347
345
|
|
|
348
346
|
## accountV1SessionDelete
|
|
349
347
|
|
|
@@ -417,11 +415,10 @@ run();
|
|
|
417
415
|
|
|
418
416
|
### Errors
|
|
419
417
|
|
|
420
|
-
| Error
|
|
418
|
+
| Error Type | Status Code | Content Type |
|
|
421
419
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
422
|
-
| errors.ErrorModel | 404,422,500
|
|
423
|
-
| errors.SDKError |
|
|
424
|
-
|
|
420
|
+
| errors.ErrorModel | 404, 422, 500 | application/problem+json |
|
|
421
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
425
422
|
|
|
426
423
|
## accountV1GetApps
|
|
427
424
|
|
|
@@ -491,11 +488,10 @@ run();
|
|
|
491
488
|
|
|
492
489
|
### Errors
|
|
493
490
|
|
|
494
|
-
| Error
|
|
491
|
+
| Error Type | Status Code | Content Type |
|
|
495
492
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
496
|
-
| errors.ErrorModel | 400,404,422,500
|
|
497
|
-
| errors.SDKError |
|
|
498
|
-
|
|
493
|
+
| errors.ErrorModel | 400, 404, 422, 500 | application/problem+json |
|
|
494
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
499
495
|
|
|
500
496
|
## accountV1GetBadges
|
|
501
497
|
|
|
@@ -565,11 +561,10 @@ run();
|
|
|
565
561
|
|
|
566
562
|
### Errors
|
|
567
563
|
|
|
568
|
-
| Error
|
|
564
|
+
| Error Type | Status Code | Content Type |
|
|
569
565
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
570
|
-
| errors.ErrorModel | 400,404,422,500
|
|
571
|
-
| errors.SDKError |
|
|
572
|
-
|
|
566
|
+
| errors.ErrorModel | 400, 404, 422, 500 | application/problem+json |
|
|
567
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
573
568
|
|
|
574
569
|
## accountV1GetDataPoints
|
|
575
570
|
|
|
@@ -639,11 +634,10 @@ run();
|
|
|
639
634
|
|
|
640
635
|
### Errors
|
|
641
636
|
|
|
642
|
-
| Error
|
|
637
|
+
| Error Type | Status Code | Content Type |
|
|
643
638
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
644
|
-
| errors.ErrorModel | 400,404,422,500
|
|
645
|
-
| errors.SDKError |
|
|
646
|
-
|
|
639
|
+
| errors.ErrorModel | 400, 404, 422, 500 | application/problem+json |
|
|
640
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
647
641
|
|
|
648
642
|
## accountV1GetFriends
|
|
649
643
|
|
|
@@ -713,11 +707,10 @@ run();
|
|
|
713
707
|
|
|
714
708
|
### Errors
|
|
715
709
|
|
|
716
|
-
| Error
|
|
710
|
+
| Error Type | Status Code | Content Type |
|
|
717
711
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
718
|
-
| errors.ErrorModel | 400,404,422,500
|
|
719
|
-
| errors.SDKError |
|
|
720
|
-
|
|
712
|
+
| errors.ErrorModel | 400, 404, 422, 500 | application/problem+json |
|
|
713
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
721
714
|
|
|
722
715
|
## accountV1GetInfo
|
|
723
716
|
|
|
@@ -787,11 +780,10 @@ run();
|
|
|
787
780
|
|
|
788
781
|
### Errors
|
|
789
782
|
|
|
790
|
-
| Error
|
|
783
|
+
| Error Type | Status Code | Content Type |
|
|
791
784
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
792
|
-
| errors.ErrorModel | 404,422,429,500
|
|
793
|
-
| errors.SDKError |
|
|
794
|
-
|
|
785
|
+
| errors.ErrorModel | 404, 422, 429, 500 | application/problem+json |
|
|
786
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
795
787
|
|
|
796
788
|
## accountV1GetLeaderboardHistory
|
|
797
789
|
|
|
@@ -861,11 +853,89 @@ run();
|
|
|
861
853
|
|
|
862
854
|
### Errors
|
|
863
855
|
|
|
864
|
-
| Error
|
|
856
|
+
| Error Type | Status Code | Content Type |
|
|
865
857
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
866
|
-
| errors.ErrorModel | 400,404,422,500
|
|
867
|
-
| errors.SDKError |
|
|
858
|
+
| errors.ErrorModel | 400, 404, 422, 500 | application/problem+json |
|
|
859
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
860
|
+
|
|
861
|
+
## accountV1LeaderboardPreview
|
|
862
|
+
|
|
863
|
+
Preview what a given score would result in
|
|
864
|
+
|
|
865
|
+
### Example Usage
|
|
866
|
+
|
|
867
|
+
```typescript
|
|
868
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
869
|
+
|
|
870
|
+
const steamSets = new SteamSets({
|
|
871
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
872
|
+
});
|
|
873
|
+
|
|
874
|
+
async function run() {
|
|
875
|
+
const result = await steamSets.account.accountV1LeaderboardPreview({
|
|
876
|
+
leaderboard: "xp",
|
|
877
|
+
score: 123456,
|
|
878
|
+
});
|
|
879
|
+
|
|
880
|
+
// Handle the result
|
|
881
|
+
console.log(result);
|
|
882
|
+
}
|
|
883
|
+
|
|
884
|
+
run();
|
|
885
|
+
```
|
|
886
|
+
|
|
887
|
+
### Standalone function
|
|
888
|
+
|
|
889
|
+
The standalone function version of this method:
|
|
890
|
+
|
|
891
|
+
```typescript
|
|
892
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
893
|
+
import { accountAccountV1LeaderboardPreview } from "@steamsets/client-ts/funcs/accountAccountV1LeaderboardPreview.js";
|
|
894
|
+
|
|
895
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
896
|
+
// You can create one instance of it to use across an application.
|
|
897
|
+
const steamSets = new SteamSetsCore({
|
|
898
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
899
|
+
});
|
|
900
|
+
|
|
901
|
+
async function run() {
|
|
902
|
+
const res = await accountAccountV1LeaderboardPreview(steamSets, {
|
|
903
|
+
leaderboard: "xp",
|
|
904
|
+
score: 123456,
|
|
905
|
+
});
|
|
906
|
+
|
|
907
|
+
if (!res.ok) {
|
|
908
|
+
throw res.error;
|
|
909
|
+
}
|
|
910
|
+
|
|
911
|
+
const { value: result } = res;
|
|
912
|
+
|
|
913
|
+
// Handle the result
|
|
914
|
+
console.log(result);
|
|
915
|
+
}
|
|
916
|
+
|
|
917
|
+
run();
|
|
918
|
+
```
|
|
919
|
+
|
|
920
|
+
### Parameters
|
|
921
|
+
|
|
922
|
+
| Parameter | Type | Required | Description |
|
|
923
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
924
|
+
| `request` | [components.V1AccountLeaderboardPreviewRequestBody](../../models/components/v1accountleaderboardpreviewrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
925
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
926
|
+
| `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. |
|
|
927
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
868
928
|
|
|
929
|
+
### Response
|
|
930
|
+
|
|
931
|
+
**Promise\<[operations.AccountV1LeaderboardPreviewResponse](../../models/operations/accountv1leaderboardpreviewresponse.md)\>**
|
|
932
|
+
|
|
933
|
+
### Errors
|
|
934
|
+
|
|
935
|
+
| Error Type | Status Code | Content Type |
|
|
936
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
937
|
+
| errors.ErrorModel | 404, 422, 500 | application/problem+json |
|
|
938
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
869
939
|
|
|
870
940
|
## accountV1SessionGet
|
|
871
941
|
|
|
@@ -934,11 +1004,10 @@ run();
|
|
|
934
1004
|
|
|
935
1005
|
### Errors
|
|
936
1006
|
|
|
937
|
-
| Error
|
|
1007
|
+
| Error Type | Status Code | Content Type |
|
|
938
1008
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
939
1009
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
940
|
-
| errors.SDKError |
|
|
941
|
-
|
|
1010
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
942
1011
|
|
|
943
1012
|
## accountV1SettingsGet
|
|
944
1013
|
|
|
@@ -1007,11 +1076,10 @@ run();
|
|
|
1007
1076
|
|
|
1008
1077
|
### Errors
|
|
1009
1078
|
|
|
1010
|
-
| Error
|
|
1079
|
+
| Error Type | Status Code | Content Type |
|
|
1011
1080
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1012
1081
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
1013
|
-
| errors.SDKError |
|
|
1014
|
-
|
|
1082
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1015
1083
|
|
|
1016
1084
|
## accountV1GetStaff
|
|
1017
1085
|
|
|
@@ -1080,11 +1148,10 @@ run();
|
|
|
1080
1148
|
|
|
1081
1149
|
### Errors
|
|
1082
1150
|
|
|
1083
|
-
| Error
|
|
1151
|
+
| Error Type | Status Code | Content Type |
|
|
1084
1152
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1085
|
-
| errors.ErrorModel | 404,429,500
|
|
1086
|
-
| errors.SDKError |
|
|
1087
|
-
|
|
1153
|
+
| errors.ErrorModel | 404, 429, 500 | application/problem+json |
|
|
1154
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1088
1155
|
|
|
1089
1156
|
## accountV1SessionLogin
|
|
1090
1157
|
|
|
@@ -1180,11 +1247,87 @@ run();
|
|
|
1180
1247
|
|
|
1181
1248
|
### Errors
|
|
1182
1249
|
|
|
1183
|
-
| Error
|
|
1250
|
+
| Error Type | Status Code | Content Type |
|
|
1184
1251
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1185
|
-
| errors.ErrorModel | 400,422,429,500
|
|
1186
|
-
| errors.SDKError |
|
|
1252
|
+
| errors.ErrorModel | 400, 422, 429, 500 | application/problem+json |
|
|
1253
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1254
|
+
|
|
1255
|
+
## accountV1Queue
|
|
1187
1256
|
|
|
1257
|
+
Queue an account for processing
|
|
1258
|
+
|
|
1259
|
+
### Example Usage
|
|
1260
|
+
|
|
1261
|
+
```typescript
|
|
1262
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
1263
|
+
|
|
1264
|
+
const steamSets = new SteamSets({
|
|
1265
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1266
|
+
});
|
|
1267
|
+
|
|
1268
|
+
async function run() {
|
|
1269
|
+
const result = await steamSets.account.accountV1Queue({
|
|
1270
|
+
id: {},
|
|
1271
|
+
});
|
|
1272
|
+
|
|
1273
|
+
// Handle the result
|
|
1274
|
+
console.log(result);
|
|
1275
|
+
}
|
|
1276
|
+
|
|
1277
|
+
run();
|
|
1278
|
+
```
|
|
1279
|
+
|
|
1280
|
+
### Standalone function
|
|
1281
|
+
|
|
1282
|
+
The standalone function version of this method:
|
|
1283
|
+
|
|
1284
|
+
```typescript
|
|
1285
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1286
|
+
import { accountAccountV1Queue } from "@steamsets/client-ts/funcs/accountAccountV1Queue.js";
|
|
1287
|
+
|
|
1288
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1289
|
+
// You can create one instance of it to use across an application.
|
|
1290
|
+
const steamSets = new SteamSetsCore({
|
|
1291
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1292
|
+
});
|
|
1293
|
+
|
|
1294
|
+
async function run() {
|
|
1295
|
+
const res = await accountAccountV1Queue(steamSets, {
|
|
1296
|
+
id: {},
|
|
1297
|
+
});
|
|
1298
|
+
|
|
1299
|
+
if (!res.ok) {
|
|
1300
|
+
throw res.error;
|
|
1301
|
+
}
|
|
1302
|
+
|
|
1303
|
+
const { value: result } = res;
|
|
1304
|
+
|
|
1305
|
+
// Handle the result
|
|
1306
|
+
console.log(result);
|
|
1307
|
+
}
|
|
1308
|
+
|
|
1309
|
+
run();
|
|
1310
|
+
```
|
|
1311
|
+
|
|
1312
|
+
### Parameters
|
|
1313
|
+
|
|
1314
|
+
| Parameter | Type | Required | Description |
|
|
1315
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1316
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1317
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1318
|
+
| `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. |
|
|
1319
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1320
|
+
|
|
1321
|
+
### Response
|
|
1322
|
+
|
|
1323
|
+
**Promise\<[operations.AccountV1QueueResponse](../../models/operations/accountv1queueresponse.md)\>**
|
|
1324
|
+
|
|
1325
|
+
### Errors
|
|
1326
|
+
|
|
1327
|
+
| Error Type | Status Code | Content Type |
|
|
1328
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
1329
|
+
| errors.ErrorModel | 400, 422, 429, 500 | application/problem+json |
|
|
1330
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1188
1331
|
|
|
1189
1332
|
## accountV1SettingsSendEmailVerification
|
|
1190
1333
|
|
|
@@ -1254,11 +1397,10 @@ run();
|
|
|
1254
1397
|
|
|
1255
1398
|
### Errors
|
|
1256
1399
|
|
|
1257
|
-
| Error
|
|
1400
|
+
| Error Type | Status Code | Content Type |
|
|
1258
1401
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1259
|
-
| errors.ErrorModel | 404,422,429,500
|
|
1260
|
-
| errors.SDKError |
|
|
1261
|
-
|
|
1402
|
+
| errors.ErrorModel | 404, 422, 429, 500 | application/problem+json |
|
|
1403
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1262
1404
|
|
|
1263
1405
|
## accountV1ConnectionUpdateConnection
|
|
1264
1406
|
|
|
@@ -1334,11 +1476,10 @@ run();
|
|
|
1334
1476
|
|
|
1335
1477
|
### Errors
|
|
1336
1478
|
|
|
1337
|
-
| Error
|
|
1479
|
+
| Error Type | Status Code | Content Type |
|
|
1338
1480
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1339
|
-
| errors.ErrorModel | 400,404,422,500
|
|
1340
|
-
| errors.SDKError |
|
|
1341
|
-
|
|
1481
|
+
| errors.ErrorModel | 400, 404, 422, 500 | application/problem+json |
|
|
1482
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1342
1483
|
|
|
1343
1484
|
## accountV1SettingsUpdateImage
|
|
1344
1485
|
|
|
@@ -1414,11 +1555,10 @@ run();
|
|
|
1414
1555
|
|
|
1415
1556
|
### Errors
|
|
1416
1557
|
|
|
1417
|
-
| Error
|
|
1558
|
+
| Error Type | Status Code | Content Type |
|
|
1418
1559
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1419
|
-
| errors.ErrorModel | 404,422,500
|
|
1420
|
-
| errors.SDKError |
|
|
1421
|
-
|
|
1560
|
+
| errors.ErrorModel | 404, 422, 500 | application/problem+json |
|
|
1561
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1422
1562
|
|
|
1423
1563
|
## accountV1SettingsUpdate
|
|
1424
1564
|
|
|
@@ -1520,11 +1660,10 @@ run();
|
|
|
1520
1660
|
|
|
1521
1661
|
### Errors
|
|
1522
1662
|
|
|
1523
|
-
| Error
|
|
1663
|
+
| Error Type | Status Code | Content Type |
|
|
1524
1664
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1525
|
-
| errors.ErrorModel | 422,429,500
|
|
1526
|
-
| errors.SDKError |
|
|
1527
|
-
|
|
1665
|
+
| errors.ErrorModel | 422, 429, 500 | application/problem+json |
|
|
1666
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1528
1667
|
|
|
1529
1668
|
## accountV1SettingsUploadImages
|
|
1530
1669
|
|
|
@@ -1608,11 +1747,10 @@ run();
|
|
|
1608
1747
|
|
|
1609
1748
|
### Errors
|
|
1610
1749
|
|
|
1611
|
-
| Error
|
|
1750
|
+
| Error Type | Status Code | Content Type |
|
|
1612
1751
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1613
|
-
| errors.ErrorModel | 422,500
|
|
1614
|
-
| errors.SDKError |
|
|
1615
|
-
|
|
1752
|
+
| errors.ErrorModel | 422, 500 | application/problem+json |
|
|
1753
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1616
1754
|
|
|
1617
1755
|
## accountV1ConnectionVerifyConnection
|
|
1618
1756
|
|
|
@@ -1686,11 +1824,10 @@ run();
|
|
|
1686
1824
|
|
|
1687
1825
|
### Errors
|
|
1688
1826
|
|
|
1689
|
-
| Error
|
|
1827
|
+
| Error Type | Status Code | Content Type |
|
|
1690
1828
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1691
|
-
| errors.ErrorModel | 400,422,500
|
|
1692
|
-
| errors.SDKError |
|
|
1693
|
-
|
|
1829
|
+
| errors.ErrorModel | 400, 422, 500 | application/problem+json |
|
|
1830
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1694
1831
|
|
|
1695
1832
|
## accountV1SettingsVerfyEmail
|
|
1696
1833
|
|
|
@@ -1764,11 +1901,10 @@ run();
|
|
|
1764
1901
|
|
|
1765
1902
|
### Errors
|
|
1766
1903
|
|
|
1767
|
-
| Error
|
|
1904
|
+
| Error Type | Status Code | Content Type |
|
|
1768
1905
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1769
|
-
| errors.ErrorModel | 404,422,429,500
|
|
1770
|
-
| errors.SDKError |
|
|
1771
|
-
|
|
1906
|
+
| errors.ErrorModel | 404, 422, 429, 500 | application/problem+json |
|
|
1907
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1772
1908
|
|
|
1773
1909
|
## leaderboardV1GetAccount
|
|
1774
1910
|
|
|
@@ -1790,12 +1926,14 @@ async function run() {
|
|
|
1790
1926
|
badgeIsFoil: true,
|
|
1791
1927
|
end: 10,
|
|
1792
1928
|
leaderboard: "xp",
|
|
1793
|
-
location:
|
|
1794
|
-
|
|
1795
|
-
|
|
1796
|
-
|
|
1797
|
-
|
|
1798
|
-
|
|
1929
|
+
location: [
|
|
1930
|
+
{
|
|
1931
|
+
city: "Bad Krozingen",
|
|
1932
|
+
country: "Germany",
|
|
1933
|
+
region: "Europe",
|
|
1934
|
+
state: "Baden-Wurttemberg",
|
|
1935
|
+
},
|
|
1936
|
+
],
|
|
1799
1937
|
start: 1,
|
|
1800
1938
|
});
|
|
1801
1939
|
|
|
@@ -1827,12 +1965,14 @@ async function run() {
|
|
|
1827
1965
|
badgeIsFoil: true,
|
|
1828
1966
|
end: 10,
|
|
1829
1967
|
leaderboard: "xp",
|
|
1830
|
-
location:
|
|
1831
|
-
|
|
1832
|
-
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
|
|
1968
|
+
location: [
|
|
1969
|
+
{
|
|
1970
|
+
city: "Bad Krozingen",
|
|
1971
|
+
country: "Germany",
|
|
1972
|
+
region: "Europe",
|
|
1973
|
+
state: "Baden-Wurttemberg",
|
|
1974
|
+
},
|
|
1975
|
+
],
|
|
1836
1976
|
start: 1,
|
|
1837
1977
|
});
|
|
1838
1978
|
|
|
@@ -1864,7 +2004,7 @@ run();
|
|
|
1864
2004
|
|
|
1865
2005
|
### Errors
|
|
1866
2006
|
|
|
1867
|
-
| Error
|
|
2007
|
+
| Error Type | Status Code | Content Type |
|
|
1868
2008
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1869
|
-
| errors.ErrorModel | 404,422,500
|
|
1870
|
-
| errors.SDKError |
|
|
2009
|
+
| errors.ErrorModel | 404, 422, 500 | application/problem+json |
|
|
2010
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
package/docs/sdks/app/README.md
CHANGED
|
@@ -8,7 +8,7 @@ App related operations
|
|
|
8
8
|
### Available Operations
|
|
9
9
|
|
|
10
10
|
* [appV1Get](#appv1get) - Get details about an app
|
|
11
|
-
* [
|
|
11
|
+
* [appV1Queue](#appv1queue) - Queue a app for processing
|
|
12
12
|
|
|
13
13
|
## appV1Get
|
|
14
14
|
|
|
@@ -82,13 +82,12 @@ run();
|
|
|
82
82
|
|
|
83
83
|
### Errors
|
|
84
84
|
|
|
85
|
-
| Error
|
|
85
|
+
| Error Type | Status Code | Content Type |
|
|
86
86
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
87
|
-
| errors.ErrorModel | 404,422,500
|
|
88
|
-
| errors.SDKError |
|
|
87
|
+
| errors.ErrorModel | 404, 422, 500 | application/problem+json |
|
|
88
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
89
89
|
|
|
90
|
-
|
|
91
|
-
## accountV1Queue
|
|
90
|
+
## appV1Queue
|
|
92
91
|
|
|
93
92
|
Queue a app for processing
|
|
94
93
|
|
|
@@ -102,7 +101,7 @@ const steamSets = new SteamSets({
|
|
|
102
101
|
});
|
|
103
102
|
|
|
104
103
|
async function run() {
|
|
105
|
-
const result = await steamSets.app.
|
|
104
|
+
const result = await steamSets.app.appV1Queue({
|
|
106
105
|
id: 730,
|
|
107
106
|
});
|
|
108
107
|
|
|
@@ -119,7 +118,7 @@ The standalone function version of this method:
|
|
|
119
118
|
|
|
120
119
|
```typescript
|
|
121
120
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
122
|
-
import {
|
|
121
|
+
import { appAppV1Queue } from "@steamsets/client-ts/funcs/appAppV1Queue.js";
|
|
123
122
|
|
|
124
123
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
125
124
|
// You can create one instance of it to use across an application.
|
|
@@ -128,7 +127,7 @@ const steamSets = new SteamSetsCore({
|
|
|
128
127
|
});
|
|
129
128
|
|
|
130
129
|
async function run() {
|
|
131
|
-
const res = await
|
|
130
|
+
const res = await appAppV1Queue(steamSets, {
|
|
132
131
|
id: 730,
|
|
133
132
|
});
|
|
134
133
|
|
|
@@ -156,11 +155,11 @@ run();
|
|
|
156
155
|
|
|
157
156
|
### Response
|
|
158
157
|
|
|
159
|
-
**Promise\<[operations.
|
|
158
|
+
**Promise\<[operations.AppV1QueueResponse](../../models/operations/appv1queueresponse.md)\>**
|
|
160
159
|
|
|
161
160
|
### Errors
|
|
162
161
|
|
|
163
|
-
| Error
|
|
162
|
+
| Error Type | Status Code | Content Type |
|
|
164
163
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
165
|
-
| errors.ErrorModel | 400,422,429,500
|
|
166
|
-
| errors.SDKError |
|
|
164
|
+
| errors.ErrorModel | 400, 422, 429, 500 | application/problem+json |
|
|
165
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -76,11 +76,10 @@ run();
|
|
|
76
76
|
|
|
77
77
|
### Errors
|
|
78
78
|
|
|
79
|
-
| Error
|
|
79
|
+
| Error Type | Status Code | Content Type |
|
|
80
80
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
81
|
-
| errors.ErrorModel | 403,404,422,500
|
|
82
|
-
| errors.SDKError |
|
|
83
|
-
|
|
81
|
+
| errors.ErrorModel | 403, 404, 422, 500 | application/problem+json |
|
|
82
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
84
83
|
|
|
85
84
|
## badgeV1Tag
|
|
86
85
|
|
|
@@ -190,7 +189,7 @@ run();
|
|
|
190
189
|
|
|
191
190
|
### Errors
|
|
192
191
|
|
|
193
|
-
| Error
|
|
192
|
+
| Error Type | Status Code | Content Type |
|
|
194
193
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
195
|
-
| errors.ErrorModel | 403,404,422,500
|
|
196
|
-
| errors.SDKError |
|
|
194
|
+
| errors.ErrorModel | 403, 404, 422, 500 | application/problem+json |
|
|
195
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|