@steamsets/client-ts 0.1.2 → 0.2.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/.devcontainer/README.md +1 -1
- package/README.md +139 -54
- package/docs/sdks/account/README.md +798 -15
- package/docs/sdks/connection/README.md +329 -0
- package/docs/sdks/liveness/README.md +36 -4
- package/docs/sdks/session/README.md +259 -0
- package/docs/sdks/settings/README.md +154 -0
- package/funcs/accountAccountV1ConnectionConnect.d.ts +13 -0
- package/funcs/accountAccountV1ConnectionConnect.d.ts.map +1 -0
- package/funcs/accountAccountV1ConnectionConnect.js +95 -0
- package/funcs/accountAccountV1ConnectionConnect.js.map +1 -0
- package/funcs/accountAccountV1ConnectionDeleteConnection.d.ts +13 -0
- package/funcs/accountAccountV1ConnectionDeleteConnection.d.ts.map +1 -0
- package/funcs/accountAccountV1ConnectionDeleteConnection.js +95 -0
- package/funcs/accountAccountV1ConnectionDeleteConnection.js.map +1 -0
- package/funcs/accountAccountV1ConnectionUpdateConnection.d.ts +13 -0
- package/funcs/accountAccountV1ConnectionUpdateConnection.d.ts.map +1 -0
- package/funcs/accountAccountV1ConnectionUpdateConnection.js +95 -0
- package/funcs/accountAccountV1ConnectionUpdateConnection.js.map +1 -0
- package/funcs/accountAccountV1ConnectionVerifyConnection.d.ts +13 -0
- package/funcs/accountAccountV1ConnectionVerifyConnection.d.ts.map +1 -0
- package/funcs/accountAccountV1ConnectionVerifyConnection.js +95 -0
- package/funcs/accountAccountV1ConnectionVerifyConnection.js.map +1 -0
- package/funcs/accountAccountV1GetApps.d.ts +13 -0
- package/funcs/accountAccountV1GetApps.d.ts.map +1 -0
- package/funcs/{accountAccountV1Apps.js → accountAccountV1GetApps.js} +8 -6
- package/funcs/accountAccountV1GetApps.js.map +1 -0
- package/funcs/{accountAccountV1Badge.d.ts → accountAccountV1GetBadges.d.ts} +2 -2
- package/funcs/accountAccountV1GetBadges.d.ts.map +1 -0
- package/funcs/{accountAccountV1Badge.js → accountAccountV1GetBadges.js} +9 -7
- package/funcs/accountAccountV1GetBadges.js.map +1 -0
- package/funcs/accountAccountV1SessionDelete.d.ts +13 -0
- package/funcs/accountAccountV1SessionDelete.d.ts.map +1 -0
- package/funcs/accountAccountV1SessionDelete.js +95 -0
- package/funcs/accountAccountV1SessionDelete.js.map +1 -0
- package/funcs/accountAccountV1SessionGet.d.ts +13 -0
- package/funcs/accountAccountV1SessionGet.d.ts.map +1 -0
- package/funcs/accountAccountV1SessionGet.js +82 -0
- package/funcs/accountAccountV1SessionGet.js.map +1 -0
- package/funcs/accountAccountV1SessionLogin.d.ts +14 -0
- package/funcs/accountAccountV1SessionLogin.d.ts.map +1 -0
- package/funcs/accountAccountV1SessionLogin.js +104 -0
- package/funcs/accountAccountV1SessionLogin.js.map +1 -0
- package/funcs/accountAccountV1SettingsGet.d.ts +13 -0
- package/funcs/accountAccountV1SettingsGet.d.ts.map +1 -0
- package/funcs/accountAccountV1SettingsGet.js +82 -0
- package/funcs/accountAccountV1SettingsGet.js.map +1 -0
- package/funcs/{accountAccountV1Apps.d.ts → accountAccountV1SettingsUpdate.d.ts} +4 -3
- package/funcs/accountAccountV1SettingsUpdate.d.ts.map +1 -0
- package/funcs/accountAccountV1SettingsUpdate.js +99 -0
- package/funcs/accountAccountV1SettingsUpdate.js.map +1 -0
- package/funcs/connectionAccountV1ConnectionConnect.d.ts +13 -0
- package/funcs/connectionAccountV1ConnectionConnect.d.ts.map +1 -0
- package/funcs/connectionAccountV1ConnectionConnect.js +95 -0
- package/funcs/connectionAccountV1ConnectionConnect.js.map +1 -0
- package/funcs/connectionAccountV1ConnectionDeleteConnection.d.ts +13 -0
- package/funcs/connectionAccountV1ConnectionDeleteConnection.d.ts.map +1 -0
- package/funcs/connectionAccountV1ConnectionDeleteConnection.js +95 -0
- package/funcs/connectionAccountV1ConnectionDeleteConnection.js.map +1 -0
- package/funcs/connectionAccountV1ConnectionUpdateConnection.d.ts +13 -0
- package/funcs/connectionAccountV1ConnectionUpdateConnection.d.ts.map +1 -0
- package/funcs/connectionAccountV1ConnectionUpdateConnection.js +95 -0
- package/funcs/connectionAccountV1ConnectionUpdateConnection.js.map +1 -0
- package/funcs/connectionAccountV1ConnectionVerifyConnection.d.ts +13 -0
- package/funcs/connectionAccountV1ConnectionVerifyConnection.d.ts.map +1 -0
- package/funcs/connectionAccountV1ConnectionVerifyConnection.js +95 -0
- package/funcs/connectionAccountV1ConnectionVerifyConnection.js.map +1 -0
- package/funcs/livenessLiveness.d.ts.map +1 -1
- package/funcs/livenessLiveness.js +4 -2
- package/funcs/livenessLiveness.js.map +1 -1
- package/funcs/sessionAccountV1SessionDelete.d.ts +13 -0
- package/funcs/sessionAccountV1SessionDelete.d.ts.map +1 -0
- package/funcs/sessionAccountV1SessionDelete.js +95 -0
- package/funcs/sessionAccountV1SessionDelete.js.map +1 -0
- package/funcs/sessionAccountV1SessionGet.d.ts +13 -0
- package/funcs/sessionAccountV1SessionGet.d.ts.map +1 -0
- package/funcs/sessionAccountV1SessionGet.js +82 -0
- package/funcs/sessionAccountV1SessionGet.js.map +1 -0
- package/funcs/sessionAccountV1SessionLogin.d.ts +14 -0
- package/funcs/sessionAccountV1SessionLogin.d.ts.map +1 -0
- package/funcs/sessionAccountV1SessionLogin.js +104 -0
- package/funcs/sessionAccountV1SessionLogin.js.map +1 -0
- package/funcs/settingsAccountV1SettingsGet.d.ts +13 -0
- package/funcs/settingsAccountV1SettingsGet.d.ts.map +1 -0
- package/funcs/settingsAccountV1SettingsGet.js +82 -0
- package/funcs/settingsAccountV1SettingsGet.js.map +1 -0
- package/funcs/settingsAccountV1SettingsUpdate.d.ts +14 -0
- package/funcs/settingsAccountV1SettingsUpdate.d.ts.map +1 -0
- package/funcs/settingsAccountV1SettingsUpdate.js +99 -0
- package/funcs/settingsAccountV1SettingsUpdate.js.map +1 -0
- package/lib/config.d.ts +6 -8
- package/lib/config.d.ts.map +1 -1
- package/lib/config.js +3 -3
- package/lib/config.js.map +1 -1
- package/lib/http.d.ts +1 -0
- package/lib/http.d.ts.map +1 -1
- package/lib/http.js +1 -0
- package/lib/http.js.map +1 -1
- package/lib/logger.d.ts +6 -0
- package/lib/logger.d.ts.map +1 -0
- package/lib/logger.js +6 -0
- package/lib/logger.js.map +1 -0
- package/lib/sdks.d.ts +2 -0
- package/lib/sdks.d.ts.map +1 -1
- package/lib/sdks.js +80 -2
- package/lib/sdks.js.map +1 -1
- package/lib/security.d.ts +2 -4
- package/lib/security.d.ts.map +1 -1
- package/lib/security.js +1 -9
- package/lib/security.js.map +1 -1
- package/models/components/connection.d.ts +108 -0
- package/models/components/connection.d.ts.map +1 -0
- package/models/components/connection.js +90 -0
- package/models/components/connection.js.map +1 -0
- package/models/components/emailnotification.d.ts +62 -0
- package/models/components/emailnotification.d.ts.map +1 -0
- package/models/components/emailnotification.js +73 -0
- package/models/components/emailnotification.js.map +1 -0
- package/models/components/image.d.ts +53 -0
- package/models/components/image.d.ts.map +1 -0
- package/models/components/image.js +60 -0
- package/models/components/image.js.map +1 -0
- package/models/components/index.d.ts +22 -1
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +22 -1
- package/models/components/index.js.map +1 -1
- package/models/components/loginrequestbody.d.ts +73 -0
- package/models/components/loginrequestbody.d.ts.map +1 -0
- package/models/components/loginrequestbody.js +99 -0
- package/models/components/loginrequestbody.js.map +1 -0
- package/models/components/security.d.ts +0 -2
- package/models/components/security.d.ts.map +1 -1
- package/models/components/security.js +0 -2
- package/models/components/security.js.map +1 -1
- package/models/components/session.d.ts +53 -0
- package/models/components/session.d.ts.map +1 -0
- package/models/components/session.js +69 -0
- package/models/components/session.js.map +1 -0
- package/models/components/v1badgesresponsebody.d.ts +31 -0
- package/models/components/v1badgesresponsebody.d.ts.map +1 -0
- package/models/components/{v1badgesappsresponsebody.js → v1badgesresponsebody.js} +11 -11
- package/models/components/v1badgesresponsebody.js.map +1 -0
- package/models/components/v1connectrequestbody.d.ts +83 -0
- package/models/components/v1connectrequestbody.d.ts.map +1 -0
- package/models/components/v1connectrequestbody.js +80 -0
- package/models/components/v1connectrequestbody.js.map +1 -0
- package/models/components/v1connectresponsebody.d.ts +38 -0
- package/models/components/v1connectresponsebody.d.ts.map +1 -0
- package/models/components/v1connectresponsebody.js +67 -0
- package/models/components/v1connectresponsebody.js.map +1 -0
- package/models/components/v1deleteconnectionrequestbody.d.ts +28 -0
- package/models/components/v1deleteconnectionrequestbody.d.ts.map +1 -0
- package/models/components/v1deleteconnectionrequestbody.js +50 -0
- package/models/components/v1deleteconnectionrequestbody.js.map +1 -0
- package/models/components/v1deleteconnectionresponsebody.d.ts +33 -0
- package/models/components/v1deleteconnectionresponsebody.d.ts.map +1 -0
- package/models/components/v1deleteconnectionresponsebody.js +65 -0
- package/models/components/v1deleteconnectionresponsebody.js.map +1 -0
- package/models/components/v1deletesessionrequestbody.d.ts +28 -0
- package/models/components/v1deletesessionrequestbody.d.ts.map +1 -0
- package/models/components/v1deletesessionrequestbody.js +50 -0
- package/models/components/v1deletesessionrequestbody.js.map +1 -0
- package/models/components/v1deletesessionresponsebody.d.ts +33 -0
- package/models/components/v1deletesessionresponsebody.d.ts.map +1 -0
- package/models/components/v1deletesessionresponsebody.js +65 -0
- package/models/components/v1deletesessionresponsebody.js.map +1 -0
- package/models/components/v1getsessionbody.d.ts +53 -0
- package/models/components/v1getsessionbody.d.ts.map +1 -0
- package/models/components/v1getsessionbody.js +76 -0
- package/models/components/v1getsessionbody.js.map +1 -0
- package/models/components/v1getsettingsbody.d.ts +129 -0
- package/models/components/v1getsettingsbody.d.ts.map +1 -0
- package/models/components/v1getsettingsbody.js +115 -0
- package/models/components/v1getsettingsbody.js.map +1 -0
- package/models/components/v1loginresponsebody.d.ts +48 -0
- package/models/components/v1loginresponsebody.d.ts.map +1 -0
- package/models/components/v1loginresponsebody.js +71 -0
- package/models/components/v1loginresponsebody.js.map +1 -0
- package/models/components/v1resource.d.ts +30 -0
- package/models/components/v1resource.d.ts.map +1 -0
- package/models/components/v1resource.js +52 -0
- package/models/components/v1resource.js.map +1 -0
- package/models/components/v1role.d.ts +40 -0
- package/models/components/v1role.d.ts.map +1 -0
- package/models/components/v1role.js +69 -0
- package/models/components/v1role.js.map +1 -0
- package/models/components/v1updateconnectionrequestbody.d.ts +33 -0
- package/models/components/v1updateconnectionrequestbody.d.ts.map +1 -0
- package/models/components/v1updateconnectionrequestbody.js +52 -0
- package/models/components/v1updateconnectionrequestbody.js.map +1 -0
- package/models/components/v1updateconnectionresponsebody.d.ts +33 -0
- package/models/components/v1updateconnectionresponsebody.d.ts.map +1 -0
- package/models/components/v1updateconnectionresponsebody.js +65 -0
- package/models/components/v1updateconnectionresponsebody.js.map +1 -0
- package/models/components/v1updatesettingsresponsebody.d.ts +33 -0
- package/models/components/v1updatesettingsresponsebody.d.ts.map +1 -0
- package/models/components/v1updatesettingsresponsebody.js +65 -0
- package/models/components/v1updatesettingsresponsebody.js.map +1 -0
- package/models/components/v1verifyconnectionrequestbody.d.ts +28 -0
- package/models/components/v1verifyconnectionrequestbody.d.ts.map +1 -0
- package/models/components/v1verifyconnectionrequestbody.js +50 -0
- package/models/components/v1verifyconnectionrequestbody.js.map +1 -0
- package/models/components/v1verifyconnectionresponsebody.d.ts +33 -0
- package/models/components/v1verifyconnectionresponsebody.d.ts.map +1 -0
- package/models/components/v1verifyconnectionresponsebody.js +65 -0
- package/models/components/v1verifyconnectionresponsebody.js.map +1 -0
- package/models/errors/index.d.ts +1 -0
- package/models/errors/index.d.ts.map +1 -1
- package/models/errors/index.js +1 -0
- package/models/errors/index.js.map +1 -1
- package/models/errors/sdkvalidationerror.d.ts +4 -1
- package/models/errors/sdkvalidationerror.d.ts.map +1 -1
- package/models/errors/sdkvalidationerror.js +3 -5
- package/models/errors/sdkvalidationerror.js.map +1 -1
- package/models/operations/accountv1sessionlogin.d.ts +30 -0
- package/models/operations/accountv1sessionlogin.d.ts.map +1 -0
- package/models/operations/accountv1sessionlogin.js +72 -0
- package/models/operations/accountv1sessionlogin.js.map +1 -0
- package/models/operations/accountv1settingsupdate.d.ts +25 -0
- package/models/operations/accountv1settingsupdate.d.ts.map +1 -0
- package/models/operations/accountv1settingsupdate.js +63 -0
- package/models/operations/accountv1settingsupdate.js.map +1 -0
- package/models/operations/index.d.ts +3 -0
- package/models/operations/index.d.ts.map +1 -0
- package/models/operations/index.js +22 -0
- package/models/operations/index.js.map +1 -0
- package/package.json +2 -2
- package/sdk/account.d.ts +39 -2
- package/sdk/account.d.ts.map +1 -1
- package/sdk/account.js +69 -6
- package/sdk/account.js.map +1 -1
- package/sdk/connection.d.ts +21 -0
- package/sdk/connection.d.ts.map +1 -0
- package/sdk/connection.js +40 -0
- package/sdk/connection.js.map +1 -0
- package/sdk/sdk.d.ts +9 -0
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +15 -0
- package/sdk/sdk.js.map +1 -1
- package/sdk/session.d.ts +18 -0
- package/sdk/session.d.ts.map +1 -0
- package/sdk/session.js +33 -0
- package/sdk/session.js.map +1 -0
- package/sdk/settings.d.ts +14 -0
- package/sdk/settings.d.ts.map +1 -0
- package/sdk/settings.js +26 -0
- package/sdk/settings.js.map +1 -0
- package/src/funcs/accountAccountV1ConnectionConnect.ts +129 -0
- package/src/funcs/accountAccountV1ConnectionDeleteConnection.ts +129 -0
- package/src/funcs/accountAccountV1ConnectionUpdateConnection.ts +129 -0
- package/src/funcs/accountAccountV1ConnectionVerifyConnection.ts +129 -0
- package/src/funcs/{accountAccountV1Apps.ts → accountAccountV1GetApps.ts} +6 -4
- package/src/funcs/{accountAccountV1Badge.ts → accountAccountV1GetBadges.ts} +9 -7
- package/src/funcs/accountAccountV1SessionDelete.ts +129 -0
- package/src/funcs/accountAccountV1SessionGet.ts +109 -0
- package/src/funcs/accountAccountV1SessionLogin.ts +138 -0
- package/src/funcs/accountAccountV1SettingsGet.ts +109 -0
- package/src/funcs/accountAccountV1SettingsUpdate.ts +133 -0
- package/src/funcs/connectionAccountV1ConnectionConnect.ts +129 -0
- package/src/funcs/connectionAccountV1ConnectionDeleteConnection.ts +129 -0
- package/src/funcs/connectionAccountV1ConnectionUpdateConnection.ts +129 -0
- package/src/funcs/connectionAccountV1ConnectionVerifyConnection.ts +129 -0
- package/src/funcs/livenessLiveness.ts +4 -2
- package/src/funcs/sessionAccountV1SessionDelete.ts +129 -0
- package/src/funcs/sessionAccountV1SessionGet.ts +109 -0
- package/src/funcs/sessionAccountV1SessionLogin.ts +138 -0
- package/src/funcs/settingsAccountV1SettingsGet.ts +109 -0
- package/src/funcs/settingsAccountV1SettingsUpdate.ts +133 -0
- package/src/lib/config.ts +6 -8
- package/src/lib/http.ts +1 -1
- package/src/lib/logger.ts +9 -0
- package/src/lib/sdks.ts +100 -4
- package/src/lib/security.ts +3 -9
- package/src/models/components/connection.ts +121 -0
- package/src/models/components/emailnotification.ts +81 -0
- package/src/models/components/image.ts +75 -0
- package/src/models/components/index.ts +22 -1
- package/src/models/components/loginrequestbody.ts +138 -0
- package/src/models/components/security.ts +0 -4
- package/src/models/components/session.ts +84 -0
- package/src/models/components/{v1badgesappsresponsebody.ts → v1badgesresponsebody.ts} +14 -14
- package/src/models/components/v1connectrequestbody.ts +91 -0
- package/src/models/components/v1connectresponsebody.ts +75 -0
- package/src/models/components/v1deleteconnectionrequestbody.ts +48 -0
- package/src/models/components/v1deleteconnectionresponsebody.ts +68 -0
- package/src/models/components/v1deletesessionrequestbody.ts +48 -0
- package/src/models/components/v1deletesessionresponsebody.ts +68 -0
- package/src/models/components/v1getsessionbody.ts +102 -0
- package/src/models/components/v1getsettingsbody.ts +198 -0
- package/src/models/components/v1loginresponsebody.ts +89 -0
- package/src/models/components/v1resource.ts +45 -0
- package/src/models/components/v1role.ts +71 -0
- package/src/models/components/v1updateconnectionrequestbody.ts +55 -0
- package/src/models/components/v1updateconnectionresponsebody.ts +68 -0
- package/src/models/components/v1updatesettingsresponsebody.ts +68 -0
- package/src/models/components/v1verifyconnectionrequestbody.ts +48 -0
- package/src/models/components/v1verifyconnectionresponsebody.ts +68 -0
- package/src/models/errors/index.ts +1 -0
- package/src/models/errors/sdkvalidationerror.ts +8 -6
- package/src/models/operations/accountv1sessionlogin.ts +71 -0
- package/src/models/operations/accountv1settingsupdate.ts +58 -0
- package/src/models/operations/index.ts +6 -0
- package/src/sdk/account.ts +102 -6
- package/src/sdk/connection.ts +53 -0
- package/src/sdk/sdk.ts +18 -0
- package/src/sdk/session.ts +40 -0
- package/src/sdk/settings.ts +29 -0
- package/src/types/constdatetime.ts +15 -0
- package/types/constdatetime.d.ts +3 -0
- package/types/constdatetime.d.ts.map +1 -0
- package/types/constdatetime.js +36 -0
- package/types/constdatetime.js.map +1 -0
- package/funcs/accountAccountV1Apps.d.ts.map +0 -1
- package/funcs/accountAccountV1Apps.js.map +0 -1
- package/funcs/accountAccountV1Badge.d.ts.map +0 -1
- package/funcs/accountAccountV1Badge.js.map +0 -1
- package/models/components/v1badgesappsresponsebody.d.ts +0 -31
- package/models/components/v1badgesappsresponsebody.d.ts.map +0 -1
- package/models/components/v1badgesappsresponsebody.js.map +0 -1
|
@@ -1,12 +1,261 @@
|
|
|
1
1
|
# Account
|
|
2
2
|
(*account*)
|
|
3
3
|
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
Account related operations
|
|
7
|
+
|
|
4
8
|
### Available Operations
|
|
5
9
|
|
|
6
|
-
* [
|
|
7
|
-
* [
|
|
10
|
+
* [accountV1ConnectionConnect](#accountv1connectionconnect) - Connect a new Social Provider
|
|
11
|
+
* [accountV1ConnectionDeleteConnection](#accountv1connectiondeleteconnection) - Remove a connection
|
|
12
|
+
* [accountV1SessionDelete](#accountv1sessiondelete) - Deletes a session, can also be used to logout
|
|
13
|
+
* [accountV1GetApps](#accountv1getapps) - Get Account Apps
|
|
14
|
+
* [accountV1GetBadges](#accountv1getbadges) - Get Account Badges
|
|
15
|
+
* [accountV1SessionGet](#accountv1sessionget) - Gets all session data
|
|
16
|
+
* [accountV1SettingsGet](#accountv1settingsget) - Gets all settings for the account
|
|
17
|
+
* [accountV1SessionLogin](#accountv1sessionlogin) - Logs a user in and creates a new session
|
|
18
|
+
* [accountV1ConnectionUpdateConnection](#accountv1connectionupdateconnection) - Make a connection visible/invisible
|
|
19
|
+
* [accountV1SettingsUpdate](#accountv1settingsupdate) - Update settings for the logged in account
|
|
20
|
+
* [accountV1ConnectionVerifyConnection](#accountv1connectionverifyconnection) - Verify a domain connection only atm
|
|
21
|
+
|
|
22
|
+
## accountV1ConnectionConnect
|
|
23
|
+
|
|
24
|
+
Connect a new Social Provider
|
|
25
|
+
|
|
26
|
+
### Example Usage
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
30
|
+
|
|
31
|
+
const steamSets = new SteamSets({
|
|
32
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
33
|
+
});
|
|
34
|
+
|
|
35
|
+
async function run() {
|
|
36
|
+
const result = await steamSets.account.accountV1ConnectionConnect({
|
|
37
|
+
code: "123456",
|
|
38
|
+
provider: "discord",
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
// Handle the result
|
|
42
|
+
console.log(result)
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
run();
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
### Standalone function
|
|
50
|
+
|
|
51
|
+
The standalone function version of this method:
|
|
52
|
+
|
|
53
|
+
```typescript
|
|
54
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
55
|
+
import { accountAccountV1ConnectionConnect } from "@steamsets/client-ts/funcs/accountAccountV1ConnectionConnect.js";
|
|
56
|
+
|
|
57
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
58
|
+
// You can create one instance of it to use across an application.
|
|
59
|
+
const steamSets = new SteamSetsCore({
|
|
60
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
61
|
+
});
|
|
62
|
+
|
|
63
|
+
async function run() {
|
|
64
|
+
const res = await accountAccountV1ConnectionConnect(steamSets, {
|
|
65
|
+
code: "123456",
|
|
66
|
+
provider: "discord",
|
|
67
|
+
});
|
|
68
|
+
|
|
69
|
+
if (!res.ok) {
|
|
70
|
+
throw res.error;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
const { value: result } = res;
|
|
74
|
+
|
|
75
|
+
// Handle the result
|
|
76
|
+
console.log(result)
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
run();
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Parameters
|
|
83
|
+
|
|
84
|
+
| Parameter | Type | Required | Description |
|
|
85
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
86
|
+
| `request` | [components.V1ConnectRequestBody](../../models/components/v1connectrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
87
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
88
|
+
| `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. |
|
|
89
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
### Response
|
|
93
|
+
|
|
94
|
+
**Promise\<[components.V1ConnectResponseBody](../../models/components/v1connectresponsebody.md)\>**
|
|
95
|
+
### Errors
|
|
96
|
+
|
|
97
|
+
| Error Object | Status Code | Content Type |
|
|
98
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
99
|
+
| errors.ErrorModel | 400,422,500 | application/problem+json |
|
|
100
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
101
|
+
|
|
102
|
+
## accountV1ConnectionDeleteConnection
|
|
103
|
+
|
|
104
|
+
Remove a connection
|
|
105
|
+
|
|
106
|
+
### Example Usage
|
|
107
|
+
|
|
108
|
+
```typescript
|
|
109
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
110
|
+
|
|
111
|
+
const steamSets = new SteamSets({
|
|
112
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
113
|
+
});
|
|
114
|
+
|
|
115
|
+
async function run() {
|
|
116
|
+
const result = await steamSets.account.accountV1ConnectionDeleteConnection({
|
|
117
|
+
connectionId: "123456",
|
|
118
|
+
});
|
|
119
|
+
|
|
120
|
+
// Handle the result
|
|
121
|
+
console.log(result)
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
run();
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
### Standalone function
|
|
129
|
+
|
|
130
|
+
The standalone function version of this method:
|
|
131
|
+
|
|
132
|
+
```typescript
|
|
133
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
134
|
+
import { accountAccountV1ConnectionDeleteConnection } from "@steamsets/client-ts/funcs/accountAccountV1ConnectionDeleteConnection.js";
|
|
135
|
+
|
|
136
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
137
|
+
// You can create one instance of it to use across an application.
|
|
138
|
+
const steamSets = new SteamSetsCore({
|
|
139
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
140
|
+
});
|
|
141
|
+
|
|
142
|
+
async function run() {
|
|
143
|
+
const res = await accountAccountV1ConnectionDeleteConnection(steamSets, {
|
|
144
|
+
connectionId: "123456",
|
|
145
|
+
});
|
|
146
|
+
|
|
147
|
+
if (!res.ok) {
|
|
148
|
+
throw res.error;
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
const { value: result } = res;
|
|
152
|
+
|
|
153
|
+
// Handle the result
|
|
154
|
+
console.log(result)
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
run();
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### Parameters
|
|
161
|
+
|
|
162
|
+
| Parameter | Type | Required | Description |
|
|
163
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
164
|
+
| `request` | [components.V1DeleteConnectionRequestBody](../../models/components/v1deleteconnectionrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
165
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
166
|
+
| `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. |
|
|
167
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
### Response
|
|
171
|
+
|
|
172
|
+
**Promise\<[components.V1DeleteConnectionResponseBody](../../models/components/v1deleteconnectionresponsebody.md)\>**
|
|
173
|
+
### Errors
|
|
174
|
+
|
|
175
|
+
| Error Object | Status Code | Content Type |
|
|
176
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
177
|
+
| errors.ErrorModel | 400,422,500 | application/problem+json |
|
|
178
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
179
|
+
|
|
180
|
+
## accountV1SessionDelete
|
|
181
|
+
|
|
182
|
+
Deletes a session, can also be used to logout
|
|
183
|
+
|
|
184
|
+
### Example Usage
|
|
185
|
+
|
|
186
|
+
```typescript
|
|
187
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
188
|
+
|
|
189
|
+
const steamSets = new SteamSets({
|
|
190
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
191
|
+
});
|
|
192
|
+
|
|
193
|
+
async function run() {
|
|
194
|
+
const result = await steamSets.account.accountV1SessionDelete({
|
|
195
|
+
sessionId: "123456",
|
|
196
|
+
});
|
|
197
|
+
|
|
198
|
+
// Handle the result
|
|
199
|
+
console.log(result)
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
run();
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
### Standalone function
|
|
207
|
+
|
|
208
|
+
The standalone function version of this method:
|
|
209
|
+
|
|
210
|
+
```typescript
|
|
211
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
212
|
+
import { accountAccountV1SessionDelete } from "@steamsets/client-ts/funcs/accountAccountV1SessionDelete.js";
|
|
213
|
+
|
|
214
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
215
|
+
// You can create one instance of it to use across an application.
|
|
216
|
+
const steamSets = new SteamSetsCore({
|
|
217
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
218
|
+
});
|
|
219
|
+
|
|
220
|
+
async function run() {
|
|
221
|
+
const res = await accountAccountV1SessionDelete(steamSets, {
|
|
222
|
+
sessionId: "123456",
|
|
223
|
+
});
|
|
224
|
+
|
|
225
|
+
if (!res.ok) {
|
|
226
|
+
throw res.error;
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
const { value: result } = res;
|
|
230
|
+
|
|
231
|
+
// Handle the result
|
|
232
|
+
console.log(result)
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
run();
|
|
236
|
+
```
|
|
237
|
+
|
|
238
|
+
### Parameters
|
|
239
|
+
|
|
240
|
+
| Parameter | Type | Required | Description |
|
|
241
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
242
|
+
| `request` | [components.V1DeleteSessionRequestBody](../../models/components/v1deletesessionrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
243
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
244
|
+
| `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. |
|
|
245
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
### Response
|
|
249
|
+
|
|
250
|
+
**Promise\<[components.V1DeleteSessionResponseBody](../../models/components/v1deletesessionresponsebody.md)\>**
|
|
251
|
+
### Errors
|
|
252
|
+
|
|
253
|
+
| Error Object | Status Code | Content Type |
|
|
254
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
255
|
+
| errors.ErrorModel | 404,422,500 | application/problem+json |
|
|
256
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
8
257
|
|
|
9
|
-
##
|
|
258
|
+
## accountV1GetApps
|
|
10
259
|
|
|
11
260
|
Get Account Apps
|
|
12
261
|
|
|
@@ -16,14 +265,42 @@ Get Account Apps
|
|
|
16
265
|
import { SteamSets } from "@steamsets/client-ts";
|
|
17
266
|
|
|
18
267
|
const steamSets = new SteamSets({
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
268
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
269
|
+
});
|
|
270
|
+
|
|
271
|
+
async function run() {
|
|
272
|
+
const result = await steamSets.account.accountV1GetApps();
|
|
273
|
+
|
|
274
|
+
// Handle the result
|
|
275
|
+
console.log(result)
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
run();
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
### Standalone function
|
|
283
|
+
|
|
284
|
+
The standalone function version of this method:
|
|
285
|
+
|
|
286
|
+
```typescript
|
|
287
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
288
|
+
import { accountAccountV1GetApps } from "@steamsets/client-ts/funcs/accountAccountV1GetApps.js";
|
|
289
|
+
|
|
290
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
291
|
+
// You can create one instance of it to use across an application.
|
|
292
|
+
const steamSets = new SteamSetsCore({
|
|
293
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
23
294
|
});
|
|
24
295
|
|
|
25
296
|
async function run() {
|
|
26
|
-
const
|
|
297
|
+
const res = await accountAccountV1GetApps(steamSets);
|
|
298
|
+
|
|
299
|
+
if (!res.ok) {
|
|
300
|
+
throw res.error;
|
|
301
|
+
}
|
|
302
|
+
|
|
303
|
+
const { value: result } = res;
|
|
27
304
|
|
|
28
305
|
// Handle the result
|
|
29
306
|
console.log(result)
|
|
@@ -51,7 +328,7 @@ run();
|
|
|
51
328
|
| errors.ErrorModel | 400,500 | application/problem+json |
|
|
52
329
|
| errors.SDKError | 4xx-5xx | */* |
|
|
53
330
|
|
|
54
|
-
##
|
|
331
|
+
## accountV1GetBadges
|
|
55
332
|
|
|
56
333
|
Get Account Badges
|
|
57
334
|
|
|
@@ -61,14 +338,42 @@ Get Account Badges
|
|
|
61
338
|
import { SteamSets } from "@steamsets/client-ts";
|
|
62
339
|
|
|
63
340
|
const steamSets = new SteamSets({
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
341
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
342
|
+
});
|
|
343
|
+
|
|
344
|
+
async function run() {
|
|
345
|
+
const result = await steamSets.account.accountV1GetBadges();
|
|
346
|
+
|
|
347
|
+
// Handle the result
|
|
348
|
+
console.log(result)
|
|
349
|
+
}
|
|
350
|
+
|
|
351
|
+
run();
|
|
352
|
+
```
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
### Standalone function
|
|
356
|
+
|
|
357
|
+
The standalone function version of this method:
|
|
358
|
+
|
|
359
|
+
```typescript
|
|
360
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
361
|
+
import { accountAccountV1GetBadges } from "@steamsets/client-ts/funcs/accountAccountV1GetBadges.js";
|
|
362
|
+
|
|
363
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
364
|
+
// You can create one instance of it to use across an application.
|
|
365
|
+
const steamSets = new SteamSetsCore({
|
|
366
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
68
367
|
});
|
|
69
368
|
|
|
70
369
|
async function run() {
|
|
71
|
-
const
|
|
370
|
+
const res = await accountAccountV1GetBadges(steamSets);
|
|
371
|
+
|
|
372
|
+
if (!res.ok) {
|
|
373
|
+
throw res.error;
|
|
374
|
+
}
|
|
375
|
+
|
|
376
|
+
const { value: result } = res;
|
|
72
377
|
|
|
73
378
|
// Handle the result
|
|
74
379
|
console.log(result)
|
|
@@ -88,10 +393,488 @@ run();
|
|
|
88
393
|
|
|
89
394
|
### Response
|
|
90
395
|
|
|
91
|
-
**Promise\<[components.
|
|
396
|
+
**Promise\<[components.V1BadgesResponseBody](../../models/components/v1badgesresponsebody.md)\>**
|
|
92
397
|
### Errors
|
|
93
398
|
|
|
94
399
|
| Error Object | Status Code | Content Type |
|
|
95
400
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
96
401
|
| errors.ErrorModel | 400,500 | application/problem+json |
|
|
97
402
|
| errors.SDKError | 4xx-5xx | */* |
|
|
403
|
+
|
|
404
|
+
## accountV1SessionGet
|
|
405
|
+
|
|
406
|
+
Gets all session data
|
|
407
|
+
|
|
408
|
+
### Example Usage
|
|
409
|
+
|
|
410
|
+
```typescript
|
|
411
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
412
|
+
|
|
413
|
+
const steamSets = new SteamSets({
|
|
414
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
415
|
+
});
|
|
416
|
+
|
|
417
|
+
async function run() {
|
|
418
|
+
const result = await steamSets.account.accountV1SessionGet();
|
|
419
|
+
|
|
420
|
+
// Handle the result
|
|
421
|
+
console.log(result)
|
|
422
|
+
}
|
|
423
|
+
|
|
424
|
+
run();
|
|
425
|
+
```
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
### Standalone function
|
|
429
|
+
|
|
430
|
+
The standalone function version of this method:
|
|
431
|
+
|
|
432
|
+
```typescript
|
|
433
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
434
|
+
import { accountAccountV1SessionGet } from "@steamsets/client-ts/funcs/accountAccountV1SessionGet.js";
|
|
435
|
+
|
|
436
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
437
|
+
// You can create one instance of it to use across an application.
|
|
438
|
+
const steamSets = new SteamSetsCore({
|
|
439
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
440
|
+
});
|
|
441
|
+
|
|
442
|
+
async function run() {
|
|
443
|
+
const res = await accountAccountV1SessionGet(steamSets);
|
|
444
|
+
|
|
445
|
+
if (!res.ok) {
|
|
446
|
+
throw res.error;
|
|
447
|
+
}
|
|
448
|
+
|
|
449
|
+
const { value: result } = res;
|
|
450
|
+
|
|
451
|
+
// Handle the result
|
|
452
|
+
console.log(result)
|
|
453
|
+
}
|
|
454
|
+
|
|
455
|
+
run();
|
|
456
|
+
```
|
|
457
|
+
|
|
458
|
+
### Parameters
|
|
459
|
+
|
|
460
|
+
| Parameter | Type | Required | Description |
|
|
461
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
462
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
463
|
+
| `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. |
|
|
464
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
### Response
|
|
468
|
+
|
|
469
|
+
**Promise\<[components.V1GetSessionBody](../../models/components/v1getsessionbody.md)\>**
|
|
470
|
+
### Errors
|
|
471
|
+
|
|
472
|
+
| Error Object | Status Code | Content Type |
|
|
473
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
474
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
475
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
476
|
+
|
|
477
|
+
## accountV1SettingsGet
|
|
478
|
+
|
|
479
|
+
Gets all settings for the account
|
|
480
|
+
|
|
481
|
+
### Example Usage
|
|
482
|
+
|
|
483
|
+
```typescript
|
|
484
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
485
|
+
|
|
486
|
+
const steamSets = new SteamSets({
|
|
487
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
488
|
+
});
|
|
489
|
+
|
|
490
|
+
async function run() {
|
|
491
|
+
const result = await steamSets.account.accountV1SettingsGet();
|
|
492
|
+
|
|
493
|
+
// Handle the result
|
|
494
|
+
console.log(result)
|
|
495
|
+
}
|
|
496
|
+
|
|
497
|
+
run();
|
|
498
|
+
```
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
### Standalone function
|
|
502
|
+
|
|
503
|
+
The standalone function version of this method:
|
|
504
|
+
|
|
505
|
+
```typescript
|
|
506
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
507
|
+
import { accountAccountV1SettingsGet } from "@steamsets/client-ts/funcs/accountAccountV1SettingsGet.js";
|
|
508
|
+
|
|
509
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
510
|
+
// You can create one instance of it to use across an application.
|
|
511
|
+
const steamSets = new SteamSetsCore({
|
|
512
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
513
|
+
});
|
|
514
|
+
|
|
515
|
+
async function run() {
|
|
516
|
+
const res = await accountAccountV1SettingsGet(steamSets);
|
|
517
|
+
|
|
518
|
+
if (!res.ok) {
|
|
519
|
+
throw res.error;
|
|
520
|
+
}
|
|
521
|
+
|
|
522
|
+
const { value: result } = res;
|
|
523
|
+
|
|
524
|
+
// Handle the result
|
|
525
|
+
console.log(result)
|
|
526
|
+
}
|
|
527
|
+
|
|
528
|
+
run();
|
|
529
|
+
```
|
|
530
|
+
|
|
531
|
+
### Parameters
|
|
532
|
+
|
|
533
|
+
| Parameter | Type | Required | Description |
|
|
534
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
535
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
536
|
+
| `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. |
|
|
537
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
### Response
|
|
541
|
+
|
|
542
|
+
**Promise\<[components.V1GetSettingsBody](../../models/components/v1getsettingsbody.md)\>**
|
|
543
|
+
### Errors
|
|
544
|
+
|
|
545
|
+
| Error Object | Status Code | Content Type |
|
|
546
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
547
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
548
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
549
|
+
|
|
550
|
+
## accountV1SessionLogin
|
|
551
|
+
|
|
552
|
+
Logs a user in and creates a new session
|
|
553
|
+
|
|
554
|
+
### Example Usage
|
|
555
|
+
|
|
556
|
+
```typescript
|
|
557
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
558
|
+
|
|
559
|
+
const steamSets = new SteamSets({
|
|
560
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
561
|
+
});
|
|
562
|
+
|
|
563
|
+
async function run() {
|
|
564
|
+
const result = await steamSets.account.accountV1SessionLogin({
|
|
565
|
+
loginRequestBody: {
|
|
566
|
+
openidAssocHandle: "123456",
|
|
567
|
+
openidClaimedId: "76561198842603734",
|
|
568
|
+
openidIdentity: "https://steamsets.com/api/v1/openid/login",
|
|
569
|
+
openidMode: "checkid_setup",
|
|
570
|
+
openidNs: "http://specs.openid.net/auth/2.0",
|
|
571
|
+
openidOpEndpoint: "https://steamsets.com/api/v1/openid/login",
|
|
572
|
+
openidResponseNonce: "123456",
|
|
573
|
+
openidReturnTo: "https://steamsets.com/api/v1/openid/login",
|
|
574
|
+
openidSig: "123456",
|
|
575
|
+
openidSigned: "123456",
|
|
576
|
+
},
|
|
577
|
+
});
|
|
578
|
+
|
|
579
|
+
// Handle the result
|
|
580
|
+
console.log(result)
|
|
581
|
+
}
|
|
582
|
+
|
|
583
|
+
run();
|
|
584
|
+
```
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
### Standalone function
|
|
588
|
+
|
|
589
|
+
The standalone function version of this method:
|
|
590
|
+
|
|
591
|
+
```typescript
|
|
592
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
593
|
+
import { accountAccountV1SessionLogin } from "@steamsets/client-ts/funcs/accountAccountV1SessionLogin.js";
|
|
594
|
+
|
|
595
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
596
|
+
// You can create one instance of it to use across an application.
|
|
597
|
+
const steamSets = new SteamSetsCore({
|
|
598
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
599
|
+
});
|
|
600
|
+
|
|
601
|
+
async function run() {
|
|
602
|
+
const res = await accountAccountV1SessionLogin(steamSets, {
|
|
603
|
+
loginRequestBody: {
|
|
604
|
+
openidAssocHandle: "123456",
|
|
605
|
+
openidClaimedId: "76561198842603734",
|
|
606
|
+
openidIdentity: "https://steamsets.com/api/v1/openid/login",
|
|
607
|
+
openidMode: "checkid_setup",
|
|
608
|
+
openidNs: "http://specs.openid.net/auth/2.0",
|
|
609
|
+
openidOpEndpoint: "https://steamsets.com/api/v1/openid/login",
|
|
610
|
+
openidResponseNonce: "123456",
|
|
611
|
+
openidReturnTo: "https://steamsets.com/api/v1/openid/login",
|
|
612
|
+
openidSig: "123456",
|
|
613
|
+
openidSigned: "123456",
|
|
614
|
+
},
|
|
615
|
+
});
|
|
616
|
+
|
|
617
|
+
if (!res.ok) {
|
|
618
|
+
throw res.error;
|
|
619
|
+
}
|
|
620
|
+
|
|
621
|
+
const { value: result } = res;
|
|
622
|
+
|
|
623
|
+
// Handle the result
|
|
624
|
+
console.log(result)
|
|
625
|
+
}
|
|
626
|
+
|
|
627
|
+
run();
|
|
628
|
+
```
|
|
629
|
+
|
|
630
|
+
### Parameters
|
|
631
|
+
|
|
632
|
+
| Parameter | Type | Required | Description |
|
|
633
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
634
|
+
| `request` | [operations.AccountV1SessionLoginRequest](../../models/operations/accountv1sessionloginrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
635
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
636
|
+
| `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. |
|
|
637
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
### Response
|
|
641
|
+
|
|
642
|
+
**Promise\<[components.V1LoginResponseBody](../../models/components/v1loginresponsebody.md)\>**
|
|
643
|
+
### Errors
|
|
644
|
+
|
|
645
|
+
| Error Object | Status Code | Content Type |
|
|
646
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
647
|
+
| errors.ErrorModel | 422,500 | application/problem+json |
|
|
648
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
649
|
+
|
|
650
|
+
## accountV1ConnectionUpdateConnection
|
|
651
|
+
|
|
652
|
+
Make a connection visible/invisible
|
|
653
|
+
|
|
654
|
+
### Example Usage
|
|
655
|
+
|
|
656
|
+
```typescript
|
|
657
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
658
|
+
|
|
659
|
+
const steamSets = new SteamSets({
|
|
660
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
661
|
+
});
|
|
662
|
+
|
|
663
|
+
async function run() {
|
|
664
|
+
const result = await steamSets.account.accountV1ConnectionUpdateConnection({
|
|
665
|
+
connectionId: "123456",
|
|
666
|
+
hiddem: true,
|
|
667
|
+
});
|
|
668
|
+
|
|
669
|
+
// Handle the result
|
|
670
|
+
console.log(result)
|
|
671
|
+
}
|
|
672
|
+
|
|
673
|
+
run();
|
|
674
|
+
```
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
### Standalone function
|
|
678
|
+
|
|
679
|
+
The standalone function version of this method:
|
|
680
|
+
|
|
681
|
+
```typescript
|
|
682
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
683
|
+
import { accountAccountV1ConnectionUpdateConnection } from "@steamsets/client-ts/funcs/accountAccountV1ConnectionUpdateConnection.js";
|
|
684
|
+
|
|
685
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
686
|
+
// You can create one instance of it to use across an application.
|
|
687
|
+
const steamSets = new SteamSetsCore({
|
|
688
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
689
|
+
});
|
|
690
|
+
|
|
691
|
+
async function run() {
|
|
692
|
+
const res = await accountAccountV1ConnectionUpdateConnection(steamSets, {
|
|
693
|
+
connectionId: "123456",
|
|
694
|
+
hiddem: true,
|
|
695
|
+
});
|
|
696
|
+
|
|
697
|
+
if (!res.ok) {
|
|
698
|
+
throw res.error;
|
|
699
|
+
}
|
|
700
|
+
|
|
701
|
+
const { value: result } = res;
|
|
702
|
+
|
|
703
|
+
// Handle the result
|
|
704
|
+
console.log(result)
|
|
705
|
+
}
|
|
706
|
+
|
|
707
|
+
run();
|
|
708
|
+
```
|
|
709
|
+
|
|
710
|
+
### Parameters
|
|
711
|
+
|
|
712
|
+
| Parameter | Type | Required | Description |
|
|
713
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
714
|
+
| `request` | [components.V1UpdateConnectionRequestBody](../../models/components/v1updateconnectionrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
715
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
716
|
+
| `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. |
|
|
717
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
### Response
|
|
721
|
+
|
|
722
|
+
**Promise\<[components.V1UpdateConnectionResponseBody](../../models/components/v1updateconnectionresponsebody.md)\>**
|
|
723
|
+
### Errors
|
|
724
|
+
|
|
725
|
+
| Error Object | Status Code | Content Type |
|
|
726
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
727
|
+
| errors.ErrorModel | 400,404,422,500 | application/problem+json |
|
|
728
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
729
|
+
|
|
730
|
+
## accountV1SettingsUpdate
|
|
731
|
+
|
|
732
|
+
Update settings for the logged in account
|
|
733
|
+
|
|
734
|
+
### Example Usage
|
|
735
|
+
|
|
736
|
+
```typescript
|
|
737
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
738
|
+
|
|
739
|
+
const steamSets = new SteamSets({
|
|
740
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
741
|
+
});
|
|
742
|
+
|
|
743
|
+
async function run() {
|
|
744
|
+
const result = await steamSets.account.accountV1SettingsUpdate({});
|
|
745
|
+
|
|
746
|
+
// Handle the result
|
|
747
|
+
console.log(result)
|
|
748
|
+
}
|
|
749
|
+
|
|
750
|
+
run();
|
|
751
|
+
```
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
### Standalone function
|
|
755
|
+
|
|
756
|
+
The standalone function version of this method:
|
|
757
|
+
|
|
758
|
+
```typescript
|
|
759
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
760
|
+
import { accountAccountV1SettingsUpdate } from "@steamsets/client-ts/funcs/accountAccountV1SettingsUpdate.js";
|
|
761
|
+
|
|
762
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
763
|
+
// You can create one instance of it to use across an application.
|
|
764
|
+
const steamSets = new SteamSetsCore({
|
|
765
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
766
|
+
});
|
|
767
|
+
|
|
768
|
+
async function run() {
|
|
769
|
+
const res = await accountAccountV1SettingsUpdate(steamSets, {});
|
|
770
|
+
|
|
771
|
+
if (!res.ok) {
|
|
772
|
+
throw res.error;
|
|
773
|
+
}
|
|
774
|
+
|
|
775
|
+
const { value: result } = res;
|
|
776
|
+
|
|
777
|
+
// Handle the result
|
|
778
|
+
console.log(result)
|
|
779
|
+
}
|
|
780
|
+
|
|
781
|
+
run();
|
|
782
|
+
```
|
|
783
|
+
|
|
784
|
+
### Parameters
|
|
785
|
+
|
|
786
|
+
| Parameter | Type | Required | Description |
|
|
787
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
788
|
+
| `request` | [operations.AccountV1SettingsUpdateRequest](../../models/operations/accountv1settingsupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
789
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
790
|
+
| `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. |
|
|
791
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
### Response
|
|
795
|
+
|
|
796
|
+
**Promise\<[components.V1UpdateSettingsResponseBody](../../models/components/v1updatesettingsresponsebody.md)\>**
|
|
797
|
+
### Errors
|
|
798
|
+
|
|
799
|
+
| Error Object | Status Code | Content Type |
|
|
800
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
801
|
+
| errors.ErrorModel | 422,429,500 | application/problem+json |
|
|
802
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
803
|
+
|
|
804
|
+
## accountV1ConnectionVerifyConnection
|
|
805
|
+
|
|
806
|
+
Verify a domain connection only atm
|
|
807
|
+
|
|
808
|
+
### Example Usage
|
|
809
|
+
|
|
810
|
+
```typescript
|
|
811
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
812
|
+
|
|
813
|
+
const steamSets = new SteamSets({
|
|
814
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
815
|
+
});
|
|
816
|
+
|
|
817
|
+
async function run() {
|
|
818
|
+
const result = await steamSets.account.accountV1ConnectionVerifyConnection({
|
|
819
|
+
connectionId: "123456",
|
|
820
|
+
});
|
|
821
|
+
|
|
822
|
+
// Handle the result
|
|
823
|
+
console.log(result)
|
|
824
|
+
}
|
|
825
|
+
|
|
826
|
+
run();
|
|
827
|
+
```
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
### Standalone function
|
|
831
|
+
|
|
832
|
+
The standalone function version of this method:
|
|
833
|
+
|
|
834
|
+
```typescript
|
|
835
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
836
|
+
import { accountAccountV1ConnectionVerifyConnection } from "@steamsets/client-ts/funcs/accountAccountV1ConnectionVerifyConnection.js";
|
|
837
|
+
|
|
838
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
839
|
+
// You can create one instance of it to use across an application.
|
|
840
|
+
const steamSets = new SteamSetsCore({
|
|
841
|
+
session: "<YOUR_API_KEY_HERE>",
|
|
842
|
+
});
|
|
843
|
+
|
|
844
|
+
async function run() {
|
|
845
|
+
const res = await accountAccountV1ConnectionVerifyConnection(steamSets, {
|
|
846
|
+
connectionId: "123456",
|
|
847
|
+
});
|
|
848
|
+
|
|
849
|
+
if (!res.ok) {
|
|
850
|
+
throw res.error;
|
|
851
|
+
}
|
|
852
|
+
|
|
853
|
+
const { value: result } = res;
|
|
854
|
+
|
|
855
|
+
// Handle the result
|
|
856
|
+
console.log(result)
|
|
857
|
+
}
|
|
858
|
+
|
|
859
|
+
run();
|
|
860
|
+
```
|
|
861
|
+
|
|
862
|
+
### Parameters
|
|
863
|
+
|
|
864
|
+
| Parameter | Type | Required | Description |
|
|
865
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
866
|
+
| `request` | [components.V1VerifyConnectionRequestBody](../../models/components/v1verifyconnectionrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
867
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
868
|
+
| `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. |
|
|
869
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
### Response
|
|
873
|
+
|
|
874
|
+
**Promise\<[components.V1VerifyConnectionResponseBody](../../models/components/v1verifyconnectionresponsebody.md)\>**
|
|
875
|
+
### Errors
|
|
876
|
+
|
|
877
|
+
| Error Object | Status Code | Content Type |
|
|
878
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
879
|
+
| errors.ErrorModel | 400,422,500 | application/problem+json |
|
|
880
|
+
| errors.SDKError | 4xx-5xx | */* |
|