@steamsets/client-ts 0.5.0 → 0.5.1
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 +63 -9
- package/docs/sdks/account/README.md +225 -76
- package/docs/sdks/data/README.md +315 -0
- package/docs/sdks/location/README.md +80 -0
- package/docs/sdks/public/README.md +241 -0
- package/docs/sdks/session/README.md +62 -62
- package/funcs/accountAccountV1GetApps.d.ts.map +1 -1
- package/funcs/accountAccountV1GetApps.js +4 -0
- package/funcs/accountAccountV1GetApps.js.map +1 -1
- package/funcs/accountAccountV1GetBadges.d.ts.map +1 -1
- package/funcs/accountAccountV1GetBadges.js +4 -0
- package/funcs/accountAccountV1GetBadges.js.map +1 -1
- package/funcs/accountAccountV1GetInfo.d.ts +14 -0
- package/funcs/accountAccountV1GetInfo.d.ts.map +1 -0
- package/funcs/accountAccountV1GetInfo.js +96 -0
- package/funcs/accountAccountV1GetInfo.js.map +1 -0
- package/funcs/accountAccountV1GetStaff.d.ts +13 -0
- package/funcs/accountAccountV1GetStaff.d.ts.map +1 -0
- package/funcs/accountAccountV1GetStaff.js +86 -0
- package/funcs/accountAccountV1GetStaff.js.map +1 -0
- package/funcs/accountAccountV1SessionCreate.js +1 -1
- package/funcs/accountAccountV1SessionLogin.js +2 -2
- package/funcs/accountAccountV1SessionLogin.js.map +1 -1
- package/funcs/dataAccountV1GetApps.d.ts +13 -0
- package/funcs/dataAccountV1GetApps.d.ts.map +1 -0
- package/funcs/dataAccountV1GetApps.js +105 -0
- package/funcs/dataAccountV1GetApps.js.map +1 -0
- package/funcs/dataAccountV1GetBadges.d.ts +13 -0
- package/funcs/dataAccountV1GetBadges.d.ts.map +1 -0
- package/funcs/dataAccountV1GetBadges.js +105 -0
- package/funcs/dataAccountV1GetBadges.js.map +1 -0
- package/funcs/dataAccountV1GetInfo.d.ts +14 -0
- package/funcs/dataAccountV1GetInfo.d.ts.map +1 -0
- package/funcs/dataAccountV1GetInfo.js +96 -0
- package/funcs/dataAccountV1GetInfo.js.map +1 -0
- package/funcs/dataAccountV1GetStaff.d.ts +13 -0
- package/funcs/dataAccountV1GetStaff.d.ts.map +1 -0
- package/funcs/dataAccountV1GetStaff.js +86 -0
- package/funcs/dataAccountV1GetStaff.js.map +1 -0
- package/funcs/locationLocation.d.ts +16 -0
- package/funcs/locationLocation.d.ts.map +1 -0
- package/funcs/locationLocation.js +87 -0
- package/funcs/locationLocation.js.map +1 -0
- package/funcs/publicAccountV1GetApps.d.ts +13 -0
- package/funcs/publicAccountV1GetApps.d.ts.map +1 -0
- package/funcs/publicAccountV1GetApps.js +105 -0
- package/funcs/publicAccountV1GetApps.js.map +1 -0
- package/funcs/publicAccountV1GetBadges.d.ts +13 -0
- package/funcs/publicAccountV1GetBadges.d.ts.map +1 -0
- package/funcs/publicAccountV1GetBadges.js +105 -0
- package/funcs/publicAccountV1GetBadges.js.map +1 -0
- package/funcs/publicAccountV1GetInfo.d.ts +14 -0
- package/funcs/publicAccountV1GetInfo.d.ts.map +1 -0
- package/funcs/publicAccountV1GetInfo.js +96 -0
- package/funcs/publicAccountV1GetInfo.js.map +1 -0
- package/funcs/sessionAccountV1SessionCreate.js +1 -1
- package/funcs/sessionAccountV1SessionLogin.js +2 -2
- package/funcs/sessionAccountV1SessionLogin.js.map +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/security.d.ts +6 -1
- package/lib/security.d.ts.map +1 -1
- package/lib/security.js +5 -0
- package/lib/security.js.map +1 -1
- package/models/components/accountinfobody.d.ts +379 -0
- package/models/components/accountinfobody.d.ts.map +1 -0
- package/models/components/accountinfobody.js +254 -0
- package/models/components/accountinfobody.js.map +1 -0
- package/models/components/bestleaderboardrank.d.ts +110 -0
- package/models/components/bestleaderboardrank.d.ts.map +1 -0
- package/models/components/bestleaderboardrank.js +89 -0
- package/models/components/bestleaderboardrank.js.map +1 -0
- package/models/components/city.d.ts +28 -0
- package/models/components/city.d.ts.map +1 -0
- package/models/components/city.js +50 -0
- package/models/components/city.js.map +1 -0
- package/models/components/country.d.ts +43 -0
- package/models/components/country.d.ts.map +1 -0
- package/models/components/country.js +55 -0
- package/models/components/country.js.map +1 -0
- package/models/components/index.d.ts +9 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +9 -0
- package/models/components/index.js.map +1 -1
- package/models/components/leaderboardaccount.d.ts +196 -0
- package/models/components/leaderboardaccount.d.ts.map +1 -0
- package/models/components/leaderboardaccount.js +128 -0
- package/models/components/leaderboardaccount.js.map +1 -0
- package/models/components/leaderboardbadgeinfo.d.ts +33 -0
- package/models/components/leaderboardbadgeinfo.d.ts.map +1 -0
- package/models/components/leaderboardbadgeinfo.js +55 -0
- package/models/components/leaderboardbadgeinfo.js.map +1 -0
- package/models/components/location.d.ts +38 -0
- package/models/components/location.d.ts.map +1 -0
- package/models/components/location.js +54 -0
- package/models/components/location.js.map +1 -0
- package/models/components/region.d.ts +38 -0
- package/models/components/region.d.ts.map +1 -0
- package/models/components/region.js +53 -0
- package/models/components/region.js.map +1 -0
- package/models/components/role.d.ts +2 -2
- package/models/components/role.d.ts.map +1 -1
- package/models/components/role.js +4 -17
- package/models/components/role.js.map +1 -1
- package/models/components/state.d.ts +43 -0
- package/models/components/state.d.ts.map +1 -0
- package/models/components/state.js +55 -0
- package/models/components/state.js.map +1 -0
- package/models/errors/errormodel.d.ts +5 -5
- package/models/errors/errormodel.d.ts.map +1 -1
- package/models/errors/errormodel.js +4 -2
- package/models/errors/errormodel.js.map +1 -1
- package/models/operations/accountv1getapps.d.ts +2 -0
- package/models/operations/accountv1getapps.d.ts.map +1 -1
- package/models/operations/accountv1getapps.js +4 -0
- package/models/operations/accountv1getapps.js.map +1 -1
- package/models/operations/accountv1getbadges.d.ts +2 -0
- package/models/operations/accountv1getbadges.d.ts.map +1 -1
- package/models/operations/accountv1getbadges.js +4 -0
- package/models/operations/accountv1getbadges.js.map +1 -1
- package/models/operations/accountv1getinfo.d.ts +31 -0
- package/models/operations/accountv1getinfo.d.ts.map +1 -0
- package/models/operations/accountv1getinfo.js +68 -0
- package/models/operations/accountv1getinfo.js.map +1 -0
- package/models/operations/accountv1getstaff.d.ts +31 -0
- package/models/operations/accountv1getstaff.d.ts.map +1 -0
- package/models/operations/accountv1getstaff.js +72 -0
- package/models/operations/accountv1getstaff.js.map +1 -0
- package/models/operations/index.d.ts +3 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +3 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/location.d.ts +31 -0
- package/models/operations/location.d.ts.map +1 -0
- package/models/operations/location.js +68 -0
- package/models/operations/location.js.map +1 -0
- package/package.json +1 -1
- package/sdk/account.d.ts +12 -4
- package/sdk/account.d.ts.map +1 -1
- package/sdk/account.js +20 -6
- package/sdk/account.js.map +1 -1
- package/sdk/data.d.ts +22 -0
- package/sdk/data.d.ts.map +1 -0
- package/sdk/data.js +40 -0
- package/sdk/data.js.map +1 -0
- package/sdk/location.d.ts +12 -0
- package/sdk/location.d.ts.map +1 -0
- package/sdk/location.js +22 -0
- package/sdk/location.js.map +1 -0
- package/sdk/public.d.ts +18 -0
- package/sdk/public.d.ts.map +1 -0
- package/sdk/public.js +33 -0
- package/sdk/public.js.map +1 -0
- package/sdk/sdk.d.ts +11 -2
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +17 -2
- package/sdk/sdk.js.map +1 -1
- package/sdk/session.d.ts +4 -4
- package/sdk/session.d.ts.map +1 -1
- package/sdk/session.js +6 -6
- package/sdk/session.js.map +1 -1
- package/src/funcs/accountAccountV1GetApps.ts +4 -0
- package/src/funcs/accountAccountV1GetBadges.ts +4 -0
- package/src/funcs/accountAccountV1GetInfo.ts +130 -0
- package/src/funcs/accountAccountV1GetStaff.ts +113 -0
- package/src/funcs/accountAccountV1SessionCreate.ts +1 -1
- package/src/funcs/accountAccountV1SessionLogin.ts +2 -2
- package/src/funcs/dataAccountV1GetApps.ts +139 -0
- package/src/funcs/dataAccountV1GetBadges.ts +139 -0
- package/src/funcs/dataAccountV1GetInfo.ts +130 -0
- package/src/funcs/dataAccountV1GetStaff.ts +113 -0
- package/src/funcs/locationLocation.ts +114 -0
- package/src/funcs/publicAccountV1GetApps.ts +139 -0
- package/src/funcs/publicAccountV1GetBadges.ts +139 -0
- package/src/funcs/publicAccountV1GetInfo.ts +130 -0
- package/src/funcs/sessionAccountV1SessionCreate.ts +1 -1
- package/src/funcs/sessionAccountV1SessionLogin.ts +2 -2
- package/src/lib/config.ts +3 -3
- package/src/lib/security.ts +12 -1
- package/src/models/components/accountinfobody.ts +532 -0
- package/src/models/components/bestleaderboardrank.ts +102 -0
- package/src/models/components/city.ts +40 -0
- package/src/models/components/country.ts +55 -0
- package/src/models/components/index.ts +9 -0
- package/src/models/components/leaderboardaccount.ts +301 -0
- package/src/models/components/leaderboardbadgeinfo.ts +58 -0
- package/src/models/components/location.ts +55 -0
- package/src/models/components/region.ts +53 -0
- package/src/models/components/role.ts +14 -27
- package/src/models/components/state.ts +55 -0
- package/src/models/errors/errormodel.ts +8 -6
- package/src/models/operations/accountv1getapps.ts +6 -0
- package/src/models/operations/accountv1getbadges.ts +6 -0
- package/src/models/operations/accountv1getinfo.ts +68 -0
- package/src/models/operations/accountv1getstaff.ts +72 -0
- package/src/models/operations/index.ts +3 -0
- package/src/models/operations/location.ts +64 -0
- package/src/sdk/account.ts +31 -10
- package/src/sdk/data.ts +53 -0
- package/src/sdk/location.ts +20 -0
- package/src/sdk/public.ts +43 -0
- package/src/sdk/sdk.ts +21 -3
- package/src/sdk/session.ts +10 -10
package/README.md
CHANGED
|
@@ -19,6 +19,8 @@ It has been generated successfully based on your OpenAPI spec. However, it is no
|
|
|
19
19
|
<!-- Start SDK Installation [installation] -->
|
|
20
20
|
## SDK Installation
|
|
21
21
|
|
|
22
|
+
The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
|
|
23
|
+
|
|
22
24
|
### NPM
|
|
23
25
|
|
|
24
26
|
```bash
|
|
@@ -80,14 +82,17 @@ run();
|
|
|
80
82
|
### [account](docs/sdks/account/README.md)
|
|
81
83
|
|
|
82
84
|
* [accountV1ConnectionConnect](docs/sdks/account/README.md#accountv1connectionconnect) - Connect a new Social Provider
|
|
85
|
+
* [accountV1SessionCreate](docs/sdks/account/README.md#accountv1sessioncreate) - Create a new session for non logged in users
|
|
83
86
|
* [accountV1ConnectionDeleteConnection](docs/sdks/account/README.md#accountv1connectiondeleteconnection) - Remove a connection
|
|
84
87
|
* [accountV1SettingsDeleteImages](docs/sdks/account/README.md#accountv1settingsdeleteimages) - Delete mulitple imagest
|
|
85
88
|
* [accountV1SessionDelete](docs/sdks/account/README.md#accountv1sessiondelete) - Deletes a session, can also be used to logout
|
|
86
89
|
* [accountV1SettingsGenerateApiKey](docs/sdks/account/README.md#accountv1settingsgenerateapikey) - Generate a new API key for the account
|
|
87
90
|
* [accountV1GetApps](docs/sdks/account/README.md#accountv1getapps) - Get Account Apps
|
|
88
91
|
* [accountV1GetBadges](docs/sdks/account/README.md#accountv1getbadges) - Get Account Badges
|
|
92
|
+
* [accountV1GetInfo](docs/sdks/account/README.md#accountv1getinfo) - Get Account Info
|
|
89
93
|
* [accountV1SessionGet](docs/sdks/account/README.md#accountv1sessionget) - Gets all session data
|
|
90
94
|
* [accountV1SettingsGet](docs/sdks/account/README.md#accountv1settingsget) - Gets all settings for the account
|
|
95
|
+
* [accountV1GetStaff](docs/sdks/account/README.md#accountv1getstaff) - Get Staff Members and their info
|
|
91
96
|
* [accountV1SessionLogin](docs/sdks/account/README.md#accountv1sessionlogin) - Logs a user in and creates a new session
|
|
92
97
|
* [accountV1SettingsSendEmailVerification](docs/sdks/account/README.md#accountv1settingssendemailverification) - Resend the verification code for an email
|
|
93
98
|
* [accountV1ConnectionUpdateConnection](docs/sdks/account/README.md#accountv1connectionupdateconnection) - Make a connection visible/invisible
|
|
@@ -96,7 +101,6 @@ run();
|
|
|
96
101
|
* [accountV1SettingsUploadImages](docs/sdks/account/README.md#accountv1settingsuploadimages) - Multi Upload Endpoint for images
|
|
97
102
|
* [accountV1ConnectionVerifyConnection](docs/sdks/account/README.md#accountv1connectionverifyconnection) - Verify a domain connection only atm
|
|
98
103
|
* [accountV1SettingsVerfyEmail](docs/sdks/account/README.md#accountv1settingsverfyemail) - Verify the email by passing in the code the user should've gotten
|
|
99
|
-
* [accountV1SessionCreate](docs/sdks/account/README.md#accountv1sessioncreate) - Create a new session for non logged in users
|
|
100
104
|
|
|
101
105
|
### [connection](docs/sdks/connection/README.md)
|
|
102
106
|
|
|
@@ -105,6 +109,13 @@ run();
|
|
|
105
109
|
* [accountV1ConnectionUpdateConnection](docs/sdks/connection/README.md#accountv1connectionupdateconnection) - Make a connection visible/invisible
|
|
106
110
|
* [accountV1ConnectionVerifyConnection](docs/sdks/connection/README.md#accountv1connectionverifyconnection) - Verify a domain connection only atm
|
|
107
111
|
|
|
112
|
+
### [session](docs/sdks/session/README.md)
|
|
113
|
+
|
|
114
|
+
* [accountV1SessionCreate](docs/sdks/session/README.md#accountv1sessioncreate) - Create a new session for non logged in users
|
|
115
|
+
* [accountV1SessionDelete](docs/sdks/session/README.md#accountv1sessiondelete) - Deletes a session, can also be used to logout
|
|
116
|
+
* [accountV1SessionGet](docs/sdks/session/README.md#accountv1sessionget) - Gets all session data
|
|
117
|
+
* [accountV1SessionLogin](docs/sdks/session/README.md#accountv1sessionlogin) - Logs a user in and creates a new session
|
|
118
|
+
|
|
108
119
|
### [settings](docs/sdks/settings/README.md)
|
|
109
120
|
|
|
110
121
|
* [accountV1SettingsDeleteImages](docs/sdks/settings/README.md#accountv1settingsdeleteimages) - Delete mulitple imagest
|
|
@@ -116,16 +127,26 @@ run();
|
|
|
116
127
|
* [accountV1SettingsUploadImages](docs/sdks/settings/README.md#accountv1settingsuploadimages) - Multi Upload Endpoint for images
|
|
117
128
|
* [accountV1SettingsVerfyEmail](docs/sdks/settings/README.md#accountv1settingsverfyemail) - Verify the email by passing in the code the user should've gotten
|
|
118
129
|
|
|
119
|
-
### [
|
|
130
|
+
### [data](docs/sdks/data/README.md)
|
|
120
131
|
|
|
121
|
-
* [
|
|
122
|
-
* [
|
|
123
|
-
* [
|
|
124
|
-
* [
|
|
132
|
+
* [accountV1GetApps](docs/sdks/data/README.md#accountv1getapps) - Get Account Apps
|
|
133
|
+
* [accountV1GetBadges](docs/sdks/data/README.md#accountv1getbadges) - Get Account Badges
|
|
134
|
+
* [accountV1GetInfo](docs/sdks/data/README.md#accountv1getinfo) - Get Account Info
|
|
135
|
+
* [accountV1GetStaff](docs/sdks/data/README.md#accountv1getstaff) - Get Staff Members and their info
|
|
136
|
+
|
|
137
|
+
### [public](docs/sdks/public/README.md)
|
|
138
|
+
|
|
139
|
+
* [accountV1GetApps](docs/sdks/public/README.md#accountv1getapps) - Get Account Apps
|
|
140
|
+
* [accountV1GetBadges](docs/sdks/public/README.md#accountv1getbadges) - Get Account Badges
|
|
141
|
+
* [accountV1GetInfo](docs/sdks/public/README.md#accountv1getinfo) - Get Account Info
|
|
125
142
|
|
|
126
143
|
### [liveness](docs/sdks/liveness/README.md)
|
|
127
144
|
|
|
128
145
|
* [liveness](docs/sdks/liveness/README.md#liveness) - Liveness check
|
|
146
|
+
|
|
147
|
+
### [location](docs/sdks/location/README.md)
|
|
148
|
+
|
|
149
|
+
* [location](docs/sdks/location/README.md#location) - Location List
|
|
129
150
|
<!-- End Available Resources and Operations [operations] -->
|
|
130
151
|
|
|
131
152
|
<!-- Start Retries [retries] -->
|
|
@@ -217,7 +238,7 @@ Validation errors can also occur when either method arguments or data returned f
|
|
|
217
238
|
|
|
218
239
|
```typescript
|
|
219
240
|
import { SteamSets } from "@steamsets/client-ts";
|
|
220
|
-
import { SDKValidationError } from "@steamsets/client-ts/models/errors";
|
|
241
|
+
import { ErrorModel, SDKValidationError } from "@steamsets/client-ts/models/errors";
|
|
221
242
|
|
|
222
243
|
const steamSets = new SteamSets({
|
|
223
244
|
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
@@ -239,8 +260,9 @@ async function run() {
|
|
|
239
260
|
console.error(err.rawValue);
|
|
240
261
|
return;
|
|
241
262
|
}
|
|
242
|
-
case err instanceof
|
|
243
|
-
|
|
263
|
+
case err instanceof ErrorModel: {
|
|
264
|
+
// Handle err.data$: ErrorModelData
|
|
265
|
+
console.error(err);
|
|
244
266
|
return;
|
|
245
267
|
}
|
|
246
268
|
default: {
|
|
@@ -436,6 +458,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
436
458
|
- [accountAccountV1ConnectionVerifyConnection](docs/sdks/account/README.md#accountv1connectionverifyconnection)
|
|
437
459
|
- [accountAccountV1GetApps](docs/sdks/account/README.md#accountv1getapps)
|
|
438
460
|
- [accountAccountV1GetBadges](docs/sdks/account/README.md#accountv1getbadges)
|
|
461
|
+
- [accountAccountV1GetInfo](docs/sdks/account/README.md#accountv1getinfo)
|
|
462
|
+
- [accountAccountV1GetStaff](docs/sdks/account/README.md#accountv1getstaff)
|
|
439
463
|
- [accountAccountV1SessionCreate](docs/sdks/account/README.md#accountv1sessioncreate)
|
|
440
464
|
- [accountAccountV1SessionDelete](docs/sdks/account/README.md#accountv1sessiondelete)
|
|
441
465
|
- [accountAccountV1SessionGet](docs/sdks/account/README.md#accountv1sessionget)
|
|
@@ -452,7 +476,15 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
452
476
|
- [connectionAccountV1ConnectionDeleteConnection](docs/sdks/connection/README.md#accountv1connectiondeleteconnection)
|
|
453
477
|
- [connectionAccountV1ConnectionUpdateConnection](docs/sdks/connection/README.md#accountv1connectionupdateconnection)
|
|
454
478
|
- [connectionAccountV1ConnectionVerifyConnection](docs/sdks/connection/README.md#accountv1connectionverifyconnection)
|
|
479
|
+
- [dataAccountV1GetApps](docs/sdks/data/README.md#accountv1getapps)
|
|
480
|
+
- [dataAccountV1GetBadges](docs/sdks/data/README.md#accountv1getbadges)
|
|
481
|
+
- [dataAccountV1GetInfo](docs/sdks/data/README.md#accountv1getinfo)
|
|
482
|
+
- [dataAccountV1GetStaff](docs/sdks/data/README.md#accountv1getstaff)
|
|
455
483
|
- [livenessLiveness](docs/sdks/liveness/README.md#liveness)
|
|
484
|
+
- [locationLocation](docs/sdks/location/README.md#location)
|
|
485
|
+
- [publicAccountV1GetApps](docs/sdks/public/README.md#accountv1getapps)
|
|
486
|
+
- [publicAccountV1GetBadges](docs/sdks/public/README.md#accountv1getbadges)
|
|
487
|
+
- [publicAccountV1GetInfo](docs/sdks/public/README.md#accountv1getinfo)
|
|
456
488
|
- [sessionAccountV1SessionCreate](docs/sdks/session/README.md#accountv1sessioncreate)
|
|
457
489
|
- [sessionAccountV1SessionDelete](docs/sdks/session/README.md#accountv1sessiondelete)
|
|
458
490
|
- [sessionAccountV1SessionGet](docs/sdks/session/README.md#accountv1sessionget)
|
|
@@ -487,6 +519,28 @@ const sdk = new SteamSets({ debugLogger: console });
|
|
|
487
519
|
```
|
|
488
520
|
<!-- End Debugging [debug] -->
|
|
489
521
|
|
|
522
|
+
<!-- Start Summary [summary] -->
|
|
523
|
+
## Summary
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
<!-- End Summary [summary] -->
|
|
527
|
+
|
|
528
|
+
<!-- Start Table of Contents [toc] -->
|
|
529
|
+
## Table of Contents
|
|
530
|
+
|
|
531
|
+
* [SDK Installation](#sdk-installation)
|
|
532
|
+
* [Requirements](#requirements)
|
|
533
|
+
* [SDK Example Usage](#sdk-example-usage)
|
|
534
|
+
* [Available Resources and Operations](#available-resources-and-operations)
|
|
535
|
+
* [Standalone functions](#standalone-functions)
|
|
536
|
+
* [Retries](#retries)
|
|
537
|
+
* [Error Handling](#error-handling)
|
|
538
|
+
* [Server Selection](#server-selection)
|
|
539
|
+
* [Custom HTTP Client](#custom-http-client)
|
|
540
|
+
* [Authentication](#authentication)
|
|
541
|
+
* [Debugging](#debugging)
|
|
542
|
+
<!-- End Table of Contents [toc] -->
|
|
543
|
+
|
|
490
544
|
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
|
491
545
|
|
|
492
546
|
# Development
|
|
@@ -8,14 +8,17 @@ Account related operations
|
|
|
8
8
|
### Available Operations
|
|
9
9
|
|
|
10
10
|
* [accountV1ConnectionConnect](#accountv1connectionconnect) - Connect a new Social Provider
|
|
11
|
+
* [accountV1SessionCreate](#accountv1sessioncreate) - Create a new session for non logged in users
|
|
11
12
|
* [accountV1ConnectionDeleteConnection](#accountv1connectiondeleteconnection) - Remove a connection
|
|
12
13
|
* [accountV1SettingsDeleteImages](#accountv1settingsdeleteimages) - Delete mulitple imagest
|
|
13
14
|
* [accountV1SessionDelete](#accountv1sessiondelete) - Deletes a session, can also be used to logout
|
|
14
15
|
* [accountV1SettingsGenerateApiKey](#accountv1settingsgenerateapikey) - Generate a new API key for the account
|
|
15
16
|
* [accountV1GetApps](#accountv1getapps) - Get Account Apps
|
|
16
17
|
* [accountV1GetBadges](#accountv1getbadges) - Get Account Badges
|
|
18
|
+
* [accountV1GetInfo](#accountv1getinfo) - Get Account Info
|
|
17
19
|
* [accountV1SessionGet](#accountv1sessionget) - Gets all session data
|
|
18
20
|
* [accountV1SettingsGet](#accountv1settingsget) - Gets all settings for the account
|
|
21
|
+
* [accountV1GetStaff](#accountv1getstaff) - Get Staff Members and their info
|
|
19
22
|
* [accountV1SessionLogin](#accountv1sessionlogin) - Logs a user in and creates a new session
|
|
20
23
|
* [accountV1SettingsSendEmailVerification](#accountv1settingssendemailverification) - Resend the verification code for an email
|
|
21
24
|
* [accountV1ConnectionUpdateConnection](#accountv1connectionupdateconnection) - Make a connection visible/invisible
|
|
@@ -24,7 +27,6 @@ Account related operations
|
|
|
24
27
|
* [accountV1SettingsUploadImages](#accountv1settingsuploadimages) - Multi Upload Endpoint for images
|
|
25
28
|
* [accountV1ConnectionVerifyConnection](#accountv1connectionverifyconnection) - Verify a domain connection only atm
|
|
26
29
|
* [accountV1SettingsVerfyEmail](#accountv1settingsverfyemail) - Verify the email by passing in the code the user should've gotten
|
|
27
|
-
* [accountV1SessionCreate](#accountv1sessioncreate) - Create a new session for non logged in users
|
|
28
30
|
|
|
29
31
|
## accountV1ConnectionConnect
|
|
30
32
|
|
|
@@ -106,6 +108,80 @@ run();
|
|
|
106
108
|
| errors.SDKError | 4xx-5xx | */* |
|
|
107
109
|
|
|
108
110
|
|
|
111
|
+
## accountV1SessionCreate
|
|
112
|
+
|
|
113
|
+
Create a new session for non logged in users
|
|
114
|
+
|
|
115
|
+
### Example Usage
|
|
116
|
+
|
|
117
|
+
```typescript
|
|
118
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
119
|
+
|
|
120
|
+
const steamSets = new SteamSets({
|
|
121
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
122
|
+
});
|
|
123
|
+
|
|
124
|
+
async function run() {
|
|
125
|
+
const result = await steamSets.account.accountV1SessionCreate({});
|
|
126
|
+
|
|
127
|
+
// Handle the result
|
|
128
|
+
console.log(result)
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
run();
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### Standalone function
|
|
135
|
+
|
|
136
|
+
The standalone function version of this method:
|
|
137
|
+
|
|
138
|
+
```typescript
|
|
139
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
140
|
+
import { accountAccountV1SessionCreate } from "@steamsets/client-ts/funcs/accountAccountV1SessionCreate.js";
|
|
141
|
+
|
|
142
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
143
|
+
// You can create one instance of it to use across an application.
|
|
144
|
+
const steamSets = new SteamSetsCore({
|
|
145
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
146
|
+
});
|
|
147
|
+
|
|
148
|
+
async function run() {
|
|
149
|
+
const res = await accountAccountV1SessionCreate(steamSets, {});
|
|
150
|
+
|
|
151
|
+
if (!res.ok) {
|
|
152
|
+
throw res.error;
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
const { value: result } = res;
|
|
156
|
+
|
|
157
|
+
// Handle the result
|
|
158
|
+
console.log(result)
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
run();
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### Parameters
|
|
165
|
+
|
|
166
|
+
| Parameter | Type | Required | Description |
|
|
167
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
168
|
+
| `request` | [operations.AccountV1SessionCreateRequest](../../models/operations/accountv1sessioncreaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
169
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
170
|
+
| `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. |
|
|
171
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
172
|
+
|
|
173
|
+
### Response
|
|
174
|
+
|
|
175
|
+
**Promise\<[operations.AccountV1SessionCreateResponse](../../models/operations/accountv1sessioncreateresponse.md)\>**
|
|
176
|
+
|
|
177
|
+
### Errors
|
|
178
|
+
|
|
179
|
+
| Error Object | Status Code | Content Type |
|
|
180
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
181
|
+
| errors.ErrorModel | 422,500 | application/problem+json |
|
|
182
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
183
|
+
|
|
184
|
+
|
|
109
185
|
## accountV1ConnectionDeleteConnection
|
|
110
186
|
|
|
111
187
|
Remove a connection
|
|
@@ -579,6 +655,80 @@ run();
|
|
|
579
655
|
| errors.SDKError | 4xx-5xx | */* |
|
|
580
656
|
|
|
581
657
|
|
|
658
|
+
## accountV1GetInfo
|
|
659
|
+
|
|
660
|
+
Get Account Info
|
|
661
|
+
|
|
662
|
+
### Example Usage
|
|
663
|
+
|
|
664
|
+
```typescript
|
|
665
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
666
|
+
|
|
667
|
+
const steamSets = new SteamSets({
|
|
668
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
669
|
+
});
|
|
670
|
+
|
|
671
|
+
async function run() {
|
|
672
|
+
const result = await steamSets.account.accountV1GetInfo({});
|
|
673
|
+
|
|
674
|
+
// Handle the result
|
|
675
|
+
console.log(result)
|
|
676
|
+
}
|
|
677
|
+
|
|
678
|
+
run();
|
|
679
|
+
```
|
|
680
|
+
|
|
681
|
+
### Standalone function
|
|
682
|
+
|
|
683
|
+
The standalone function version of this method:
|
|
684
|
+
|
|
685
|
+
```typescript
|
|
686
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
687
|
+
import { accountAccountV1GetInfo } from "@steamsets/client-ts/funcs/accountAccountV1GetInfo.js";
|
|
688
|
+
|
|
689
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
690
|
+
// You can create one instance of it to use across an application.
|
|
691
|
+
const steamSets = new SteamSetsCore({
|
|
692
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
693
|
+
});
|
|
694
|
+
|
|
695
|
+
async function run() {
|
|
696
|
+
const res = await accountAccountV1GetInfo(steamSets, {});
|
|
697
|
+
|
|
698
|
+
if (!res.ok) {
|
|
699
|
+
throw res.error;
|
|
700
|
+
}
|
|
701
|
+
|
|
702
|
+
const { value: result } = res;
|
|
703
|
+
|
|
704
|
+
// Handle the result
|
|
705
|
+
console.log(result)
|
|
706
|
+
}
|
|
707
|
+
|
|
708
|
+
run();
|
|
709
|
+
```
|
|
710
|
+
|
|
711
|
+
### Parameters
|
|
712
|
+
|
|
713
|
+
| Parameter | Type | Required | Description |
|
|
714
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
715
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
716
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
717
|
+
| `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. |
|
|
718
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
719
|
+
|
|
720
|
+
### Response
|
|
721
|
+
|
|
722
|
+
**Promise\<[operations.AccountV1GetInfoResponse](../../models/operations/accountv1getinforesponse.md)\>**
|
|
723
|
+
|
|
724
|
+
### Errors
|
|
725
|
+
|
|
726
|
+
| Error Object | Status Code | Content Type |
|
|
727
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
728
|
+
| errors.ErrorModel | 404,422,429,500 | application/problem+json |
|
|
729
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
730
|
+
|
|
731
|
+
|
|
582
732
|
## accountV1SessionGet
|
|
583
733
|
|
|
584
734
|
Gets all session data
|
|
@@ -725,6 +875,79 @@ run();
|
|
|
725
875
|
| errors.SDKError | 4xx-5xx | */* |
|
|
726
876
|
|
|
727
877
|
|
|
878
|
+
## accountV1GetStaff
|
|
879
|
+
|
|
880
|
+
Get Staff Members and their info
|
|
881
|
+
|
|
882
|
+
### Example Usage
|
|
883
|
+
|
|
884
|
+
```typescript
|
|
885
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
886
|
+
|
|
887
|
+
const steamSets = new SteamSets({
|
|
888
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
889
|
+
});
|
|
890
|
+
|
|
891
|
+
async function run() {
|
|
892
|
+
const result = await steamSets.account.accountV1GetStaff();
|
|
893
|
+
|
|
894
|
+
// Handle the result
|
|
895
|
+
console.log(result)
|
|
896
|
+
}
|
|
897
|
+
|
|
898
|
+
run();
|
|
899
|
+
```
|
|
900
|
+
|
|
901
|
+
### Standalone function
|
|
902
|
+
|
|
903
|
+
The standalone function version of this method:
|
|
904
|
+
|
|
905
|
+
```typescript
|
|
906
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
907
|
+
import { accountAccountV1GetStaff } from "@steamsets/client-ts/funcs/accountAccountV1GetStaff.js";
|
|
908
|
+
|
|
909
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
910
|
+
// You can create one instance of it to use across an application.
|
|
911
|
+
const steamSets = new SteamSetsCore({
|
|
912
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
913
|
+
});
|
|
914
|
+
|
|
915
|
+
async function run() {
|
|
916
|
+
const res = await accountAccountV1GetStaff(steamSets);
|
|
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
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
936
|
+
| `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. |
|
|
937
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
938
|
+
|
|
939
|
+
### Response
|
|
940
|
+
|
|
941
|
+
**Promise\<[operations.AccountV1GetStaffResponse](../../models/operations/accountv1getstaffresponse.md)\>**
|
|
942
|
+
|
|
943
|
+
### Errors
|
|
944
|
+
|
|
945
|
+
| Error Object | Status Code | Content Type |
|
|
946
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
947
|
+
| errors.ErrorModel | 404,429,500 | application/problem+json |
|
|
948
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
949
|
+
|
|
950
|
+
|
|
728
951
|
## accountV1SessionLogin
|
|
729
952
|
|
|
730
953
|
Logs a user in and creates a new session
|
|
@@ -821,7 +1044,7 @@ run();
|
|
|
821
1044
|
|
|
822
1045
|
| Error Object | Status Code | Content Type |
|
|
823
1046
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
824
|
-
| errors.ErrorModel | 422,500
|
|
1047
|
+
| errors.ErrorModel | 400,422,429,500 | application/problem+json |
|
|
825
1048
|
| errors.SDKError | 4xx-5xx | */* |
|
|
826
1049
|
|
|
827
1050
|
|
|
@@ -1407,77 +1630,3 @@ run();
|
|
|
1407
1630
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1408
1631
|
| errors.ErrorModel | 404,422,429,500 | application/problem+json |
|
|
1409
1632
|
| errors.SDKError | 4xx-5xx | */* |
|
|
1410
|
-
|
|
1411
|
-
|
|
1412
|
-
## accountV1SessionCreate
|
|
1413
|
-
|
|
1414
|
-
Create a new session for non logged in users
|
|
1415
|
-
|
|
1416
|
-
### Example Usage
|
|
1417
|
-
|
|
1418
|
-
```typescript
|
|
1419
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
1420
|
-
|
|
1421
|
-
const steamSets = new SteamSets({
|
|
1422
|
-
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1423
|
-
});
|
|
1424
|
-
|
|
1425
|
-
async function run() {
|
|
1426
|
-
const result = await steamSets.account.accountV1SessionCreate({});
|
|
1427
|
-
|
|
1428
|
-
// Handle the result
|
|
1429
|
-
console.log(result)
|
|
1430
|
-
}
|
|
1431
|
-
|
|
1432
|
-
run();
|
|
1433
|
-
```
|
|
1434
|
-
|
|
1435
|
-
### Standalone function
|
|
1436
|
-
|
|
1437
|
-
The standalone function version of this method:
|
|
1438
|
-
|
|
1439
|
-
```typescript
|
|
1440
|
-
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1441
|
-
import { accountAccountV1SessionCreate } from "@steamsets/client-ts/funcs/accountAccountV1SessionCreate.js";
|
|
1442
|
-
|
|
1443
|
-
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1444
|
-
// You can create one instance of it to use across an application.
|
|
1445
|
-
const steamSets = new SteamSetsCore({
|
|
1446
|
-
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1447
|
-
});
|
|
1448
|
-
|
|
1449
|
-
async function run() {
|
|
1450
|
-
const res = await accountAccountV1SessionCreate(steamSets, {});
|
|
1451
|
-
|
|
1452
|
-
if (!res.ok) {
|
|
1453
|
-
throw res.error;
|
|
1454
|
-
}
|
|
1455
|
-
|
|
1456
|
-
const { value: result } = res;
|
|
1457
|
-
|
|
1458
|
-
// Handle the result
|
|
1459
|
-
console.log(result)
|
|
1460
|
-
}
|
|
1461
|
-
|
|
1462
|
-
run();
|
|
1463
|
-
```
|
|
1464
|
-
|
|
1465
|
-
### Parameters
|
|
1466
|
-
|
|
1467
|
-
| Parameter | Type | Required | Description |
|
|
1468
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1469
|
-
| `request` | [operations.AccountV1SessionCreateRequest](../../models/operations/accountv1sessioncreaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1470
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1471
|
-
| `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. |
|
|
1472
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1473
|
-
|
|
1474
|
-
### Response
|
|
1475
|
-
|
|
1476
|
-
**Promise\<[operations.AccountV1SessionCreateResponse](../../models/operations/accountv1sessioncreateresponse.md)\>**
|
|
1477
|
-
|
|
1478
|
-
### Errors
|
|
1479
|
-
|
|
1480
|
-
| Error Object | Status Code | Content Type |
|
|
1481
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
1482
|
-
| errors.ErrorModel | 422,500 | application/problem+json |
|
|
1483
|
-
| errors.SDKError | 4xx-5xx | */* |
|