@steamsets/client-ts 0.2.1 → 0.3.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 +32 -9
- package/docs/sdks/account/README.md +432 -4
- package/docs/sdks/connection/README.md +2 -2
- package/docs/sdks/settings/README.md +430 -2
- package/funcs/accountAccountV1SettingsDeleteImages.d.ts +13 -0
- package/funcs/accountAccountV1SettingsDeleteImages.d.ts.map +1 -0
- package/funcs/accountAccountV1SettingsDeleteImages.js +95 -0
- package/funcs/accountAccountV1SettingsDeleteImages.js.map +1 -0
- package/funcs/accountAccountV1SettingsGenerateApiKey.d.ts +13 -0
- package/funcs/accountAccountV1SettingsGenerateApiKey.d.ts.map +1 -0
- package/funcs/accountAccountV1SettingsGenerateApiKey.js +84 -0
- package/funcs/accountAccountV1SettingsGenerateApiKey.js.map +1 -0
- package/funcs/accountAccountV1SettingsSendEmailVerification.d.ts +13 -0
- package/funcs/accountAccountV1SettingsSendEmailVerification.d.ts.map +1 -0
- package/funcs/accountAccountV1SettingsSendEmailVerification.js +99 -0
- package/funcs/accountAccountV1SettingsSendEmailVerification.js.map +1 -0
- package/funcs/accountAccountV1SettingsUpdate.d.ts.map +1 -1
- package/funcs/accountAccountV1SettingsUpdate.js +3 -2
- package/funcs/accountAccountV1SettingsUpdate.js.map +1 -1
- package/funcs/accountAccountV1SettingsUpdateImage.d.ts +13 -0
- package/funcs/accountAccountV1SettingsUpdateImage.d.ts.map +1 -0
- package/funcs/accountAccountV1SettingsUpdateImage.js +95 -0
- package/funcs/accountAccountV1SettingsUpdateImage.js.map +1 -0
- package/funcs/accountAccountV1SettingsVerfyEmail.d.ts +13 -0
- package/funcs/accountAccountV1SettingsVerfyEmail.d.ts.map +1 -0
- package/funcs/accountAccountV1SettingsVerfyEmail.js +95 -0
- package/funcs/accountAccountV1SettingsVerfyEmail.js.map +1 -0
- package/funcs/settingsAccountV1SettingsDeleteImages.d.ts +13 -0
- package/funcs/settingsAccountV1SettingsDeleteImages.d.ts.map +1 -0
- package/funcs/settingsAccountV1SettingsDeleteImages.js +95 -0
- package/funcs/settingsAccountV1SettingsDeleteImages.js.map +1 -0
- package/funcs/settingsAccountV1SettingsGenerateApiKey.d.ts +13 -0
- package/funcs/settingsAccountV1SettingsGenerateApiKey.d.ts.map +1 -0
- package/funcs/settingsAccountV1SettingsGenerateApiKey.js +84 -0
- package/funcs/settingsAccountV1SettingsGenerateApiKey.js.map +1 -0
- package/funcs/settingsAccountV1SettingsSendEmailVerification.d.ts +13 -0
- package/funcs/settingsAccountV1SettingsSendEmailVerification.d.ts.map +1 -0
- package/funcs/settingsAccountV1SettingsSendEmailVerification.js +99 -0
- package/funcs/settingsAccountV1SettingsSendEmailVerification.js.map +1 -0
- package/funcs/settingsAccountV1SettingsUpdate.d.ts.map +1 -1
- package/funcs/settingsAccountV1SettingsUpdate.js +3 -2
- package/funcs/settingsAccountV1SettingsUpdate.js.map +1 -1
- package/funcs/settingsAccountV1SettingsUpdateImage.d.ts +13 -0
- package/funcs/settingsAccountV1SettingsUpdateImage.d.ts.map +1 -0
- package/funcs/settingsAccountV1SettingsUpdateImage.js +95 -0
- package/funcs/settingsAccountV1SettingsUpdateImage.js.map +1 -0
- package/funcs/settingsAccountV1SettingsVerfyEmail.d.ts +13 -0
- package/funcs/settingsAccountV1SettingsVerfyEmail.d.ts.map +1 -0
- package/funcs/settingsAccountV1SettingsVerfyEmail.js +95 -0
- package/funcs/settingsAccountV1SettingsVerfyEmail.js.map +1 -0
- package/lib/config.d.ts +4 -4
- package/lib/config.d.ts.map +1 -1
- package/lib/config.js +4 -4
- package/lib/config.js.map +1 -1
- package/models/components/index.d.ts +11 -2
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +11 -2
- package/models/components/index.js.map +1 -1
- package/models/components/item.d.ts +33 -0
- package/models/components/item.d.ts.map +1 -0
- package/models/components/item.js +52 -0
- package/models/components/item.js.map +1 -0
- package/models/components/resource.d.ts +30 -0
- package/models/components/resource.d.ts.map +1 -0
- package/models/components/{v1resource.js → resource.js} +11 -11
- package/models/components/resource.js.map +1 -0
- package/models/components/role.d.ts +40 -0
- package/models/components/role.d.ts.map +1 -0
- package/models/components/{v1role.js → role.js} +11 -11
- package/models/components/role.js.map +1 -0
- package/models/components/v1connectresponsebody.d.ts +0 -5
- package/models/components/v1connectresponsebody.d.ts.map +1 -1
- package/models/components/v1connectresponsebody.js +0 -2
- package/models/components/v1connectresponsebody.js.map +1 -1
- package/models/components/v1deleteconnectionresponsebody.d.ts +0 -5
- package/models/components/v1deleteconnectionresponsebody.d.ts.map +1 -1
- package/models/components/v1deleteconnectionresponsebody.js +0 -2
- package/models/components/v1deleteconnectionresponsebody.js.map +1 -1
- package/models/components/v1deleteimagesrequestbody.d.ts +29 -0
- package/models/components/v1deleteimagesrequestbody.d.ts.map +1 -0
- package/models/components/v1deleteimagesrequestbody.js +51 -0
- package/models/components/v1deleteimagesrequestbody.js.map +1 -0
- package/models/components/v1deleteimagesresponsebody.d.ts +28 -0
- package/models/components/v1deleteimagesresponsebody.d.ts.map +1 -0
- package/models/components/v1deleteimagesresponsebody.js +63 -0
- package/models/components/v1deleteimagesresponsebody.js.map +1 -0
- package/models/components/v1deletesessionresponsebody.d.ts +0 -5
- package/models/components/v1deletesessionresponsebody.d.ts.map +1 -1
- package/models/components/v1deletesessionresponsebody.js +0 -2
- package/models/components/v1deletesessionresponsebody.js.map +1 -1
- package/models/components/v1generateapikeyresponsebody.d.ts +33 -0
- package/models/components/v1generateapikeyresponsebody.d.ts.map +1 -0
- package/models/components/v1generateapikeyresponsebody.js +65 -0
- package/models/components/v1generateapikeyresponsebody.js.map +1 -0
- package/models/components/v1getsessionbody.d.ts +6 -6
- package/models/components/v1getsessionbody.d.ts.map +1 -1
- package/models/components/v1getsessionbody.js +6 -6
- package/models/components/v1getsessionbody.js.map +1 -1
- package/models/components/v1updateconnectionrequestbody.d.ts +2 -2
- package/models/components/v1updateconnectionrequestbody.js +2 -2
- package/models/components/v1updateconnectionresponsebody.d.ts +0 -5
- package/models/components/v1updateconnectionresponsebody.d.ts.map +1 -1
- package/models/components/v1updateconnectionresponsebody.js +0 -2
- package/models/components/v1updateconnectionresponsebody.js.map +1 -1
- package/models/components/v1updateimagerequestbody.d.ts +33 -0
- package/models/components/v1updateimagerequestbody.d.ts.map +1 -0
- package/models/components/v1updateimagerequestbody.js +52 -0
- package/models/components/v1updateimagerequestbody.js.map +1 -0
- package/models/components/v1updateimageresponsebody.d.ts +33 -0
- package/models/components/v1updateimageresponsebody.d.ts.map +1 -0
- package/models/components/v1updateimageresponsebody.js +65 -0
- package/models/components/v1updateimageresponsebody.js.map +1 -0
- package/models/components/v1updatesettingsrequestbody.d.ts +96 -0
- package/models/components/v1updatesettingsrequestbody.d.ts.map +1 -0
- package/models/components/v1updatesettingsrequestbody.js +87 -0
- package/models/components/v1updatesettingsrequestbody.js.map +1 -0
- package/models/components/v1updatesettingsresponsebody.d.ts +0 -5
- package/models/components/v1updatesettingsresponsebody.d.ts.map +1 -1
- package/models/components/v1updatesettingsresponsebody.js +0 -2
- package/models/components/v1updatesettingsresponsebody.js.map +1 -1
- package/models/components/v1verifyconnectionresponsebody.d.ts +0 -5
- package/models/components/v1verifyconnectionresponsebody.d.ts.map +1 -1
- package/models/components/v1verifyconnectionresponsebody.js +0 -2
- package/models/components/v1verifyconnectionresponsebody.js.map +1 -1
- package/models/components/v1verifyemailrequestbody.d.ts +28 -0
- package/models/components/v1verifyemailrequestbody.d.ts.map +1 -0
- package/models/components/v1verifyemailrequestbody.js +50 -0
- package/models/components/v1verifyemailrequestbody.js.map +1 -0
- package/models/components/v1verifyemailresponsebody.d.ts +28 -0
- package/models/components/v1verifyemailresponsebody.d.ts.map +1 -0
- package/models/components/v1verifyemailresponsebody.js +63 -0
- package/models/components/v1verifyemailresponsebody.js.map +1 -0
- package/models/operations/accountv1settingssendemailverification.d.ts +25 -0
- package/models/operations/accountv1settingssendemailverification.d.ts.map +1 -0
- package/models/operations/accountv1settingssendemailverification.js +63 -0
- package/models/operations/accountv1settingssendemailverification.js.map +1 -0
- package/models/operations/accountv1settingsupdate.d.ts +3 -0
- package/models/operations/accountv1settingsupdate.d.ts.map +1 -1
- package/models/operations/accountv1settingsupdate.js +5 -0
- package/models/operations/accountv1settingsupdate.js.map +1 -1
- package/models/operations/index.d.ts +1 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +1 -0
- package/models/operations/index.js.map +1 -1
- package/package.json +1 -1
- package/sdk/account.d.ts +20 -0
- package/sdk/account.d.ts.map +1 -1
- package/sdk/account.js +35 -0
- package/sdk/account.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/sdk/settings.d.ts +20 -0
- package/sdk/settings.d.ts.map +1 -1
- package/sdk/settings.js +35 -0
- package/sdk/settings.js.map +1 -1
- package/src/funcs/accountAccountV1SettingsDeleteImages.ts +129 -0
- package/src/funcs/accountAccountV1SettingsGenerateApiKey.ts +111 -0
- package/src/funcs/accountAccountV1SettingsSendEmailVerification.ts +134 -0
- package/src/funcs/accountAccountV1SettingsUpdate.ts +4 -3
- package/src/funcs/accountAccountV1SettingsUpdateImage.ts +129 -0
- package/src/funcs/accountAccountV1SettingsVerfyEmail.ts +129 -0
- package/src/funcs/settingsAccountV1SettingsDeleteImages.ts +129 -0
- package/src/funcs/settingsAccountV1SettingsGenerateApiKey.ts +111 -0
- package/src/funcs/settingsAccountV1SettingsSendEmailVerification.ts +134 -0
- package/src/funcs/settingsAccountV1SettingsUpdate.ts +4 -3
- package/src/funcs/settingsAccountV1SettingsUpdateImage.ts +129 -0
- package/src/funcs/settingsAccountV1SettingsVerfyEmail.ts +129 -0
- package/src/lib/config.ts +4 -4
- package/src/models/components/index.ts +11 -2
- package/src/models/components/item.ts +47 -0
- package/src/models/components/{v1resource.ts → resource.ts} +11 -11
- package/src/models/components/{v1role.ts → role.ts} +11 -11
- package/src/models/components/v1connectresponsebody.ts +0 -7
- package/src/models/components/v1deleteconnectionresponsebody.ts +0 -7
- package/src/models/components/v1deleteimagesrequestbody.ts +49 -0
- package/src/models/components/v1deleteimagesresponsebody.ts +61 -0
- package/src/models/components/v1deletesessionresponsebody.ts +0 -7
- package/src/models/components/v1generateapikeyresponsebody.ts +68 -0
- package/src/models/components/v1getsessionbody.ts +15 -15
- package/src/models/components/v1updateconnectionrequestbody.ts +4 -4
- package/src/models/components/v1updateconnectionresponsebody.ts +0 -7
- package/src/models/components/v1updateimagerequestbody.ts +55 -0
- package/src/models/components/v1updateimageresponsebody.ts +68 -0
- package/src/models/components/v1updatesettingsrequestbody.ts +137 -0
- package/src/models/components/v1updatesettingsresponsebody.ts +0 -7
- package/src/models/components/v1verifyconnectionresponsebody.ts +0 -7
- package/src/models/components/v1verifyemailrequestbody.ts +48 -0
- package/src/models/components/v1verifyemailresponsebody.ts +61 -0
- package/src/models/operations/accountv1settingssendemailverification.ts +58 -0
- package/src/models/operations/accountv1settingsupdate.ts +7 -0
- package/src/models/operations/index.ts +1 -0
- package/src/sdk/account.ts +54 -0
- package/src/sdk/sdk.ts +5 -5
- package/src/sdk/settings.ts +54 -0
- package/models/components/v1resource.d.ts +0 -30
- package/models/components/v1resource.d.ts.map +0 -1
- package/models/components/v1resource.js.map +0 -1
- package/models/components/v1role.d.ts +0 -40
- package/models/components/v1role.d.ts.map +0 -1
- package/models/components/v1role.js.map +0 -1
package/README.md
CHANGED
|
@@ -81,15 +81,20 @@ run();
|
|
|
81
81
|
|
|
82
82
|
* [accountV1ConnectionConnect](docs/sdks/account/README.md#accountv1connectionconnect) - Connect a new Social Provider
|
|
83
83
|
* [accountV1ConnectionDeleteConnection](docs/sdks/account/README.md#accountv1connectiondeleteconnection) - Remove a connection
|
|
84
|
+
* [accountV1SettingsDeleteImages](docs/sdks/account/README.md#accountv1settingsdeleteimages) - Delete mulitple imagest
|
|
84
85
|
* [accountV1SessionDelete](docs/sdks/account/README.md#accountv1sessiondelete) - Deletes a session, can also be used to logout
|
|
86
|
+
* [accountV1SettingsGenerateApiKey](docs/sdks/account/README.md#accountv1settingsgenerateapikey) - Generate a new API key for the account
|
|
85
87
|
* [accountV1GetApps](docs/sdks/account/README.md#accountv1getapps) - Get Account Apps
|
|
86
88
|
* [accountV1GetBadges](docs/sdks/account/README.md#accountv1getbadges) - Get Account Badges
|
|
87
89
|
* [accountV1SessionGet](docs/sdks/account/README.md#accountv1sessionget) - Gets all session data
|
|
88
90
|
* [accountV1SettingsGet](docs/sdks/account/README.md#accountv1settingsget) - Gets all settings for the account
|
|
89
91
|
* [accountV1SessionLogin](docs/sdks/account/README.md#accountv1sessionlogin) - Logs a user in and creates a new session
|
|
92
|
+
* [accountV1SettingsSendEmailVerification](docs/sdks/account/README.md#accountv1settingssendemailverification) - Resend the verification code for an email
|
|
90
93
|
* [accountV1ConnectionUpdateConnection](docs/sdks/account/README.md#accountv1connectionupdateconnection) - Make a connection visible/invisible
|
|
94
|
+
* [accountV1SettingsUpdateImage](docs/sdks/account/README.md#accountv1settingsupdateimage) - Update one of the uploaded images
|
|
91
95
|
* [accountV1SettingsUpdate](docs/sdks/account/README.md#accountv1settingsupdate) - Update settings for the logged in account
|
|
92
96
|
* [accountV1ConnectionVerifyConnection](docs/sdks/account/README.md#accountv1connectionverifyconnection) - Verify a domain connection only atm
|
|
97
|
+
* [accountV1SettingsVerfyEmail](docs/sdks/account/README.md#accountv1settingsverfyemail) - Verify the email by passing in the code the user should've gotten
|
|
93
98
|
|
|
94
99
|
### [connection](docs/sdks/connection/README.md)
|
|
95
100
|
|
|
@@ -98,17 +103,22 @@ run();
|
|
|
98
103
|
* [accountV1ConnectionUpdateConnection](docs/sdks/connection/README.md#accountv1connectionupdateconnection) - Make a connection visible/invisible
|
|
99
104
|
* [accountV1ConnectionVerifyConnection](docs/sdks/connection/README.md#accountv1connectionverifyconnection) - Verify a domain connection only atm
|
|
100
105
|
|
|
106
|
+
### [settings](docs/sdks/settings/README.md)
|
|
107
|
+
|
|
108
|
+
* [accountV1SettingsDeleteImages](docs/sdks/settings/README.md#accountv1settingsdeleteimages) - Delete mulitple imagest
|
|
109
|
+
* [accountV1SettingsGenerateApiKey](docs/sdks/settings/README.md#accountv1settingsgenerateapikey) - Generate a new API key for the account
|
|
110
|
+
* [accountV1SettingsGet](docs/sdks/settings/README.md#accountv1settingsget) - Gets all settings for the account
|
|
111
|
+
* [accountV1SettingsSendEmailVerification](docs/sdks/settings/README.md#accountv1settingssendemailverification) - Resend the verification code for an email
|
|
112
|
+
* [accountV1SettingsUpdateImage](docs/sdks/settings/README.md#accountv1settingsupdateimage) - Update one of the uploaded images
|
|
113
|
+
* [accountV1SettingsUpdate](docs/sdks/settings/README.md#accountv1settingsupdate) - Update settings for the logged in account
|
|
114
|
+
* [accountV1SettingsVerfyEmail](docs/sdks/settings/README.md#accountv1settingsverfyemail) - Verify the email by passing in the code the user should've gotten
|
|
115
|
+
|
|
101
116
|
### [session](docs/sdks/session/README.md)
|
|
102
117
|
|
|
103
118
|
* [accountV1SessionDelete](docs/sdks/session/README.md#accountv1sessiondelete) - Deletes a session, can also be used to logout
|
|
104
119
|
* [accountV1SessionGet](docs/sdks/session/README.md#accountv1sessionget) - Gets all session data
|
|
105
120
|
* [accountV1SessionLogin](docs/sdks/session/README.md#accountv1sessionlogin) - Logs a user in and creates a new session
|
|
106
121
|
|
|
107
|
-
### [settings](docs/sdks/settings/README.md)
|
|
108
|
-
|
|
109
|
-
* [accountV1SettingsGet](docs/sdks/settings/README.md#accountv1settingsget) - Gets all settings for the account
|
|
110
|
-
* [accountV1SettingsUpdate](docs/sdks/settings/README.md#accountv1settingsupdate) - Update settings for the logged in account
|
|
111
|
-
|
|
112
122
|
### [liveness](docs/sdks/liveness/README.md)
|
|
113
123
|
|
|
114
124
|
* [liveness](docs/sdks/liveness/README.md#liveness) - Liveness check
|
|
@@ -253,13 +263,14 @@ You can override the default server globally by passing a server index to the `s
|
|
|
253
263
|
|
|
254
264
|
| # | Server | Variables |
|
|
255
265
|
| - | ------ | --------- |
|
|
256
|
-
| 0 | `
|
|
266
|
+
| 0 | `http://localhost:8080` | None |
|
|
267
|
+
| 1 | `https://api.steamsets.com` | None |
|
|
257
268
|
|
|
258
269
|
```typescript
|
|
259
270
|
import { SteamSets } from "@steamsets/client-ts";
|
|
260
271
|
|
|
261
272
|
const steamSets = new SteamSets({
|
|
262
|
-
serverIdx:
|
|
273
|
+
serverIdx: 1,
|
|
263
274
|
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
264
275
|
});
|
|
265
276
|
|
|
@@ -286,7 +297,7 @@ The default server can also be overridden globally by passing a URL to the `serv
|
|
|
286
297
|
import { SteamSets } from "@steamsets/client-ts";
|
|
287
298
|
|
|
288
299
|
const steamSets = new SteamSets({
|
|
289
|
-
serverURL: "
|
|
300
|
+
serverURL: "http://localhost:8080",
|
|
290
301
|
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
291
302
|
});
|
|
292
303
|
|
|
@@ -424,8 +435,13 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
424
435
|
- [accountAccountV1SessionDelete](docs/sdks/account/README.md#accountv1sessiondelete)
|
|
425
436
|
- [accountAccountV1SessionGet](docs/sdks/account/README.md#accountv1sessionget)
|
|
426
437
|
- [accountAccountV1SessionLogin](docs/sdks/account/README.md#accountv1sessionlogin)
|
|
438
|
+
- [accountAccountV1SettingsDeleteImages](docs/sdks/account/README.md#accountv1settingsdeleteimages)
|
|
439
|
+
- [accountAccountV1SettingsGenerateApiKey](docs/sdks/account/README.md#accountv1settingsgenerateapikey)
|
|
427
440
|
- [accountAccountV1SettingsGet](docs/sdks/account/README.md#accountv1settingsget)
|
|
441
|
+
- [accountAccountV1SettingsSendEmailVerification](docs/sdks/account/README.md#accountv1settingssendemailverification)
|
|
442
|
+
- [accountAccountV1SettingsUpdateImage](docs/sdks/account/README.md#accountv1settingsupdateimage)
|
|
428
443
|
- [accountAccountV1SettingsUpdate](docs/sdks/account/README.md#accountv1settingsupdate)
|
|
444
|
+
- [accountAccountV1SettingsVerfyEmail](docs/sdks/account/README.md#accountv1settingsverfyemail)
|
|
429
445
|
- [connectionAccountV1ConnectionConnect](docs/sdks/connection/README.md#accountv1connectionconnect)
|
|
430
446
|
- [connectionAccountV1ConnectionDeleteConnection](docs/sdks/connection/README.md#accountv1connectiondeleteconnection)
|
|
431
447
|
- [connectionAccountV1ConnectionUpdateConnection](docs/sdks/connection/README.md#accountv1connectionupdateconnection)
|
|
@@ -434,8 +450,13 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
434
450
|
- [sessionAccountV1SessionDelete](docs/sdks/session/README.md#accountv1sessiondelete)
|
|
435
451
|
- [sessionAccountV1SessionGet](docs/sdks/session/README.md#accountv1sessionget)
|
|
436
452
|
- [sessionAccountV1SessionLogin](docs/sdks/session/README.md#accountv1sessionlogin)
|
|
453
|
+
- [settingsAccountV1SettingsDeleteImages](docs/sdks/settings/README.md#accountv1settingsdeleteimages)
|
|
454
|
+
- [settingsAccountV1SettingsGenerateApiKey](docs/sdks/settings/README.md#accountv1settingsgenerateapikey)
|
|
437
455
|
- [settingsAccountV1SettingsGet](docs/sdks/settings/README.md#accountv1settingsget)
|
|
456
|
+
- [settingsAccountV1SettingsSendEmailVerification](docs/sdks/settings/README.md#accountv1settingssendemailverification)
|
|
457
|
+
- [settingsAccountV1SettingsUpdateImage](docs/sdks/settings/README.md#accountv1settingsupdateimage)
|
|
438
458
|
- [settingsAccountV1SettingsUpdate](docs/sdks/settings/README.md#accountv1settingsupdate)
|
|
459
|
+
- [settingsAccountV1SettingsVerfyEmail](docs/sdks/settings/README.md#accountv1settingsverfyemail)
|
|
439
460
|
|
|
440
461
|
|
|
441
462
|
</details>
|
|
@@ -444,7 +465,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
444
465
|
<!-- Start Debugging [debug] -->
|
|
445
466
|
## Debugging
|
|
446
467
|
|
|
447
|
-
|
|
468
|
+
You can setup your SDK to emit debug logs for SDK requests and responses.
|
|
469
|
+
|
|
470
|
+
You can pass a logger that matches `console`'s interface as an SDK option.
|
|
448
471
|
|
|
449
472
|
> [!WARNING]
|
|
450
473
|
> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
|
|
@@ -9,15 +9,20 @@ Account related operations
|
|
|
9
9
|
|
|
10
10
|
* [accountV1ConnectionConnect](#accountv1connectionconnect) - Connect a new Social Provider
|
|
11
11
|
* [accountV1ConnectionDeleteConnection](#accountv1connectiondeleteconnection) - Remove a connection
|
|
12
|
+
* [accountV1SettingsDeleteImages](#accountv1settingsdeleteimages) - Delete mulitple imagest
|
|
12
13
|
* [accountV1SessionDelete](#accountv1sessiondelete) - Deletes a session, can also be used to logout
|
|
14
|
+
* [accountV1SettingsGenerateApiKey](#accountv1settingsgenerateapikey) - Generate a new API key for the account
|
|
13
15
|
* [accountV1GetApps](#accountv1getapps) - Get Account Apps
|
|
14
16
|
* [accountV1GetBadges](#accountv1getbadges) - Get Account Badges
|
|
15
17
|
* [accountV1SessionGet](#accountv1sessionget) - Gets all session data
|
|
16
18
|
* [accountV1SettingsGet](#accountv1settingsget) - Gets all settings for the account
|
|
17
19
|
* [accountV1SessionLogin](#accountv1sessionlogin) - Logs a user in and creates a new session
|
|
20
|
+
* [accountV1SettingsSendEmailVerification](#accountv1settingssendemailverification) - Resend the verification code for an email
|
|
18
21
|
* [accountV1ConnectionUpdateConnection](#accountv1connectionupdateconnection) - Make a connection visible/invisible
|
|
22
|
+
* [accountV1SettingsUpdateImage](#accountv1settingsupdateimage) - Update one of the uploaded images
|
|
19
23
|
* [accountV1SettingsUpdate](#accountv1settingsupdate) - Update settings for the logged in account
|
|
20
24
|
* [accountV1ConnectionVerifyConnection](#accountv1connectionverifyconnection) - Verify a domain connection only atm
|
|
25
|
+
* [accountV1SettingsVerfyEmail](#accountv1settingsverfyemail) - Verify the email by passing in the code the user should've gotten
|
|
21
26
|
|
|
22
27
|
## accountV1ConnectionConnect
|
|
23
28
|
|
|
@@ -177,6 +182,94 @@ run();
|
|
|
177
182
|
| errors.ErrorModel | 400,422,500 | application/problem+json |
|
|
178
183
|
| errors.SDKError | 4xx-5xx | */* |
|
|
179
184
|
|
|
185
|
+
## accountV1SettingsDeleteImages
|
|
186
|
+
|
|
187
|
+
Delete mulitple imagest
|
|
188
|
+
|
|
189
|
+
### Example Usage
|
|
190
|
+
|
|
191
|
+
```typescript
|
|
192
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
193
|
+
|
|
194
|
+
const steamSets = new SteamSets({
|
|
195
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
196
|
+
});
|
|
197
|
+
|
|
198
|
+
async function run() {
|
|
199
|
+
const result = await steamSets.account.accountV1SettingsDeleteImages({
|
|
200
|
+
images: [
|
|
201
|
+
{
|
|
202
|
+
fileId: "123456",
|
|
203
|
+
imageId: "123456",
|
|
204
|
+
},
|
|
205
|
+
],
|
|
206
|
+
});
|
|
207
|
+
|
|
208
|
+
// Handle the result
|
|
209
|
+
console.log(result)
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
run();
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
### Standalone function
|
|
217
|
+
|
|
218
|
+
The standalone function version of this method:
|
|
219
|
+
|
|
220
|
+
```typescript
|
|
221
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
222
|
+
import { accountAccountV1SettingsDeleteImages } from "@steamsets/client-ts/funcs/accountAccountV1SettingsDeleteImages.js";
|
|
223
|
+
|
|
224
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
225
|
+
// You can create one instance of it to use across an application.
|
|
226
|
+
const steamSets = new SteamSetsCore({
|
|
227
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
228
|
+
});
|
|
229
|
+
|
|
230
|
+
async function run() {
|
|
231
|
+
const res = await accountAccountV1SettingsDeleteImages(steamSets, {
|
|
232
|
+
images: [
|
|
233
|
+
{
|
|
234
|
+
fileId: "123456",
|
|
235
|
+
imageId: "123456",
|
|
236
|
+
},
|
|
237
|
+
],
|
|
238
|
+
});
|
|
239
|
+
|
|
240
|
+
if (!res.ok) {
|
|
241
|
+
throw res.error;
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
const { value: result } = res;
|
|
245
|
+
|
|
246
|
+
// Handle the result
|
|
247
|
+
console.log(result)
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
run();
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
### Parameters
|
|
254
|
+
|
|
255
|
+
| Parameter | Type | Required | Description |
|
|
256
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
257
|
+
| `request` | [components.V1DeleteImagesRequestBody](../../models/components/v1deleteimagesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
258
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
259
|
+
| `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. |
|
|
260
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
### Response
|
|
264
|
+
|
|
265
|
+
**Promise\<[components.V1DeleteImagesResponseBody](../../models/components/v1deleteimagesresponsebody.md)\>**
|
|
266
|
+
### Errors
|
|
267
|
+
|
|
268
|
+
| Error Object | Status Code | Content Type |
|
|
269
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
270
|
+
| errors.ErrorModel | 404,422,500 | application/problem+json |
|
|
271
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
272
|
+
|
|
180
273
|
## accountV1SessionDelete
|
|
181
274
|
|
|
182
275
|
Deletes a session, can also be used to logout
|
|
@@ -255,6 +348,79 @@ run();
|
|
|
255
348
|
| errors.ErrorModel | 404,422,500 | application/problem+json |
|
|
256
349
|
| errors.SDKError | 4xx-5xx | */* |
|
|
257
350
|
|
|
351
|
+
## accountV1SettingsGenerateApiKey
|
|
352
|
+
|
|
353
|
+
Generate a new API key for the account
|
|
354
|
+
|
|
355
|
+
### Example Usage
|
|
356
|
+
|
|
357
|
+
```typescript
|
|
358
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
359
|
+
|
|
360
|
+
const steamSets = new SteamSets({
|
|
361
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
362
|
+
});
|
|
363
|
+
|
|
364
|
+
async function run() {
|
|
365
|
+
const result = await steamSets.account.accountV1SettingsGenerateApiKey();
|
|
366
|
+
|
|
367
|
+
// Handle the result
|
|
368
|
+
console.log(result)
|
|
369
|
+
}
|
|
370
|
+
|
|
371
|
+
run();
|
|
372
|
+
```
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
### Standalone function
|
|
376
|
+
|
|
377
|
+
The standalone function version of this method:
|
|
378
|
+
|
|
379
|
+
```typescript
|
|
380
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
381
|
+
import { accountAccountV1SettingsGenerateApiKey } from "@steamsets/client-ts/funcs/accountAccountV1SettingsGenerateApiKey.js";
|
|
382
|
+
|
|
383
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
384
|
+
// You can create one instance of it to use across an application.
|
|
385
|
+
const steamSets = new SteamSetsCore({
|
|
386
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
387
|
+
});
|
|
388
|
+
|
|
389
|
+
async function run() {
|
|
390
|
+
const res = await accountAccountV1SettingsGenerateApiKey(steamSets);
|
|
391
|
+
|
|
392
|
+
if (!res.ok) {
|
|
393
|
+
throw res.error;
|
|
394
|
+
}
|
|
395
|
+
|
|
396
|
+
const { value: result } = res;
|
|
397
|
+
|
|
398
|
+
// Handle the result
|
|
399
|
+
console.log(result)
|
|
400
|
+
}
|
|
401
|
+
|
|
402
|
+
run();
|
|
403
|
+
```
|
|
404
|
+
|
|
405
|
+
### Parameters
|
|
406
|
+
|
|
407
|
+
| Parameter | Type | Required | Description |
|
|
408
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
409
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
410
|
+
| `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. |
|
|
411
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
### Response
|
|
415
|
+
|
|
416
|
+
**Promise\<[components.V1GenerateApiKeyResponseBody](../../models/components/v1generateapikeyresponsebody.md)\>**
|
|
417
|
+
### Errors
|
|
418
|
+
|
|
419
|
+
| Error Object | Status Code | Content Type |
|
|
420
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
421
|
+
| errors.ErrorModel | 404,429,500 | application/problem+json |
|
|
422
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
423
|
+
|
|
258
424
|
## accountV1GetApps
|
|
259
425
|
|
|
260
426
|
Get Account Apps
|
|
@@ -647,6 +813,78 @@ run();
|
|
|
647
813
|
| errors.ErrorModel | 422,500 | application/problem+json |
|
|
648
814
|
| errors.SDKError | 4xx-5xx | */* |
|
|
649
815
|
|
|
816
|
+
## accountV1SettingsSendEmailVerification
|
|
817
|
+
|
|
818
|
+
Resend the verification code for an email
|
|
819
|
+
|
|
820
|
+
### Example Usage
|
|
821
|
+
|
|
822
|
+
```typescript
|
|
823
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
824
|
+
|
|
825
|
+
const steamSets = new SteamSets({
|
|
826
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
827
|
+
});
|
|
828
|
+
|
|
829
|
+
async function run() {
|
|
830
|
+
await steamSets.account.accountV1SettingsSendEmailVerification({});
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
}
|
|
834
|
+
|
|
835
|
+
run();
|
|
836
|
+
```
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
### Standalone function
|
|
840
|
+
|
|
841
|
+
The standalone function version of this method:
|
|
842
|
+
|
|
843
|
+
```typescript
|
|
844
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
845
|
+
import { accountAccountV1SettingsSendEmailVerification } from "@steamsets/client-ts/funcs/accountAccountV1SettingsSendEmailVerification.js";
|
|
846
|
+
|
|
847
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
848
|
+
// You can create one instance of it to use across an application.
|
|
849
|
+
const steamSets = new SteamSetsCore({
|
|
850
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
851
|
+
});
|
|
852
|
+
|
|
853
|
+
async function run() {
|
|
854
|
+
const res = await accountAccountV1SettingsSendEmailVerification(steamSets, {});
|
|
855
|
+
|
|
856
|
+
if (!res.ok) {
|
|
857
|
+
throw res.error;
|
|
858
|
+
}
|
|
859
|
+
|
|
860
|
+
const { value: result } = res;
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
}
|
|
864
|
+
|
|
865
|
+
run();
|
|
866
|
+
```
|
|
867
|
+
|
|
868
|
+
### Parameters
|
|
869
|
+
|
|
870
|
+
| Parameter | Type | Required | Description |
|
|
871
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
872
|
+
| `request` | [operations.AccountV1SettingsSendEmailVerificationRequest](../../models/operations/accountv1settingssendemailverificationrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
873
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
874
|
+
| `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. |
|
|
875
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
### Response
|
|
879
|
+
|
|
880
|
+
**Promise\<void\>**
|
|
881
|
+
### Errors
|
|
882
|
+
|
|
883
|
+
| Error Object | Status Code | Content Type |
|
|
884
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
885
|
+
| errors.ErrorModel | 404,422,429,500 | application/problem+json |
|
|
886
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
887
|
+
|
|
650
888
|
## accountV1ConnectionUpdateConnection
|
|
651
889
|
|
|
652
890
|
Make a connection visible/invisible
|
|
@@ -663,7 +901,7 @@ const steamSets = new SteamSets({
|
|
|
663
901
|
async function run() {
|
|
664
902
|
const result = await steamSets.account.accountV1ConnectionUpdateConnection({
|
|
665
903
|
connectionId: "123456",
|
|
666
|
-
|
|
904
|
+
hidden: true,
|
|
667
905
|
});
|
|
668
906
|
|
|
669
907
|
// Handle the result
|
|
@@ -691,7 +929,7 @@ const steamSets = new SteamSetsCore({
|
|
|
691
929
|
async function run() {
|
|
692
930
|
const res = await accountAccountV1ConnectionUpdateConnection(steamSets, {
|
|
693
931
|
connectionId: "123456",
|
|
694
|
-
|
|
932
|
+
hidden: true,
|
|
695
933
|
});
|
|
696
934
|
|
|
697
935
|
if (!res.ok) {
|
|
@@ -727,6 +965,86 @@ run();
|
|
|
727
965
|
| errors.ErrorModel | 400,404,422,500 | application/problem+json |
|
|
728
966
|
| errors.SDKError | 4xx-5xx | */* |
|
|
729
967
|
|
|
968
|
+
## accountV1SettingsUpdateImage
|
|
969
|
+
|
|
970
|
+
Update one of the uploaded images
|
|
971
|
+
|
|
972
|
+
### Example Usage
|
|
973
|
+
|
|
974
|
+
```typescript
|
|
975
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
976
|
+
|
|
977
|
+
const steamSets = new SteamSets({
|
|
978
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
979
|
+
});
|
|
980
|
+
|
|
981
|
+
async function run() {
|
|
982
|
+
const result = await steamSets.account.accountV1SettingsUpdateImage({
|
|
983
|
+
active: true,
|
|
984
|
+
imageId: "123456",
|
|
985
|
+
});
|
|
986
|
+
|
|
987
|
+
// Handle the result
|
|
988
|
+
console.log(result)
|
|
989
|
+
}
|
|
990
|
+
|
|
991
|
+
run();
|
|
992
|
+
```
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
### Standalone function
|
|
996
|
+
|
|
997
|
+
The standalone function version of this method:
|
|
998
|
+
|
|
999
|
+
```typescript
|
|
1000
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1001
|
+
import { accountAccountV1SettingsUpdateImage } from "@steamsets/client-ts/funcs/accountAccountV1SettingsUpdateImage.js";
|
|
1002
|
+
|
|
1003
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1004
|
+
// You can create one instance of it to use across an application.
|
|
1005
|
+
const steamSets = new SteamSetsCore({
|
|
1006
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1007
|
+
});
|
|
1008
|
+
|
|
1009
|
+
async function run() {
|
|
1010
|
+
const res = await accountAccountV1SettingsUpdateImage(steamSets, {
|
|
1011
|
+
active: true,
|
|
1012
|
+
imageId: "123456",
|
|
1013
|
+
});
|
|
1014
|
+
|
|
1015
|
+
if (!res.ok) {
|
|
1016
|
+
throw res.error;
|
|
1017
|
+
}
|
|
1018
|
+
|
|
1019
|
+
const { value: result } = res;
|
|
1020
|
+
|
|
1021
|
+
// Handle the result
|
|
1022
|
+
console.log(result)
|
|
1023
|
+
}
|
|
1024
|
+
|
|
1025
|
+
run();
|
|
1026
|
+
```
|
|
1027
|
+
|
|
1028
|
+
### Parameters
|
|
1029
|
+
|
|
1030
|
+
| Parameter | Type | Required | Description |
|
|
1031
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1032
|
+
| `request` | [components.V1UpdateImageRequestBody](../../models/components/v1updateimagerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1033
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1034
|
+
| `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. |
|
|
1035
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
### Response
|
|
1039
|
+
|
|
1040
|
+
**Promise\<[components.V1UpdateImageResponseBody](../../models/components/v1updateimageresponsebody.md)\>**
|
|
1041
|
+
### Errors
|
|
1042
|
+
|
|
1043
|
+
| Error Object | Status Code | Content Type |
|
|
1044
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
1045
|
+
| errors.ErrorModel | 404,422,500 | application/problem+json |
|
|
1046
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
1047
|
+
|
|
730
1048
|
## accountV1SettingsUpdate
|
|
731
1049
|
|
|
732
1050
|
Update settings for the logged in account
|
|
@@ -741,7 +1059,23 @@ const steamSets = new SteamSets({
|
|
|
741
1059
|
});
|
|
742
1060
|
|
|
743
1061
|
async function run() {
|
|
744
|
-
const result = await steamSets.account.accountV1SettingsUpdate({
|
|
1062
|
+
const result = await steamSets.account.accountV1SettingsUpdate({
|
|
1063
|
+
v1UpdateSettingsRequestBody: {
|
|
1064
|
+
color: "#7652c9",
|
|
1065
|
+
colors: "#7652c9",
|
|
1066
|
+
email: "steamsets@example.com",
|
|
1067
|
+
emailNotifications: [
|
|
1068
|
+
{
|
|
1069
|
+
enabled: true,
|
|
1070
|
+
type: "login",
|
|
1071
|
+
},
|
|
1072
|
+
],
|
|
1073
|
+
hidden: true,
|
|
1074
|
+
language: "en",
|
|
1075
|
+
theme: "dark",
|
|
1076
|
+
vanity: "flo",
|
|
1077
|
+
},
|
|
1078
|
+
});
|
|
745
1079
|
|
|
746
1080
|
// Handle the result
|
|
747
1081
|
console.log(result)
|
|
@@ -766,7 +1100,23 @@ const steamSets = new SteamSetsCore({
|
|
|
766
1100
|
});
|
|
767
1101
|
|
|
768
1102
|
async function run() {
|
|
769
|
-
const res = await accountAccountV1SettingsUpdate(steamSets, {
|
|
1103
|
+
const res = await accountAccountV1SettingsUpdate(steamSets, {
|
|
1104
|
+
v1UpdateSettingsRequestBody: {
|
|
1105
|
+
color: "#7652c9",
|
|
1106
|
+
colors: "#7652c9",
|
|
1107
|
+
email: "steamsets@example.com",
|
|
1108
|
+
emailNotifications: [
|
|
1109
|
+
{
|
|
1110
|
+
enabled: true,
|
|
1111
|
+
type: "login",
|
|
1112
|
+
},
|
|
1113
|
+
],
|
|
1114
|
+
hidden: true,
|
|
1115
|
+
language: "en",
|
|
1116
|
+
theme: "dark",
|
|
1117
|
+
vanity: "flo",
|
|
1118
|
+
},
|
|
1119
|
+
});
|
|
770
1120
|
|
|
771
1121
|
if (!res.ok) {
|
|
772
1122
|
throw res.error;
|
|
@@ -878,3 +1228,81 @@ run();
|
|
|
878
1228
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
879
1229
|
| errors.ErrorModel | 400,422,500 | application/problem+json |
|
|
880
1230
|
| errors.SDKError | 4xx-5xx | */* |
|
|
1231
|
+
|
|
1232
|
+
## accountV1SettingsVerfyEmail
|
|
1233
|
+
|
|
1234
|
+
Verify the email by passing in the code the user should've gotten
|
|
1235
|
+
|
|
1236
|
+
### Example Usage
|
|
1237
|
+
|
|
1238
|
+
```typescript
|
|
1239
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
1240
|
+
|
|
1241
|
+
const steamSets = new SteamSets({
|
|
1242
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1243
|
+
});
|
|
1244
|
+
|
|
1245
|
+
async function run() {
|
|
1246
|
+
const result = await steamSets.account.accountV1SettingsVerfyEmail({
|
|
1247
|
+
code: "123456",
|
|
1248
|
+
});
|
|
1249
|
+
|
|
1250
|
+
// Handle the result
|
|
1251
|
+
console.log(result)
|
|
1252
|
+
}
|
|
1253
|
+
|
|
1254
|
+
run();
|
|
1255
|
+
```
|
|
1256
|
+
|
|
1257
|
+
|
|
1258
|
+
### Standalone function
|
|
1259
|
+
|
|
1260
|
+
The standalone function version of this method:
|
|
1261
|
+
|
|
1262
|
+
```typescript
|
|
1263
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1264
|
+
import { accountAccountV1SettingsVerfyEmail } from "@steamsets/client-ts/funcs/accountAccountV1SettingsVerfyEmail.js";
|
|
1265
|
+
|
|
1266
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1267
|
+
// You can create one instance of it to use across an application.
|
|
1268
|
+
const steamSets = new SteamSetsCore({
|
|
1269
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1270
|
+
});
|
|
1271
|
+
|
|
1272
|
+
async function run() {
|
|
1273
|
+
const res = await accountAccountV1SettingsVerfyEmail(steamSets, {
|
|
1274
|
+
code: "123456",
|
|
1275
|
+
});
|
|
1276
|
+
|
|
1277
|
+
if (!res.ok) {
|
|
1278
|
+
throw res.error;
|
|
1279
|
+
}
|
|
1280
|
+
|
|
1281
|
+
const { value: result } = res;
|
|
1282
|
+
|
|
1283
|
+
// Handle the result
|
|
1284
|
+
console.log(result)
|
|
1285
|
+
}
|
|
1286
|
+
|
|
1287
|
+
run();
|
|
1288
|
+
```
|
|
1289
|
+
|
|
1290
|
+
### Parameters
|
|
1291
|
+
|
|
1292
|
+
| Parameter | Type | Required | Description |
|
|
1293
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1294
|
+
| `request` | [components.V1VerifyEmailRequestBody](../../models/components/v1verifyemailrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1295
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1296
|
+
| `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. |
|
|
1297
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1298
|
+
|
|
1299
|
+
|
|
1300
|
+
### Response
|
|
1301
|
+
|
|
1302
|
+
**Promise\<[components.V1VerifyEmailResponseBody](../../models/components/v1verifyemailresponsebody.md)\>**
|
|
1303
|
+
### Errors
|
|
1304
|
+
|
|
1305
|
+
| Error Object | Status Code | Content Type |
|
|
1306
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
1307
|
+
| errors.ErrorModel | 404,422,429,500 | application/problem+json |
|
|
1308
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
@@ -186,7 +186,7 @@ const steamSets = new SteamSets({
|
|
|
186
186
|
async function run() {
|
|
187
187
|
const result = await steamSets.connection.accountV1ConnectionUpdateConnection({
|
|
188
188
|
connectionId: "123456",
|
|
189
|
-
|
|
189
|
+
hidden: true,
|
|
190
190
|
});
|
|
191
191
|
|
|
192
192
|
// Handle the result
|
|
@@ -214,7 +214,7 @@ const steamSets = new SteamSetsCore({
|
|
|
214
214
|
async function run() {
|
|
215
215
|
const res = await connectionAccountV1ConnectionUpdateConnection(steamSets, {
|
|
216
216
|
connectionId: "123456",
|
|
217
|
-
|
|
217
|
+
hidden: true,
|
|
218
218
|
});
|
|
219
219
|
|
|
220
220
|
if (!res.ok) {
|