@steamsets/client-ts 0.5.0 → 0.5.2
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 +75 -9
- package/docs/sdks/account/README.md +383 -76
- package/docs/sdks/data/README.md +473 -0
- package/docs/sdks/location/README.md +80 -0
- package/docs/sdks/public/README.md +399 -0
- package/docs/sdks/session/README.md +62 -62
- package/funcs/accountAccountV1GetApps.d.ts.map +1 -1
- package/funcs/accountAccountV1GetApps.js +4 -0
- package/funcs/accountAccountV1GetApps.js.map +1 -1
- package/funcs/accountAccountV1GetBadges.d.ts.map +1 -1
- package/funcs/accountAccountV1GetBadges.js +4 -0
- package/funcs/accountAccountV1GetBadges.js.map +1 -1
- package/funcs/accountAccountV1GetFriends.d.ts +13 -0
- package/funcs/accountAccountV1GetFriends.d.ts.map +1 -0
- package/funcs/accountAccountV1GetFriends.js +105 -0
- package/funcs/accountAccountV1GetFriends.js.map +1 -0
- package/funcs/accountAccountV1GetInfo.d.ts +14 -0
- package/funcs/accountAccountV1GetInfo.d.ts.map +1 -0
- package/funcs/accountAccountV1GetInfo.js +96 -0
- package/funcs/accountAccountV1GetInfo.js.map +1 -0
- package/funcs/accountAccountV1GetLeaderboardHistory.d.ts +13 -0
- package/funcs/accountAccountV1GetLeaderboardHistory.d.ts.map +1 -0
- package/funcs/accountAccountV1GetLeaderboardHistory.js +105 -0
- package/funcs/accountAccountV1GetLeaderboardHistory.js.map +1 -0
- package/funcs/accountAccountV1GetStaff.d.ts +13 -0
- package/funcs/accountAccountV1GetStaff.d.ts.map +1 -0
- package/funcs/accountAccountV1GetStaff.js +86 -0
- package/funcs/accountAccountV1GetStaff.js.map +1 -0
- package/funcs/accountAccountV1SessionCreate.js +1 -1
- package/funcs/accountAccountV1SessionLogin.js +2 -2
- package/funcs/accountAccountV1SessionLogin.js.map +1 -1
- package/funcs/dataAccountV1GetApps.d.ts +13 -0
- package/funcs/dataAccountV1GetApps.d.ts.map +1 -0
- package/funcs/dataAccountV1GetApps.js +105 -0
- package/funcs/dataAccountV1GetApps.js.map +1 -0
- package/funcs/dataAccountV1GetBadges.d.ts +13 -0
- package/funcs/dataAccountV1GetBadges.d.ts.map +1 -0
- package/funcs/dataAccountV1GetBadges.js +105 -0
- package/funcs/dataAccountV1GetBadges.js.map +1 -0
- package/funcs/dataAccountV1GetFriends.d.ts +13 -0
- package/funcs/dataAccountV1GetFriends.d.ts.map +1 -0
- package/funcs/dataAccountV1GetFriends.js +105 -0
- package/funcs/dataAccountV1GetFriends.js.map +1 -0
- package/funcs/dataAccountV1GetInfo.d.ts +14 -0
- package/funcs/dataAccountV1GetInfo.d.ts.map +1 -0
- package/funcs/dataAccountV1GetInfo.js +96 -0
- package/funcs/dataAccountV1GetInfo.js.map +1 -0
- package/funcs/dataAccountV1GetLeaderboardHistory.d.ts +13 -0
- package/funcs/dataAccountV1GetLeaderboardHistory.d.ts.map +1 -0
- package/funcs/dataAccountV1GetLeaderboardHistory.js +105 -0
- package/funcs/dataAccountV1GetLeaderboardHistory.js.map +1 -0
- package/funcs/dataAccountV1GetStaff.d.ts +13 -0
- package/funcs/dataAccountV1GetStaff.d.ts.map +1 -0
- package/funcs/dataAccountV1GetStaff.js +86 -0
- package/funcs/dataAccountV1GetStaff.js.map +1 -0
- package/funcs/locationLocation.d.ts +16 -0
- package/funcs/locationLocation.d.ts.map +1 -0
- package/funcs/locationLocation.js +87 -0
- package/funcs/locationLocation.js.map +1 -0
- package/funcs/publicAccountV1GetApps.d.ts +13 -0
- package/funcs/publicAccountV1GetApps.d.ts.map +1 -0
- package/funcs/publicAccountV1GetApps.js +105 -0
- package/funcs/publicAccountV1GetApps.js.map +1 -0
- package/funcs/publicAccountV1GetBadges.d.ts +13 -0
- package/funcs/publicAccountV1GetBadges.d.ts.map +1 -0
- package/funcs/publicAccountV1GetBadges.js +105 -0
- package/funcs/publicAccountV1GetBadges.js.map +1 -0
- package/funcs/publicAccountV1GetFriends.d.ts +13 -0
- package/funcs/publicAccountV1GetFriends.d.ts.map +1 -0
- package/funcs/publicAccountV1GetFriends.js +105 -0
- package/funcs/publicAccountV1GetFriends.js.map +1 -0
- package/funcs/publicAccountV1GetInfo.d.ts +14 -0
- package/funcs/publicAccountV1GetInfo.d.ts.map +1 -0
- package/funcs/publicAccountV1GetInfo.js +96 -0
- package/funcs/publicAccountV1GetInfo.js.map +1 -0
- package/funcs/publicAccountV1GetLeaderboardHistory.d.ts +13 -0
- package/funcs/publicAccountV1GetLeaderboardHistory.d.ts.map +1 -0
- package/funcs/publicAccountV1GetLeaderboardHistory.js +105 -0
- package/funcs/publicAccountV1GetLeaderboardHistory.js.map +1 -0
- package/funcs/sessionAccountV1SessionCreate.js +1 -1
- package/funcs/sessionAccountV1SessionLogin.js +2 -2
- package/funcs/sessionAccountV1SessionLogin.js.map +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/security.d.ts +6 -1
- package/lib/security.d.ts.map +1 -1
- package/lib/security.js +5 -0
- package/lib/security.js.map +1 -1
- package/models/components/accountinfobody.d.ts +379 -0
- package/models/components/accountinfobody.d.ts.map +1 -0
- package/models/components/accountinfobody.js +254 -0
- package/models/components/accountinfobody.js.map +1 -0
- package/models/components/accountleaderboardhistory.d.ts +96 -0
- package/models/components/accountleaderboardhistory.d.ts.map +1 -0
- package/models/components/accountleaderboardhistory.js +91 -0
- package/models/components/accountleaderboardhistory.js.map +1 -0
- package/models/components/bestleaderboardrank.d.ts +110 -0
- package/models/components/bestleaderboardrank.d.ts.map +1 -0
- package/models/components/bestleaderboardrank.js +89 -0
- package/models/components/bestleaderboardrank.js.map +1 -0
- package/models/components/city.d.ts +28 -0
- package/models/components/city.d.ts.map +1 -0
- package/models/components/city.js +50 -0
- package/models/components/city.js.map +1 -0
- package/models/components/country.d.ts +43 -0
- package/models/components/country.d.ts.map +1 -0
- package/models/components/country.js +55 -0
- package/models/components/country.js.map +1 -0
- package/models/components/index.d.ts +14 -1
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +14 -1
- package/models/components/index.js.map +1 -1
- package/models/components/leaderboardaccount.d.ts +196 -0
- package/models/components/leaderboardaccount.d.ts.map +1 -0
- package/models/components/leaderboardaccount.js +128 -0
- package/models/components/leaderboardaccount.js.map +1 -0
- package/models/components/leaderboardbadgeinfo.d.ts +33 -0
- package/models/components/leaderboardbadgeinfo.d.ts.map +1 -0
- package/models/components/leaderboardbadgeinfo.js +55 -0
- package/models/components/leaderboardbadgeinfo.js.map +1 -0
- package/models/components/location.d.ts +38 -0
- package/models/components/location.d.ts.map +1 -0
- package/models/components/location.js +54 -0
- package/models/components/location.js.map +1 -0
- package/models/components/region.d.ts +38 -0
- package/models/components/region.d.ts.map +1 -0
- package/models/components/region.js +53 -0
- package/models/components/region.js.map +1 -0
- package/models/components/role.d.ts +2 -2
- package/models/components/role.d.ts.map +1 -1
- package/models/components/role.js +4 -17
- package/models/components/role.js.map +1 -1
- package/models/components/state.d.ts +43 -0
- package/models/components/state.d.ts.map +1 -0
- package/models/components/state.js +55 -0
- package/models/components/state.js.map +1 -0
- package/models/components/v1accountapp.d.ts +53 -0
- package/models/components/v1accountapp.d.ts.map +1 -0
- package/models/components/{v1app.js → v1accountapp.js} +11 -11
- package/models/components/v1accountapp.js.map +1 -0
- package/models/components/v1accountfriend.d.ts +198 -0
- package/models/components/v1accountfriend.d.ts.map +1 -0
- package/models/components/v1accountfriend.js +133 -0
- package/models/components/v1accountfriend.js.map +1 -0
- package/models/components/v1accountfriendsresponsebody.d.ts +31 -0
- package/models/components/v1accountfriendsresponsebody.d.ts.map +1 -0
- package/models/components/v1accountfriendsresponsebody.js +66 -0
- package/models/components/v1accountfriendsresponsebody.js.map +1 -0
- package/models/components/v1accountleaderboardhistoryresponsebody.d.ts +31 -0
- package/models/components/v1accountleaderboardhistoryresponsebody.d.ts.map +1 -0
- package/models/components/v1accountleaderboardhistoryresponsebody.js +66 -0
- package/models/components/v1accountleaderboardhistoryresponsebody.js.map +1 -0
- package/models/components/v1accountsappsresponsebody.d.ts +3 -3
- package/models/components/v1accountsappsresponsebody.d.ts.map +1 -1
- package/models/components/v1accountsappsresponsebody.js +3 -3
- package/models/components/v1accountsappsresponsebody.js.map +1 -1
- package/models/errors/errormodel.d.ts +5 -5
- package/models/errors/errormodel.d.ts.map +1 -1
- package/models/errors/errormodel.js +4 -2
- package/models/errors/errormodel.js.map +1 -1
- package/models/operations/accountv1getapps.d.ts +2 -0
- package/models/operations/accountv1getapps.d.ts.map +1 -1
- package/models/operations/accountv1getapps.js +4 -0
- package/models/operations/accountv1getapps.js.map +1 -1
- package/models/operations/accountv1getbadges.d.ts +2 -0
- package/models/operations/accountv1getbadges.d.ts.map +1 -1
- package/models/operations/accountv1getbadges.js +4 -0
- package/models/operations/accountv1getbadges.js.map +1 -1
- package/models/operations/accountv1getfriends.d.ts +58 -0
- package/models/operations/accountv1getfriends.d.ts.map +1 -0
- package/models/operations/accountv1getfriends.js +107 -0
- package/models/operations/accountv1getfriends.js.map +1 -0
- package/models/operations/accountv1getinfo.d.ts +31 -0
- package/models/operations/accountv1getinfo.d.ts.map +1 -0
- package/models/operations/accountv1getinfo.js +68 -0
- package/models/operations/accountv1getinfo.js.map +1 -0
- package/models/operations/accountv1getleaderboardhistory.d.ts +58 -0
- package/models/operations/accountv1getleaderboardhistory.d.ts.map +1 -0
- package/models/operations/accountv1getleaderboardhistory.js +107 -0
- package/models/operations/accountv1getleaderboardhistory.js.map +1 -0
- package/models/operations/accountv1getstaff.d.ts +31 -0
- package/models/operations/accountv1getstaff.d.ts.map +1 -0
- package/models/operations/accountv1getstaff.js +72 -0
- package/models/operations/accountv1getstaff.js.map +1 -0
- package/models/operations/index.d.ts +5 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +5 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/location.d.ts +31 -0
- package/models/operations/location.d.ts.map +1 -0
- package/models/operations/location.js +68 -0
- package/models/operations/location.js.map +1 -0
- package/package.json +1 -1
- package/sdk/account.d.ts +20 -4
- package/sdk/account.d.ts.map +1 -1
- package/sdk/account.js +34 -6
- package/sdk/account.js.map +1 -1
- package/sdk/data.d.ts +30 -0
- package/sdk/data.d.ts.map +1 -0
- package/sdk/data.js +54 -0
- package/sdk/data.js.map +1 -0
- package/sdk/location.d.ts +12 -0
- package/sdk/location.d.ts.map +1 -0
- package/sdk/location.js +22 -0
- package/sdk/location.js.map +1 -0
- package/sdk/public.d.ts +26 -0
- package/sdk/public.d.ts.map +1 -0
- package/sdk/public.js +47 -0
- package/sdk/public.js.map +1 -0
- package/sdk/sdk.d.ts +11 -2
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +17 -2
- package/sdk/sdk.js.map +1 -1
- package/sdk/session.d.ts +4 -4
- package/sdk/session.d.ts.map +1 -1
- package/sdk/session.js +6 -6
- package/sdk/session.js.map +1 -1
- package/src/funcs/accountAccountV1GetApps.ts +4 -0
- package/src/funcs/accountAccountV1GetBadges.ts +4 -0
- package/src/funcs/accountAccountV1GetFriends.ts +139 -0
- package/src/funcs/accountAccountV1GetInfo.ts +130 -0
- package/src/funcs/accountAccountV1GetLeaderboardHistory.ts +139 -0
- package/src/funcs/accountAccountV1GetStaff.ts +113 -0
- package/src/funcs/accountAccountV1SessionCreate.ts +1 -1
- package/src/funcs/accountAccountV1SessionLogin.ts +2 -2
- package/src/funcs/dataAccountV1GetApps.ts +139 -0
- package/src/funcs/dataAccountV1GetBadges.ts +139 -0
- package/src/funcs/dataAccountV1GetFriends.ts +139 -0
- package/src/funcs/dataAccountV1GetInfo.ts +130 -0
- package/src/funcs/dataAccountV1GetLeaderboardHistory.ts +139 -0
- package/src/funcs/dataAccountV1GetStaff.ts +113 -0
- package/src/funcs/locationLocation.ts +114 -0
- package/src/funcs/publicAccountV1GetApps.ts +139 -0
- package/src/funcs/publicAccountV1GetBadges.ts +139 -0
- package/src/funcs/publicAccountV1GetFriends.ts +139 -0
- package/src/funcs/publicAccountV1GetInfo.ts +130 -0
- package/src/funcs/publicAccountV1GetLeaderboardHistory.ts +139 -0
- package/src/funcs/sessionAccountV1SessionCreate.ts +1 -1
- package/src/funcs/sessionAccountV1SessionLogin.ts +2 -2
- package/src/lib/config.ts +3 -3
- package/src/lib/security.ts +12 -1
- package/src/models/components/accountinfobody.ts +532 -0
- package/src/models/components/accountleaderboardhistory.ts +103 -0
- package/src/models/components/bestleaderboardrank.ts +102 -0
- package/src/models/components/city.ts +40 -0
- package/src/models/components/country.ts +55 -0
- package/src/models/components/index.ts +14 -1
- package/src/models/components/leaderboardaccount.ts +301 -0
- package/src/models/components/leaderboardbadgeinfo.ts +58 -0
- package/src/models/components/location.ts +55 -0
- package/src/models/components/region.ts +53 -0
- package/src/models/components/role.ts +14 -27
- package/src/models/components/state.ts +55 -0
- package/src/models/components/{v1app.ts → v1accountapp.ts} +15 -11
- package/src/models/components/v1accountfriend.ts +307 -0
- package/src/models/components/v1accountfriendsresponsebody.ts +71 -0
- package/src/models/components/v1accountleaderboardhistoryresponsebody.ts +71 -0
- package/src/models/components/v1accountsappsresponsebody.ts +10 -5
- package/src/models/errors/errormodel.ts +8 -6
- package/src/models/operations/accountv1getapps.ts +6 -0
- package/src/models/operations/accountv1getbadges.ts +6 -0
- package/src/models/operations/accountv1getfriends.ts +134 -0
- package/src/models/operations/accountv1getinfo.ts +68 -0
- package/src/models/operations/accountv1getleaderboardhistory.ts +138 -0
- package/src/models/operations/accountv1getstaff.ts +72 -0
- package/src/models/operations/index.ts +5 -0
- package/src/models/operations/location.ts +64 -0
- package/src/sdk/account.ts +53 -10
- package/src/sdk/data.ts +75 -0
- package/src/sdk/location.ts +20 -0
- package/src/sdk/public.ts +65 -0
- package/src/sdk/sdk.ts +21 -3
- package/src/sdk/session.ts +10 -10
- package/models/components/v1app.d.ts +0 -53
- package/models/components/v1app.d.ts.map +0 -1
- package/models/components/v1app.js.map +0 -1
|
@@ -8,14 +8,19 @@ Account related operations
|
|
|
8
8
|
### Available Operations
|
|
9
9
|
|
|
10
10
|
* [accountV1ConnectionConnect](#accountv1connectionconnect) - Connect a new Social Provider
|
|
11
|
+
* [accountV1SessionCreate](#accountv1sessioncreate) - Create a new session for non logged in users
|
|
11
12
|
* [accountV1ConnectionDeleteConnection](#accountv1connectiondeleteconnection) - Remove a connection
|
|
12
13
|
* [accountV1SettingsDeleteImages](#accountv1settingsdeleteimages) - Delete mulitple imagest
|
|
13
14
|
* [accountV1SessionDelete](#accountv1sessiondelete) - Deletes a session, can also be used to logout
|
|
14
15
|
* [accountV1SettingsGenerateApiKey](#accountv1settingsgenerateapikey) - Generate a new API key for the account
|
|
15
16
|
* [accountV1GetApps](#accountv1getapps) - Get Account Apps
|
|
16
17
|
* [accountV1GetBadges](#accountv1getbadges) - Get Account Badges
|
|
18
|
+
* [accountV1GetFriends](#accountv1getfriends) - Get Account Friends
|
|
19
|
+
* [accountV1GetInfo](#accountv1getinfo) - Get Account Info
|
|
20
|
+
* [accountV1GetLeaderboardHistory](#accountv1getleaderboardhistory) - Get Account Leaderboard History
|
|
17
21
|
* [accountV1SessionGet](#accountv1sessionget) - Gets all session data
|
|
18
22
|
* [accountV1SettingsGet](#accountv1settingsget) - Gets all settings for the account
|
|
23
|
+
* [accountV1GetStaff](#accountv1getstaff) - Get Staff Members and their info
|
|
19
24
|
* [accountV1SessionLogin](#accountv1sessionlogin) - Logs a user in and creates a new session
|
|
20
25
|
* [accountV1SettingsSendEmailVerification](#accountv1settingssendemailverification) - Resend the verification code for an email
|
|
21
26
|
* [accountV1ConnectionUpdateConnection](#accountv1connectionupdateconnection) - Make a connection visible/invisible
|
|
@@ -24,7 +29,6 @@ Account related operations
|
|
|
24
29
|
* [accountV1SettingsUploadImages](#accountv1settingsuploadimages) - Multi Upload Endpoint for images
|
|
25
30
|
* [accountV1ConnectionVerifyConnection](#accountv1connectionverifyconnection) - Verify a domain connection only atm
|
|
26
31
|
* [accountV1SettingsVerfyEmail](#accountv1settingsverfyemail) - Verify the email by passing in the code the user should've gotten
|
|
27
|
-
* [accountV1SessionCreate](#accountv1sessioncreate) - Create a new session for non logged in users
|
|
28
32
|
|
|
29
33
|
## accountV1ConnectionConnect
|
|
30
34
|
|
|
@@ -106,6 +110,80 @@ run();
|
|
|
106
110
|
| errors.SDKError | 4xx-5xx | */* |
|
|
107
111
|
|
|
108
112
|
|
|
113
|
+
## accountV1SessionCreate
|
|
114
|
+
|
|
115
|
+
Create a new session for non logged in users
|
|
116
|
+
|
|
117
|
+
### Example Usage
|
|
118
|
+
|
|
119
|
+
```typescript
|
|
120
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
121
|
+
|
|
122
|
+
const steamSets = new SteamSets({
|
|
123
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
124
|
+
});
|
|
125
|
+
|
|
126
|
+
async function run() {
|
|
127
|
+
const result = await steamSets.account.accountV1SessionCreate({});
|
|
128
|
+
|
|
129
|
+
// Handle the result
|
|
130
|
+
console.log(result)
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
run();
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Standalone function
|
|
137
|
+
|
|
138
|
+
The standalone function version of this method:
|
|
139
|
+
|
|
140
|
+
```typescript
|
|
141
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
142
|
+
import { accountAccountV1SessionCreate } from "@steamsets/client-ts/funcs/accountAccountV1SessionCreate.js";
|
|
143
|
+
|
|
144
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
145
|
+
// You can create one instance of it to use across an application.
|
|
146
|
+
const steamSets = new SteamSetsCore({
|
|
147
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
148
|
+
});
|
|
149
|
+
|
|
150
|
+
async function run() {
|
|
151
|
+
const res = await accountAccountV1SessionCreate(steamSets, {});
|
|
152
|
+
|
|
153
|
+
if (!res.ok) {
|
|
154
|
+
throw res.error;
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
const { value: result } = res;
|
|
158
|
+
|
|
159
|
+
// Handle the result
|
|
160
|
+
console.log(result)
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
run();
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
### Parameters
|
|
167
|
+
|
|
168
|
+
| Parameter | Type | Required | Description |
|
|
169
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
170
|
+
| `request` | [operations.AccountV1SessionCreateRequest](../../models/operations/accountv1sessioncreaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
171
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
172
|
+
| `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. |
|
|
173
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
174
|
+
|
|
175
|
+
### Response
|
|
176
|
+
|
|
177
|
+
**Promise\<[operations.AccountV1SessionCreateResponse](../../models/operations/accountv1sessioncreateresponse.md)\>**
|
|
178
|
+
|
|
179
|
+
### Errors
|
|
180
|
+
|
|
181
|
+
| Error Object | Status Code | Content Type |
|
|
182
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
183
|
+
| errors.ErrorModel | 422,500 | application/problem+json |
|
|
184
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
185
|
+
|
|
186
|
+
|
|
109
187
|
## accountV1ConnectionDeleteConnection
|
|
110
188
|
|
|
111
189
|
Remove a connection
|
|
@@ -579,6 +657,236 @@ run();
|
|
|
579
657
|
| errors.SDKError | 4xx-5xx | */* |
|
|
580
658
|
|
|
581
659
|
|
|
660
|
+
## accountV1GetFriends
|
|
661
|
+
|
|
662
|
+
Get Account Friends
|
|
663
|
+
|
|
664
|
+
### Example Usage
|
|
665
|
+
|
|
666
|
+
```typescript
|
|
667
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
668
|
+
|
|
669
|
+
const steamSets = new SteamSets({
|
|
670
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
671
|
+
});
|
|
672
|
+
|
|
673
|
+
async function run() {
|
|
674
|
+
const result = await steamSets.account.accountV1GetFriends({
|
|
675
|
+
accountSearch: {},
|
|
676
|
+
});
|
|
677
|
+
|
|
678
|
+
// Handle the result
|
|
679
|
+
console.log(result)
|
|
680
|
+
}
|
|
681
|
+
|
|
682
|
+
run();
|
|
683
|
+
```
|
|
684
|
+
|
|
685
|
+
### Standalone function
|
|
686
|
+
|
|
687
|
+
The standalone function version of this method:
|
|
688
|
+
|
|
689
|
+
```typescript
|
|
690
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
691
|
+
import { accountAccountV1GetFriends } from "@steamsets/client-ts/funcs/accountAccountV1GetFriends.js";
|
|
692
|
+
|
|
693
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
694
|
+
// You can create one instance of it to use across an application.
|
|
695
|
+
const steamSets = new SteamSetsCore({
|
|
696
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
697
|
+
});
|
|
698
|
+
|
|
699
|
+
async function run() {
|
|
700
|
+
const res = await accountAccountV1GetFriends(steamSets, {
|
|
701
|
+
accountSearch: {},
|
|
702
|
+
});
|
|
703
|
+
|
|
704
|
+
if (!res.ok) {
|
|
705
|
+
throw res.error;
|
|
706
|
+
}
|
|
707
|
+
|
|
708
|
+
const { value: result } = res;
|
|
709
|
+
|
|
710
|
+
// Handle the result
|
|
711
|
+
console.log(result)
|
|
712
|
+
}
|
|
713
|
+
|
|
714
|
+
run();
|
|
715
|
+
```
|
|
716
|
+
|
|
717
|
+
### Parameters
|
|
718
|
+
|
|
719
|
+
| Parameter | Type | Required | Description |
|
|
720
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
721
|
+
| `request` | [operations.AccountV1GetFriendsRequest](../../models/operations/accountv1getfriendsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
722
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
723
|
+
| `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. |
|
|
724
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
725
|
+
|
|
726
|
+
### Response
|
|
727
|
+
|
|
728
|
+
**Promise\<[operations.AccountV1GetFriendsResponse](../../models/operations/accountv1getfriendsresponse.md)\>**
|
|
729
|
+
|
|
730
|
+
### Errors
|
|
731
|
+
|
|
732
|
+
| Error Object | Status Code | Content Type |
|
|
733
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
734
|
+
| errors.ErrorModel | 400,422,500 | application/problem+json |
|
|
735
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
## accountV1GetInfo
|
|
739
|
+
|
|
740
|
+
Get Account Info
|
|
741
|
+
|
|
742
|
+
### Example Usage
|
|
743
|
+
|
|
744
|
+
```typescript
|
|
745
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
746
|
+
|
|
747
|
+
const steamSets = new SteamSets({
|
|
748
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
749
|
+
});
|
|
750
|
+
|
|
751
|
+
async function run() {
|
|
752
|
+
const result = await steamSets.account.accountV1GetInfo({});
|
|
753
|
+
|
|
754
|
+
// Handle the result
|
|
755
|
+
console.log(result)
|
|
756
|
+
}
|
|
757
|
+
|
|
758
|
+
run();
|
|
759
|
+
```
|
|
760
|
+
|
|
761
|
+
### Standalone function
|
|
762
|
+
|
|
763
|
+
The standalone function version of this method:
|
|
764
|
+
|
|
765
|
+
```typescript
|
|
766
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
767
|
+
import { accountAccountV1GetInfo } from "@steamsets/client-ts/funcs/accountAccountV1GetInfo.js";
|
|
768
|
+
|
|
769
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
770
|
+
// You can create one instance of it to use across an application.
|
|
771
|
+
const steamSets = new SteamSetsCore({
|
|
772
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
773
|
+
});
|
|
774
|
+
|
|
775
|
+
async function run() {
|
|
776
|
+
const res = await accountAccountV1GetInfo(steamSets, {});
|
|
777
|
+
|
|
778
|
+
if (!res.ok) {
|
|
779
|
+
throw res.error;
|
|
780
|
+
}
|
|
781
|
+
|
|
782
|
+
const { value: result } = res;
|
|
783
|
+
|
|
784
|
+
// Handle the result
|
|
785
|
+
console.log(result)
|
|
786
|
+
}
|
|
787
|
+
|
|
788
|
+
run();
|
|
789
|
+
```
|
|
790
|
+
|
|
791
|
+
### Parameters
|
|
792
|
+
|
|
793
|
+
| Parameter | Type | Required | Description |
|
|
794
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
795
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
796
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
797
|
+
| `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. |
|
|
798
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
799
|
+
|
|
800
|
+
### Response
|
|
801
|
+
|
|
802
|
+
**Promise\<[operations.AccountV1GetInfoResponse](../../models/operations/accountv1getinforesponse.md)\>**
|
|
803
|
+
|
|
804
|
+
### Errors
|
|
805
|
+
|
|
806
|
+
| Error Object | Status Code | Content Type |
|
|
807
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
808
|
+
| errors.ErrorModel | 404,422,429,500 | application/problem+json |
|
|
809
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
## accountV1GetLeaderboardHistory
|
|
813
|
+
|
|
814
|
+
Get Account Leaderboard History
|
|
815
|
+
|
|
816
|
+
### Example Usage
|
|
817
|
+
|
|
818
|
+
```typescript
|
|
819
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
820
|
+
|
|
821
|
+
const steamSets = new SteamSets({
|
|
822
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
823
|
+
});
|
|
824
|
+
|
|
825
|
+
async function run() {
|
|
826
|
+
const result = await steamSets.account.accountV1GetLeaderboardHistory({
|
|
827
|
+
accountSearch: {},
|
|
828
|
+
});
|
|
829
|
+
|
|
830
|
+
// Handle the result
|
|
831
|
+
console.log(result)
|
|
832
|
+
}
|
|
833
|
+
|
|
834
|
+
run();
|
|
835
|
+
```
|
|
836
|
+
|
|
837
|
+
### Standalone function
|
|
838
|
+
|
|
839
|
+
The standalone function version of this method:
|
|
840
|
+
|
|
841
|
+
```typescript
|
|
842
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
843
|
+
import { accountAccountV1GetLeaderboardHistory } from "@steamsets/client-ts/funcs/accountAccountV1GetLeaderboardHistory.js";
|
|
844
|
+
|
|
845
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
846
|
+
// You can create one instance of it to use across an application.
|
|
847
|
+
const steamSets = new SteamSetsCore({
|
|
848
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
849
|
+
});
|
|
850
|
+
|
|
851
|
+
async function run() {
|
|
852
|
+
const res = await accountAccountV1GetLeaderboardHistory(steamSets, {
|
|
853
|
+
accountSearch: {},
|
|
854
|
+
});
|
|
855
|
+
|
|
856
|
+
if (!res.ok) {
|
|
857
|
+
throw res.error;
|
|
858
|
+
}
|
|
859
|
+
|
|
860
|
+
const { value: result } = res;
|
|
861
|
+
|
|
862
|
+
// Handle the result
|
|
863
|
+
console.log(result)
|
|
864
|
+
}
|
|
865
|
+
|
|
866
|
+
run();
|
|
867
|
+
```
|
|
868
|
+
|
|
869
|
+
### Parameters
|
|
870
|
+
|
|
871
|
+
| Parameter | Type | Required | Description |
|
|
872
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
873
|
+
| `request` | [operations.AccountV1GetLeaderboardHistoryRequest](../../models/operations/accountv1getleaderboardhistoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
874
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
875
|
+
| `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. |
|
|
876
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
877
|
+
|
|
878
|
+
### Response
|
|
879
|
+
|
|
880
|
+
**Promise\<[operations.AccountV1GetLeaderboardHistoryResponse](../../models/operations/accountv1getleaderboardhistoryresponse.md)\>**
|
|
881
|
+
|
|
882
|
+
### Errors
|
|
883
|
+
|
|
884
|
+
| Error Object | Status Code | Content Type |
|
|
885
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
886
|
+
| errors.ErrorModel | 400,422,500 | application/problem+json |
|
|
887
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
888
|
+
|
|
889
|
+
|
|
582
890
|
## accountV1SessionGet
|
|
583
891
|
|
|
584
892
|
Gets all session data
|
|
@@ -725,6 +1033,79 @@ run();
|
|
|
725
1033
|
| errors.SDKError | 4xx-5xx | */* |
|
|
726
1034
|
|
|
727
1035
|
|
|
1036
|
+
## accountV1GetStaff
|
|
1037
|
+
|
|
1038
|
+
Get Staff Members and their info
|
|
1039
|
+
|
|
1040
|
+
### Example Usage
|
|
1041
|
+
|
|
1042
|
+
```typescript
|
|
1043
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
1044
|
+
|
|
1045
|
+
const steamSets = new SteamSets({
|
|
1046
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1047
|
+
});
|
|
1048
|
+
|
|
1049
|
+
async function run() {
|
|
1050
|
+
const result = await steamSets.account.accountV1GetStaff();
|
|
1051
|
+
|
|
1052
|
+
// Handle the result
|
|
1053
|
+
console.log(result)
|
|
1054
|
+
}
|
|
1055
|
+
|
|
1056
|
+
run();
|
|
1057
|
+
```
|
|
1058
|
+
|
|
1059
|
+
### Standalone function
|
|
1060
|
+
|
|
1061
|
+
The standalone function version of this method:
|
|
1062
|
+
|
|
1063
|
+
```typescript
|
|
1064
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1065
|
+
import { accountAccountV1GetStaff } from "@steamsets/client-ts/funcs/accountAccountV1GetStaff.js";
|
|
1066
|
+
|
|
1067
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1068
|
+
// You can create one instance of it to use across an application.
|
|
1069
|
+
const steamSets = new SteamSetsCore({
|
|
1070
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1071
|
+
});
|
|
1072
|
+
|
|
1073
|
+
async function run() {
|
|
1074
|
+
const res = await accountAccountV1GetStaff(steamSets);
|
|
1075
|
+
|
|
1076
|
+
if (!res.ok) {
|
|
1077
|
+
throw res.error;
|
|
1078
|
+
}
|
|
1079
|
+
|
|
1080
|
+
const { value: result } = res;
|
|
1081
|
+
|
|
1082
|
+
// Handle the result
|
|
1083
|
+
console.log(result)
|
|
1084
|
+
}
|
|
1085
|
+
|
|
1086
|
+
run();
|
|
1087
|
+
```
|
|
1088
|
+
|
|
1089
|
+
### Parameters
|
|
1090
|
+
|
|
1091
|
+
| Parameter | Type | Required | Description |
|
|
1092
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1093
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1094
|
+
| `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. |
|
|
1095
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1096
|
+
|
|
1097
|
+
### Response
|
|
1098
|
+
|
|
1099
|
+
**Promise\<[operations.AccountV1GetStaffResponse](../../models/operations/accountv1getstaffresponse.md)\>**
|
|
1100
|
+
|
|
1101
|
+
### Errors
|
|
1102
|
+
|
|
1103
|
+
| Error Object | Status Code | Content Type |
|
|
1104
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
1105
|
+
| errors.ErrorModel | 404,429,500 | application/problem+json |
|
|
1106
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
1107
|
+
|
|
1108
|
+
|
|
728
1109
|
## accountV1SessionLogin
|
|
729
1110
|
|
|
730
1111
|
Logs a user in and creates a new session
|
|
@@ -821,7 +1202,7 @@ run();
|
|
|
821
1202
|
|
|
822
1203
|
| Error Object | Status Code | Content Type |
|
|
823
1204
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
824
|
-
| errors.ErrorModel | 422,500
|
|
1205
|
+
| errors.ErrorModel | 400,422,429,500 | application/problem+json |
|
|
825
1206
|
| errors.SDKError | 4xx-5xx | */* |
|
|
826
1207
|
|
|
827
1208
|
|
|
@@ -1407,77 +1788,3 @@ run();
|
|
|
1407
1788
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1408
1789
|
| errors.ErrorModel | 404,422,429,500 | application/problem+json |
|
|
1409
1790
|
| errors.SDKError | 4xx-5xx | */* |
|
|
1410
|
-
|
|
1411
|
-
|
|
1412
|
-
## accountV1SessionCreate
|
|
1413
|
-
|
|
1414
|
-
Create a new session for non logged in users
|
|
1415
|
-
|
|
1416
|
-
### Example Usage
|
|
1417
|
-
|
|
1418
|
-
```typescript
|
|
1419
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
1420
|
-
|
|
1421
|
-
const steamSets = new SteamSets({
|
|
1422
|
-
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1423
|
-
});
|
|
1424
|
-
|
|
1425
|
-
async function run() {
|
|
1426
|
-
const result = await steamSets.account.accountV1SessionCreate({});
|
|
1427
|
-
|
|
1428
|
-
// Handle the result
|
|
1429
|
-
console.log(result)
|
|
1430
|
-
}
|
|
1431
|
-
|
|
1432
|
-
run();
|
|
1433
|
-
```
|
|
1434
|
-
|
|
1435
|
-
### Standalone function
|
|
1436
|
-
|
|
1437
|
-
The standalone function version of this method:
|
|
1438
|
-
|
|
1439
|
-
```typescript
|
|
1440
|
-
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1441
|
-
import { accountAccountV1SessionCreate } from "@steamsets/client-ts/funcs/accountAccountV1SessionCreate.js";
|
|
1442
|
-
|
|
1443
|
-
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1444
|
-
// You can create one instance of it to use across an application.
|
|
1445
|
-
const steamSets = new SteamSetsCore({
|
|
1446
|
-
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1447
|
-
});
|
|
1448
|
-
|
|
1449
|
-
async function run() {
|
|
1450
|
-
const res = await accountAccountV1SessionCreate(steamSets, {});
|
|
1451
|
-
|
|
1452
|
-
if (!res.ok) {
|
|
1453
|
-
throw res.error;
|
|
1454
|
-
}
|
|
1455
|
-
|
|
1456
|
-
const { value: result } = res;
|
|
1457
|
-
|
|
1458
|
-
// Handle the result
|
|
1459
|
-
console.log(result)
|
|
1460
|
-
}
|
|
1461
|
-
|
|
1462
|
-
run();
|
|
1463
|
-
```
|
|
1464
|
-
|
|
1465
|
-
### Parameters
|
|
1466
|
-
|
|
1467
|
-
| Parameter | Type | Required | Description |
|
|
1468
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1469
|
-
| `request` | [operations.AccountV1SessionCreateRequest](../../models/operations/accountv1sessioncreaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1470
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1471
|
-
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
1472
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1473
|
-
|
|
1474
|
-
### Response
|
|
1475
|
-
|
|
1476
|
-
**Promise\<[operations.AccountV1SessionCreateResponse](../../models/operations/accountv1sessioncreateresponse.md)\>**
|
|
1477
|
-
|
|
1478
|
-
### Errors
|
|
1479
|
-
|
|
1480
|
-
| Error Object | Status Code | Content Type |
|
|
1481
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
1482
|
-
| errors.ErrorModel | 422,500 | application/problem+json |
|
|
1483
|
-
| errors.SDKError | 4xx-5xx | */* |
|