@steamsets/client-ts 0.2.0 → 0.3.0
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 +42 -19
- package/docs/sdks/account/README.md +454 -26
- package/docs/sdks/connection/README.md +10 -10
- package/docs/sdks/liveness/README.md +2 -2
- package/docs/sdks/session/README.md +6 -6
- package/docs/sdks/settings/README.md +434 -6
- 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/lib/security.js +2 -2
- package/lib/security.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/lib/security.ts +2 -2
- 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
|
@@ -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
|
|
|
@@ -29,7 +34,7 @@ Connect a new Social Provider
|
|
|
29
34
|
import { SteamSets } from "@steamsets/client-ts";
|
|
30
35
|
|
|
31
36
|
const steamSets = new SteamSets({
|
|
32
|
-
session: "<
|
|
37
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
33
38
|
});
|
|
34
39
|
|
|
35
40
|
async function run() {
|
|
@@ -57,7 +62,7 @@ import { accountAccountV1ConnectionConnect } from "@steamsets/client-ts/funcs/ac
|
|
|
57
62
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
58
63
|
// You can create one instance of it to use across an application.
|
|
59
64
|
const steamSets = new SteamSetsCore({
|
|
60
|
-
session: "<
|
|
65
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
61
66
|
});
|
|
62
67
|
|
|
63
68
|
async function run() {
|
|
@@ -109,7 +114,7 @@ Remove a connection
|
|
|
109
114
|
import { SteamSets } from "@steamsets/client-ts";
|
|
110
115
|
|
|
111
116
|
const steamSets = new SteamSets({
|
|
112
|
-
session: "<
|
|
117
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
113
118
|
});
|
|
114
119
|
|
|
115
120
|
async function run() {
|
|
@@ -136,7 +141,7 @@ import { accountAccountV1ConnectionDeleteConnection } from "@steamsets/client-ts
|
|
|
136
141
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
137
142
|
// You can create one instance of it to use across an application.
|
|
138
143
|
const steamSets = new SteamSetsCore({
|
|
139
|
-
session: "<
|
|
144
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
140
145
|
});
|
|
141
146
|
|
|
142
147
|
async function run() {
|
|
@@ -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
|
|
@@ -187,7 +280,7 @@ Deletes a session, can also be used to logout
|
|
|
187
280
|
import { SteamSets } from "@steamsets/client-ts";
|
|
188
281
|
|
|
189
282
|
const steamSets = new SteamSets({
|
|
190
|
-
session: "<
|
|
283
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
191
284
|
});
|
|
192
285
|
|
|
193
286
|
async function run() {
|
|
@@ -214,7 +307,7 @@ import { accountAccountV1SessionDelete } from "@steamsets/client-ts/funcs/accoun
|
|
|
214
307
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
215
308
|
// You can create one instance of it to use across an application.
|
|
216
309
|
const steamSets = new SteamSetsCore({
|
|
217
|
-
session: "<
|
|
310
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
218
311
|
});
|
|
219
312
|
|
|
220
313
|
async function run() {
|
|
@@ -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
|
|
@@ -265,7 +431,7 @@ Get Account Apps
|
|
|
265
431
|
import { SteamSets } from "@steamsets/client-ts";
|
|
266
432
|
|
|
267
433
|
const steamSets = new SteamSets({
|
|
268
|
-
session: "<
|
|
434
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
269
435
|
});
|
|
270
436
|
|
|
271
437
|
async function run() {
|
|
@@ -290,7 +456,7 @@ import { accountAccountV1GetApps } from "@steamsets/client-ts/funcs/accountAccou
|
|
|
290
456
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
291
457
|
// You can create one instance of it to use across an application.
|
|
292
458
|
const steamSets = new SteamSetsCore({
|
|
293
|
-
session: "<
|
|
459
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
294
460
|
});
|
|
295
461
|
|
|
296
462
|
async function run() {
|
|
@@ -338,7 +504,7 @@ Get Account Badges
|
|
|
338
504
|
import { SteamSets } from "@steamsets/client-ts";
|
|
339
505
|
|
|
340
506
|
const steamSets = new SteamSets({
|
|
341
|
-
session: "<
|
|
507
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
342
508
|
});
|
|
343
509
|
|
|
344
510
|
async function run() {
|
|
@@ -363,7 +529,7 @@ import { accountAccountV1GetBadges } from "@steamsets/client-ts/funcs/accountAcc
|
|
|
363
529
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
364
530
|
// You can create one instance of it to use across an application.
|
|
365
531
|
const steamSets = new SteamSetsCore({
|
|
366
|
-
session: "<
|
|
532
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
367
533
|
});
|
|
368
534
|
|
|
369
535
|
async function run() {
|
|
@@ -411,7 +577,7 @@ Gets all session data
|
|
|
411
577
|
import { SteamSets } from "@steamsets/client-ts";
|
|
412
578
|
|
|
413
579
|
const steamSets = new SteamSets({
|
|
414
|
-
session: "<
|
|
580
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
415
581
|
});
|
|
416
582
|
|
|
417
583
|
async function run() {
|
|
@@ -436,7 +602,7 @@ import { accountAccountV1SessionGet } from "@steamsets/client-ts/funcs/accountAc
|
|
|
436
602
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
437
603
|
// You can create one instance of it to use across an application.
|
|
438
604
|
const steamSets = new SteamSetsCore({
|
|
439
|
-
session: "<
|
|
605
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
440
606
|
});
|
|
441
607
|
|
|
442
608
|
async function run() {
|
|
@@ -484,7 +650,7 @@ Gets all settings for the account
|
|
|
484
650
|
import { SteamSets } from "@steamsets/client-ts";
|
|
485
651
|
|
|
486
652
|
const steamSets = new SteamSets({
|
|
487
|
-
session: "<
|
|
653
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
488
654
|
});
|
|
489
655
|
|
|
490
656
|
async function run() {
|
|
@@ -509,7 +675,7 @@ import { accountAccountV1SettingsGet } from "@steamsets/client-ts/funcs/accountA
|
|
|
509
675
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
510
676
|
// You can create one instance of it to use across an application.
|
|
511
677
|
const steamSets = new SteamSetsCore({
|
|
512
|
-
session: "<
|
|
678
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
513
679
|
});
|
|
514
680
|
|
|
515
681
|
async function run() {
|
|
@@ -557,7 +723,7 @@ Logs a user in and creates a new session
|
|
|
557
723
|
import { SteamSets } from "@steamsets/client-ts";
|
|
558
724
|
|
|
559
725
|
const steamSets = new SteamSets({
|
|
560
|
-
session: "<
|
|
726
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
561
727
|
});
|
|
562
728
|
|
|
563
729
|
async function run() {
|
|
@@ -595,7 +761,7 @@ import { accountAccountV1SessionLogin } from "@steamsets/client-ts/funcs/account
|
|
|
595
761
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
596
762
|
// You can create one instance of it to use across an application.
|
|
597
763
|
const steamSets = new SteamSetsCore({
|
|
598
|
-
session: "<
|
|
764
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
599
765
|
});
|
|
600
766
|
|
|
601
767
|
async function run() {
|
|
@@ -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
|
|
@@ -657,13 +895,13 @@ Make a connection visible/invisible
|
|
|
657
895
|
import { SteamSets } from "@steamsets/client-ts";
|
|
658
896
|
|
|
659
897
|
const steamSets = new SteamSets({
|
|
660
|
-
session: "<
|
|
898
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
661
899
|
});
|
|
662
900
|
|
|
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
|
|
@@ -685,13 +923,13 @@ import { accountAccountV1ConnectionUpdateConnection } from "@steamsets/client-ts
|
|
|
685
923
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
686
924
|
// You can create one instance of it to use across an application.
|
|
687
925
|
const steamSets = new SteamSetsCore({
|
|
688
|
-
session: "<
|
|
926
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
689
927
|
});
|
|
690
928
|
|
|
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
|
|
@@ -737,11 +1055,27 @@ Update settings for the logged in account
|
|
|
737
1055
|
import { SteamSets } from "@steamsets/client-ts";
|
|
738
1056
|
|
|
739
1057
|
const steamSets = new SteamSets({
|
|
740
|
-
session: "<
|
|
1058
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
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)
|
|
@@ -762,11 +1096,27 @@ import { accountAccountV1SettingsUpdate } from "@steamsets/client-ts/funcs/accou
|
|
|
762
1096
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
763
1097
|
// You can create one instance of it to use across an application.
|
|
764
1098
|
const steamSets = new SteamSetsCore({
|
|
765
|
-
session: "<
|
|
1099
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
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;
|
|
@@ -811,7 +1161,7 @@ Verify a domain connection only atm
|
|
|
811
1161
|
import { SteamSets } from "@steamsets/client-ts";
|
|
812
1162
|
|
|
813
1163
|
const steamSets = new SteamSets({
|
|
814
|
-
session: "<
|
|
1164
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
815
1165
|
});
|
|
816
1166
|
|
|
817
1167
|
async function run() {
|
|
@@ -838,7 +1188,7 @@ import { accountAccountV1ConnectionVerifyConnection } from "@steamsets/client-ts
|
|
|
838
1188
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
839
1189
|
// You can create one instance of it to use across an application.
|
|
840
1190
|
const steamSets = new SteamSetsCore({
|
|
841
|
-
session: "<
|
|
1191
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
842
1192
|
});
|
|
843
1193
|
|
|
844
1194
|
async function run() {
|
|
@@ -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 | */* |
|