@steamsets/client-ts 0.11.4 → 0.11.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.
- package/README.md +14 -4
- package/docs/sdks/account/README.md +160 -0
- package/docs/sdks/app/README.md +6 -6
- package/docs/sdks/data/README.md +83 -4
- package/docs/sdks/leaderboard/README.md +81 -0
- package/docs/sdks/public/README.md +83 -4
- 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 +2 -2
- package/lib/config.js +2 -2
- package/models/components/index.d.ts +2 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +2 -0
- package/models/components/index.js.map +1 -1
- package/models/components/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/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 +2 -2
- package/src/models/components/index.ts +2 -0
- package/src/models/components/v1accountleaderboardpreviewrequestbody.ts +110 -0
- package/src/models/components/v1accountleaderboardpreviewresponsebody.ts +73 -0
- 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
package/README.md
CHANGED
|
@@ -86,10 +86,12 @@ run();
|
|
|
86
86
|
* [accountV1GetFriends](docs/sdks/account/README.md#accountv1getfriends) - Get Account Friends
|
|
87
87
|
* [accountV1GetInfo](docs/sdks/account/README.md#accountv1getinfo) - Get Account Info
|
|
88
88
|
* [accountV1GetLeaderboardHistory](docs/sdks/account/README.md#accountv1getleaderboardhistory) - Get Account Leaderboard History
|
|
89
|
+
* [accountV1LeaderboardPreview](docs/sdks/account/README.md#accountv1leaderboardpreview) - Preview what a given score would result in
|
|
89
90
|
* [accountV1SessionGet](docs/sdks/account/README.md#accountv1sessionget) - Gets all session data
|
|
90
91
|
* [accountV1SettingsGet](docs/sdks/account/README.md#accountv1settingsget) - Gets all settings for the account
|
|
91
92
|
* [accountV1GetStaff](docs/sdks/account/README.md#accountv1getstaff) - Get Staff Members and their info
|
|
92
93
|
* [accountV1SessionLogin](docs/sdks/account/README.md#accountv1sessionlogin) - Logs a user in and creates a new session
|
|
94
|
+
* [accountV1Queue](docs/sdks/account/README.md#accountv1queue) - Queue an account for processing
|
|
93
95
|
* [accountV1SettingsSendEmailVerification](docs/sdks/account/README.md#accountv1settingssendemailverification) - Resend the verification code for an email
|
|
94
96
|
* [accountV1ConnectionUpdateConnection](docs/sdks/account/README.md#accountv1connectionupdateconnection) - Make a connection visible/invisible
|
|
95
97
|
* [accountV1SettingsUpdateImage](docs/sdks/account/README.md#accountv1settingsupdateimage) - Update one of the uploaded images
|
|
@@ -102,7 +104,7 @@ run();
|
|
|
102
104
|
### [app](docs/sdks/app/README.md)
|
|
103
105
|
|
|
104
106
|
* [appV1Get](docs/sdks/app/README.md#appv1get) - Get details about an app
|
|
105
|
-
* [
|
|
107
|
+
* [appV1Queue](docs/sdks/app/README.md#appv1queue) - Queue a app for processing
|
|
106
108
|
|
|
107
109
|
### [badge](docs/sdks/badge/README.md)
|
|
108
110
|
|
|
@@ -125,7 +127,8 @@ run();
|
|
|
125
127
|
* [accountV1GetInfo](docs/sdks/data/README.md#accountv1getinfo) - Get Account Info
|
|
126
128
|
* [accountV1GetLeaderboardHistory](docs/sdks/data/README.md#accountv1getleaderboardhistory) - Get Account Leaderboard History
|
|
127
129
|
* [accountV1GetStaff](docs/sdks/data/README.md#accountv1getstaff) - Get Staff Members and their info
|
|
128
|
-
* [accountV1Queue](docs/sdks/data/README.md#accountv1queue) - Queue
|
|
130
|
+
* [accountV1Queue](docs/sdks/data/README.md#accountv1queue) - Queue an account for processing
|
|
131
|
+
* [appV1Queue](docs/sdks/data/README.md#appv1queue) - Queue a app for processing
|
|
129
132
|
|
|
130
133
|
### [developer](docs/sdks/developer/README.md)
|
|
131
134
|
|
|
@@ -135,6 +138,7 @@ run();
|
|
|
135
138
|
|
|
136
139
|
### [leaderboard](docs/sdks/leaderboard/README.md)
|
|
137
140
|
|
|
141
|
+
* [accountV1LeaderboardPreview](docs/sdks/leaderboard/README.md#accountv1leaderboardpreview) - Preview what a given score would result in
|
|
138
142
|
* [leaderboardV1GetAccount](docs/sdks/leaderboard/README.md#leaderboardv1getaccount) - Get an leaderboard for accounts
|
|
139
143
|
|
|
140
144
|
### [liveness](docs/sdks/liveness/README.md)
|
|
@@ -153,7 +157,8 @@ run();
|
|
|
153
157
|
* [accountV1GetFriends](docs/sdks/public/README.md#accountv1getfriends) - Get Account Friends
|
|
154
158
|
* [accountV1GetInfo](docs/sdks/public/README.md#accountv1getinfo) - Get Account Info
|
|
155
159
|
* [accountV1GetLeaderboardHistory](docs/sdks/public/README.md#accountv1getleaderboardhistory) - Get Account Leaderboard History
|
|
156
|
-
* [accountV1Queue](docs/sdks/public/README.md#accountv1queue) - Queue
|
|
160
|
+
* [accountV1Queue](docs/sdks/public/README.md#accountv1queue) - Queue an account for processing
|
|
161
|
+
* [appV1Queue](docs/sdks/public/README.md#appv1queue) - Queue a app for processing
|
|
157
162
|
|
|
158
163
|
### [session](docs/sdks/session/README.md)
|
|
159
164
|
|
|
@@ -523,6 +528,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
523
528
|
- [accountAccountV1GetInfo](docs/sdks/account/README.md#accountv1getinfo)
|
|
524
529
|
- [accountAccountV1GetLeaderboardHistory](docs/sdks/account/README.md#accountv1getleaderboardhistory)
|
|
525
530
|
- [accountAccountV1GetStaff](docs/sdks/account/README.md#accountv1getstaff)
|
|
531
|
+
- [accountAccountV1LeaderboardPreview](docs/sdks/account/README.md#accountv1leaderboardpreview)
|
|
532
|
+
- [accountAccountV1Queue](docs/sdks/account/README.md#accountv1queue)
|
|
526
533
|
- [accountAccountV1SessionCreate](docs/sdks/account/README.md#accountv1sessioncreate)
|
|
527
534
|
- [accountAccountV1SessionDelete](docs/sdks/account/README.md#accountv1sessiondelete)
|
|
528
535
|
- [accountAccountV1SessionGet](docs/sdks/account/README.md#accountv1sessionget)
|
|
@@ -535,8 +542,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
535
542
|
- [accountAccountV1SettingsUploadImages](docs/sdks/account/README.md#accountv1settingsuploadimages)
|
|
536
543
|
- [accountAccountV1SettingsVerfyEmail](docs/sdks/account/README.md#accountv1settingsverfyemail)
|
|
537
544
|
- [accountLeaderboardV1GetAccount](docs/sdks/account/README.md#leaderboardv1getaccount)
|
|
538
|
-
- [appAccountV1Queue](docs/sdks/app/README.md#accountv1queue)
|
|
539
545
|
- [appAppV1Get](docs/sdks/app/README.md#appv1get)
|
|
546
|
+
- [appAppV1Queue](docs/sdks/app/README.md#appv1queue)
|
|
540
547
|
- [badgeBadgeV1Tag](docs/sdks/badge/README.md#badgev1tag)
|
|
541
548
|
- [badgeBadgeV1Tags](docs/sdks/badge/README.md#badgev1tags)
|
|
542
549
|
- [connectionAccountV1ConnectionConnect](docs/sdks/connection/README.md#accountv1connectionconnect)
|
|
@@ -551,9 +558,11 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
551
558
|
- [dataAccountV1GetLeaderboardHistory](docs/sdks/data/README.md#accountv1getleaderboardhistory)
|
|
552
559
|
- [dataAccountV1GetStaff](docs/sdks/data/README.md#accountv1getstaff)
|
|
553
560
|
- [dataAccountV1Queue](docs/sdks/data/README.md#accountv1queue)
|
|
561
|
+
- [dataAppV1Queue](docs/sdks/data/README.md#appv1queue)
|
|
554
562
|
- [developerAccountV1SettingsDeveloperAppCreate](docs/sdks/developer/README.md#accountv1settingsdeveloperappcreate)
|
|
555
563
|
- [developerAccountV1SettingsDeveloperAppDelete](docs/sdks/developer/README.md#accountv1settingsdeveloperappdelete)
|
|
556
564
|
- [developerAccountV1SettingsDeveloperAppUpdate](docs/sdks/developer/README.md#accountv1settingsdeveloperappupdate)
|
|
565
|
+
- [leaderboardAccountV1LeaderboardPreview](docs/sdks/leaderboard/README.md#accountv1leaderboardpreview)
|
|
557
566
|
- [leaderboardLeaderboardV1GetAccount](docs/sdks/leaderboard/README.md#leaderboardv1getaccount)
|
|
558
567
|
- [livenessLiveness](docs/sdks/liveness/README.md#liveness)
|
|
559
568
|
- [locationLocation](docs/sdks/location/README.md#location)
|
|
@@ -564,6 +573,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
564
573
|
- [publicAccountV1GetInfo](docs/sdks/public/README.md#accountv1getinfo)
|
|
565
574
|
- [publicAccountV1GetLeaderboardHistory](docs/sdks/public/README.md#accountv1getleaderboardhistory)
|
|
566
575
|
- [publicAccountV1Queue](docs/sdks/public/README.md#accountv1queue)
|
|
576
|
+
- [publicAppV1Queue](docs/sdks/public/README.md#appv1queue)
|
|
567
577
|
- [sessionAccountV1SessionCreate](docs/sdks/session/README.md#accountv1sessioncreate)
|
|
568
578
|
- [sessionAccountV1SessionDelete](docs/sdks/session/README.md#accountv1sessiondelete)
|
|
569
579
|
- [sessionAccountV1SessionGet](docs/sdks/session/README.md#accountv1sessionget)
|
|
@@ -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
|
|
@@ -867,6 +869,86 @@ run();
|
|
|
867
869
|
| errors.SDKError | 4xx-5xx | */* |
|
|
868
870
|
|
|
869
871
|
|
|
872
|
+
## accountV1LeaderboardPreview
|
|
873
|
+
|
|
874
|
+
Preview what a given score would result in
|
|
875
|
+
|
|
876
|
+
### Example Usage
|
|
877
|
+
|
|
878
|
+
```typescript
|
|
879
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
880
|
+
|
|
881
|
+
const steamSets = new SteamSets({
|
|
882
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
883
|
+
});
|
|
884
|
+
|
|
885
|
+
async function run() {
|
|
886
|
+
const result = await steamSets.account.accountV1LeaderboardPreview({
|
|
887
|
+
leaderboard: "xp",
|
|
888
|
+
score: 123456,
|
|
889
|
+
});
|
|
890
|
+
|
|
891
|
+
// Handle the result
|
|
892
|
+
console.log(result);
|
|
893
|
+
}
|
|
894
|
+
|
|
895
|
+
run();
|
|
896
|
+
```
|
|
897
|
+
|
|
898
|
+
### Standalone function
|
|
899
|
+
|
|
900
|
+
The standalone function version of this method:
|
|
901
|
+
|
|
902
|
+
```typescript
|
|
903
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
904
|
+
import { accountAccountV1LeaderboardPreview } from "@steamsets/client-ts/funcs/accountAccountV1LeaderboardPreview.js";
|
|
905
|
+
|
|
906
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
907
|
+
// You can create one instance of it to use across an application.
|
|
908
|
+
const steamSets = new SteamSetsCore({
|
|
909
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
910
|
+
});
|
|
911
|
+
|
|
912
|
+
async function run() {
|
|
913
|
+
const res = await accountAccountV1LeaderboardPreview(steamSets, {
|
|
914
|
+
leaderboard: "xp",
|
|
915
|
+
score: 123456,
|
|
916
|
+
});
|
|
917
|
+
|
|
918
|
+
if (!res.ok) {
|
|
919
|
+
throw res.error;
|
|
920
|
+
}
|
|
921
|
+
|
|
922
|
+
const { value: result } = res;
|
|
923
|
+
|
|
924
|
+
// Handle the result
|
|
925
|
+
console.log(result);
|
|
926
|
+
}
|
|
927
|
+
|
|
928
|
+
run();
|
|
929
|
+
```
|
|
930
|
+
|
|
931
|
+
### Parameters
|
|
932
|
+
|
|
933
|
+
| Parameter | Type | Required | Description |
|
|
934
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
935
|
+
| `request` | [components.V1AccountLeaderboardPreviewRequestBody](../../models/components/v1accountleaderboardpreviewrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
936
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
937
|
+
| `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. |
|
|
938
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
939
|
+
|
|
940
|
+
### Response
|
|
941
|
+
|
|
942
|
+
**Promise\<[operations.AccountV1LeaderboardPreviewResponse](../../models/operations/accountv1leaderboardpreviewresponse.md)\>**
|
|
943
|
+
|
|
944
|
+
### Errors
|
|
945
|
+
|
|
946
|
+
| Error Object | Status Code | Content Type |
|
|
947
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
948
|
+
| errors.ErrorModel | 404,422,500 | application/problem+json |
|
|
949
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
950
|
+
|
|
951
|
+
|
|
870
952
|
## accountV1SessionGet
|
|
871
953
|
|
|
872
954
|
Gets all session data
|
|
@@ -1186,6 +1268,84 @@ run();
|
|
|
1186
1268
|
| errors.SDKError | 4xx-5xx | */* |
|
|
1187
1269
|
|
|
1188
1270
|
|
|
1271
|
+
## accountV1Queue
|
|
1272
|
+
|
|
1273
|
+
Queue an account for processing
|
|
1274
|
+
|
|
1275
|
+
### Example Usage
|
|
1276
|
+
|
|
1277
|
+
```typescript
|
|
1278
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
1279
|
+
|
|
1280
|
+
const steamSets = new SteamSets({
|
|
1281
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1282
|
+
});
|
|
1283
|
+
|
|
1284
|
+
async function run() {
|
|
1285
|
+
const result = await steamSets.account.accountV1Queue({
|
|
1286
|
+
id: {},
|
|
1287
|
+
});
|
|
1288
|
+
|
|
1289
|
+
// Handle the result
|
|
1290
|
+
console.log(result);
|
|
1291
|
+
}
|
|
1292
|
+
|
|
1293
|
+
run();
|
|
1294
|
+
```
|
|
1295
|
+
|
|
1296
|
+
### Standalone function
|
|
1297
|
+
|
|
1298
|
+
The standalone function version of this method:
|
|
1299
|
+
|
|
1300
|
+
```typescript
|
|
1301
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1302
|
+
import { accountAccountV1Queue } from "@steamsets/client-ts/funcs/accountAccountV1Queue.js";
|
|
1303
|
+
|
|
1304
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1305
|
+
// You can create one instance of it to use across an application.
|
|
1306
|
+
const steamSets = new SteamSetsCore({
|
|
1307
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1308
|
+
});
|
|
1309
|
+
|
|
1310
|
+
async function run() {
|
|
1311
|
+
const res = await accountAccountV1Queue(steamSets, {
|
|
1312
|
+
id: {},
|
|
1313
|
+
});
|
|
1314
|
+
|
|
1315
|
+
if (!res.ok) {
|
|
1316
|
+
throw res.error;
|
|
1317
|
+
}
|
|
1318
|
+
|
|
1319
|
+
const { value: result } = res;
|
|
1320
|
+
|
|
1321
|
+
// Handle the result
|
|
1322
|
+
console.log(result);
|
|
1323
|
+
}
|
|
1324
|
+
|
|
1325
|
+
run();
|
|
1326
|
+
```
|
|
1327
|
+
|
|
1328
|
+
### Parameters
|
|
1329
|
+
|
|
1330
|
+
| Parameter | Type | Required | Description |
|
|
1331
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1332
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1333
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1334
|
+
| `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. |
|
|
1335
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1336
|
+
|
|
1337
|
+
### Response
|
|
1338
|
+
|
|
1339
|
+
**Promise\<[operations.AccountV1QueueResponse](../../models/operations/accountv1queueresponse.md)\>**
|
|
1340
|
+
|
|
1341
|
+
### Errors
|
|
1342
|
+
|
|
1343
|
+
| Error Object | Status Code | Content Type |
|
|
1344
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
1345
|
+
| errors.ErrorModel | 400,422,429,500 | application/problem+json |
|
|
1346
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
1347
|
+
|
|
1348
|
+
|
|
1189
1349
|
## accountV1SettingsSendEmailVerification
|
|
1190
1350
|
|
|
1191
1351
|
Resend the verification code for an email
|
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
|
|
|
@@ -88,7 +88,7 @@ run();
|
|
|
88
88
|
| errors.SDKError | 4xx-5xx | */* |
|
|
89
89
|
|
|
90
90
|
|
|
91
|
-
##
|
|
91
|
+
## appV1Queue
|
|
92
92
|
|
|
93
93
|
Queue a app for processing
|
|
94
94
|
|
|
@@ -102,7 +102,7 @@ const steamSets = new SteamSets({
|
|
|
102
102
|
});
|
|
103
103
|
|
|
104
104
|
async function run() {
|
|
105
|
-
const result = await steamSets.app.
|
|
105
|
+
const result = await steamSets.app.appV1Queue({
|
|
106
106
|
id: 730,
|
|
107
107
|
});
|
|
108
108
|
|
|
@@ -119,7 +119,7 @@ The standalone function version of this method:
|
|
|
119
119
|
|
|
120
120
|
```typescript
|
|
121
121
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
122
|
-
import {
|
|
122
|
+
import { appAppV1Queue } from "@steamsets/client-ts/funcs/appAppV1Queue.js";
|
|
123
123
|
|
|
124
124
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
125
125
|
// You can create one instance of it to use across an application.
|
|
@@ -128,7 +128,7 @@ const steamSets = new SteamSetsCore({
|
|
|
128
128
|
});
|
|
129
129
|
|
|
130
130
|
async function run() {
|
|
131
|
-
const res = await
|
|
131
|
+
const res = await appAppV1Queue(steamSets, {
|
|
132
132
|
id: 730,
|
|
133
133
|
});
|
|
134
134
|
|
|
@@ -156,7 +156,7 @@ run();
|
|
|
156
156
|
|
|
157
157
|
### Response
|
|
158
158
|
|
|
159
|
-
**Promise\<[operations.
|
|
159
|
+
**Promise\<[operations.AppV1QueueResponse](../../models/operations/appv1queueresponse.md)\>**
|
|
160
160
|
|
|
161
161
|
### Errors
|
|
162
162
|
|
package/docs/sdks/data/README.md
CHANGED
|
@@ -14,7 +14,8 @@ This is actual data seen by others then yourself
|
|
|
14
14
|
* [accountV1GetInfo](#accountv1getinfo) - Get Account Info
|
|
15
15
|
* [accountV1GetLeaderboardHistory](#accountv1getleaderboardhistory) - Get Account Leaderboard History
|
|
16
16
|
* [accountV1GetStaff](#accountv1getstaff) - Get Staff Members and their info
|
|
17
|
-
* [accountV1Queue](#accountv1queue) - Queue
|
|
17
|
+
* [accountV1Queue](#accountv1queue) - Queue an account for processing
|
|
18
|
+
* [appV1Queue](#appv1queue) - Queue a app for processing
|
|
18
19
|
|
|
19
20
|
## accountV1GetApps
|
|
20
21
|
|
|
@@ -535,7 +536,7 @@ run();
|
|
|
535
536
|
|
|
536
537
|
## accountV1Queue
|
|
537
538
|
|
|
538
|
-
Queue
|
|
539
|
+
Queue an account for processing
|
|
539
540
|
|
|
540
541
|
### Example Usage
|
|
541
542
|
|
|
@@ -548,7 +549,7 @@ const steamSets = new SteamSets({
|
|
|
548
549
|
|
|
549
550
|
async function run() {
|
|
550
551
|
const result = await steamSets.data.accountV1Queue({
|
|
551
|
-
id:
|
|
552
|
+
id: {},
|
|
552
553
|
});
|
|
553
554
|
|
|
554
555
|
// Handle the result
|
|
@@ -574,6 +575,84 @@ const steamSets = new SteamSetsCore({
|
|
|
574
575
|
|
|
575
576
|
async function run() {
|
|
576
577
|
const res = await dataAccountV1Queue(steamSets, {
|
|
578
|
+
id: {},
|
|
579
|
+
});
|
|
580
|
+
|
|
581
|
+
if (!res.ok) {
|
|
582
|
+
throw res.error;
|
|
583
|
+
}
|
|
584
|
+
|
|
585
|
+
const { value: result } = res;
|
|
586
|
+
|
|
587
|
+
// Handle the result
|
|
588
|
+
console.log(result);
|
|
589
|
+
}
|
|
590
|
+
|
|
591
|
+
run();
|
|
592
|
+
```
|
|
593
|
+
|
|
594
|
+
### Parameters
|
|
595
|
+
|
|
596
|
+
| Parameter | Type | Required | Description |
|
|
597
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
598
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
599
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
600
|
+
| `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. |
|
|
601
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
602
|
+
|
|
603
|
+
### Response
|
|
604
|
+
|
|
605
|
+
**Promise\<[operations.AccountV1QueueResponse](../../models/operations/accountv1queueresponse.md)\>**
|
|
606
|
+
|
|
607
|
+
### Errors
|
|
608
|
+
|
|
609
|
+
| Error Object | Status Code | Content Type |
|
|
610
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
611
|
+
| errors.ErrorModel | 400,422,429,500 | application/problem+json |
|
|
612
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
## appV1Queue
|
|
616
|
+
|
|
617
|
+
Queue a app for processing
|
|
618
|
+
|
|
619
|
+
### Example Usage
|
|
620
|
+
|
|
621
|
+
```typescript
|
|
622
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
623
|
+
|
|
624
|
+
const steamSets = new SteamSets({
|
|
625
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
626
|
+
});
|
|
627
|
+
|
|
628
|
+
async function run() {
|
|
629
|
+
const result = await steamSets.data.appV1Queue({
|
|
630
|
+
id: 730,
|
|
631
|
+
});
|
|
632
|
+
|
|
633
|
+
// Handle the result
|
|
634
|
+
console.log(result);
|
|
635
|
+
}
|
|
636
|
+
|
|
637
|
+
run();
|
|
638
|
+
```
|
|
639
|
+
|
|
640
|
+
### Standalone function
|
|
641
|
+
|
|
642
|
+
The standalone function version of this method:
|
|
643
|
+
|
|
644
|
+
```typescript
|
|
645
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
646
|
+
import { dataAppV1Queue } from "@steamsets/client-ts/funcs/dataAppV1Queue.js";
|
|
647
|
+
|
|
648
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
649
|
+
// You can create one instance of it to use across an application.
|
|
650
|
+
const steamSets = new SteamSetsCore({
|
|
651
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
652
|
+
});
|
|
653
|
+
|
|
654
|
+
async function run() {
|
|
655
|
+
const res = await dataAppV1Queue(steamSets, {
|
|
577
656
|
id: 730,
|
|
578
657
|
});
|
|
579
658
|
|
|
@@ -601,7 +680,7 @@ run();
|
|
|
601
680
|
|
|
602
681
|
### Response
|
|
603
682
|
|
|
604
|
-
**Promise\<[operations.
|
|
683
|
+
**Promise\<[operations.AppV1QueueResponse](../../models/operations/appv1queueresponse.md)\>**
|
|
605
684
|
|
|
606
685
|
### Errors
|
|
607
686
|
|
|
@@ -5,8 +5,89 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
+
* [accountV1LeaderboardPreview](#accountv1leaderboardpreview) - Preview what a given score would result in
|
|
8
9
|
* [leaderboardV1GetAccount](#leaderboardv1getaccount) - Get an leaderboard for accounts
|
|
9
10
|
|
|
11
|
+
## accountV1LeaderboardPreview
|
|
12
|
+
|
|
13
|
+
Preview what a given score would result in
|
|
14
|
+
|
|
15
|
+
### Example Usage
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
19
|
+
|
|
20
|
+
const steamSets = new SteamSets({
|
|
21
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
async function run() {
|
|
25
|
+
const result = await steamSets.leaderboard.accountV1LeaderboardPreview({
|
|
26
|
+
leaderboard: "xp",
|
|
27
|
+
score: 123456,
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
// Handle the result
|
|
31
|
+
console.log(result);
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
run();
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Standalone function
|
|
38
|
+
|
|
39
|
+
The standalone function version of this method:
|
|
40
|
+
|
|
41
|
+
```typescript
|
|
42
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
43
|
+
import { leaderboardAccountV1LeaderboardPreview } from "@steamsets/client-ts/funcs/leaderboardAccountV1LeaderboardPreview.js";
|
|
44
|
+
|
|
45
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
46
|
+
// You can create one instance of it to use across an application.
|
|
47
|
+
const steamSets = new SteamSetsCore({
|
|
48
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
async function run() {
|
|
52
|
+
const res = await leaderboardAccountV1LeaderboardPreview(steamSets, {
|
|
53
|
+
leaderboard: "xp",
|
|
54
|
+
score: 123456,
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
if (!res.ok) {
|
|
58
|
+
throw res.error;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
const { value: result } = res;
|
|
62
|
+
|
|
63
|
+
// Handle the result
|
|
64
|
+
console.log(result);
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
run();
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Parameters
|
|
71
|
+
|
|
72
|
+
| Parameter | Type | Required | Description |
|
|
73
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
74
|
+
| `request` | [components.V1AccountLeaderboardPreviewRequestBody](../../models/components/v1accountleaderboardpreviewrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
75
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
76
|
+
| `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. |
|
|
77
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
78
|
+
|
|
79
|
+
### Response
|
|
80
|
+
|
|
81
|
+
**Promise\<[operations.AccountV1LeaderboardPreviewResponse](../../models/operations/accountv1leaderboardpreviewresponse.md)\>**
|
|
82
|
+
|
|
83
|
+
### Errors
|
|
84
|
+
|
|
85
|
+
| Error Object | Status Code | Content Type |
|
|
86
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
87
|
+
| errors.ErrorModel | 404,422,500 | application/problem+json |
|
|
88
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
89
|
+
|
|
90
|
+
|
|
10
91
|
## leaderboardV1GetAccount
|
|
11
92
|
|
|
12
93
|
Get an leaderboard for accounts
|