@steamsets/client-ts 0.7.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +36 -3
- package/docs/sdks/account/README.md +146 -36
- package/docs/sdks/app/README.md +14 -0
- package/docs/sdks/connection/README.md +24 -8
- package/docs/sdks/data/README.md +57 -4
- package/docs/sdks/liveness/README.md +6 -2
- package/docs/sdks/location/README.md +6 -2
- package/docs/sdks/public/README.md +51 -2
- package/docs/sdks/session/README.md +24 -8
- package/docs/sdks/settings/README.md +48 -16
- package/funcs/accountAccountV1GetApps.d.ts +1 -1
- package/funcs/accountAccountV1GetApps.d.ts.map +1 -1
- package/funcs/accountAccountV1GetApps.js +17 -5
- package/funcs/accountAccountV1GetApps.js.map +1 -1
- package/funcs/accountAccountV1GetBadges.d.ts +1 -1
- package/funcs/accountAccountV1GetBadges.d.ts.map +1 -1
- package/funcs/accountAccountV1GetBadges.js +17 -5
- package/funcs/accountAccountV1GetBadges.js.map +1 -1
- package/funcs/accountAccountV1GetDataPoints.d.ts +1 -1
- package/funcs/accountAccountV1GetDataPoints.d.ts.map +1 -1
- package/funcs/accountAccountV1GetDataPoints.js +17 -5
- package/funcs/accountAccountV1GetDataPoints.js.map +1 -1
- package/funcs/accountAccountV1GetFriends.d.ts +1 -1
- package/funcs/accountAccountV1GetFriends.d.ts.map +1 -1
- package/funcs/accountAccountV1GetFriends.js +17 -5
- package/funcs/accountAccountV1GetFriends.js.map +1 -1
- package/funcs/accountAccountV1GetInfo.d.ts +1 -1
- package/funcs/accountAccountV1GetInfo.d.ts.map +1 -1
- package/funcs/accountAccountV1GetInfo.js +17 -5
- package/funcs/accountAccountV1GetInfo.js.map +1 -1
- package/funcs/accountAccountV1GetLeaderboardHistory.d.ts +1 -1
- package/funcs/accountAccountV1GetLeaderboardHistory.d.ts.map +1 -1
- package/funcs/accountAccountV1GetLeaderboardHistory.js +17 -5
- package/funcs/accountAccountV1GetLeaderboardHistory.js.map +1 -1
- package/funcs/appAccountV1Queue.d.ts +1 -1
- package/funcs/appAccountV1Queue.d.ts.map +1 -1
- package/funcs/appAccountV1Queue.js +17 -5
- package/funcs/appAccountV1Queue.js.map +1 -1
- package/funcs/appAppV1Get.d.ts +1 -1
- package/funcs/appAppV1Get.d.ts.map +1 -1
- package/funcs/appAppV1Get.js +17 -5
- package/funcs/appAppV1Get.js.map +1 -1
- package/funcs/dataAccountV1GetApps.d.ts +1 -1
- package/funcs/dataAccountV1GetApps.d.ts.map +1 -1
- package/funcs/dataAccountV1GetApps.js +17 -5
- package/funcs/dataAccountV1GetApps.js.map +1 -1
- package/funcs/dataAccountV1GetBadges.d.ts +1 -1
- package/funcs/dataAccountV1GetBadges.d.ts.map +1 -1
- package/funcs/dataAccountV1GetBadges.js +17 -5
- package/funcs/dataAccountV1GetBadges.js.map +1 -1
- package/funcs/dataAccountV1GetDataPoints.d.ts +1 -1
- package/funcs/dataAccountV1GetDataPoints.d.ts.map +1 -1
- package/funcs/dataAccountV1GetDataPoints.js +17 -5
- package/funcs/dataAccountV1GetDataPoints.js.map +1 -1
- package/funcs/dataAccountV1GetFriends.d.ts +1 -1
- package/funcs/dataAccountV1GetFriends.d.ts.map +1 -1
- package/funcs/dataAccountV1GetFriends.js +17 -5
- package/funcs/dataAccountV1GetFriends.js.map +1 -1
- package/funcs/dataAccountV1GetInfo.d.ts +1 -1
- package/funcs/dataAccountV1GetInfo.d.ts.map +1 -1
- package/funcs/dataAccountV1GetInfo.js +17 -5
- package/funcs/dataAccountV1GetInfo.js.map +1 -1
- package/funcs/dataAccountV1GetLeaderboardHistory.d.ts +1 -1
- package/funcs/dataAccountV1GetLeaderboardHistory.d.ts.map +1 -1
- package/funcs/dataAccountV1GetLeaderboardHistory.js +17 -5
- package/funcs/dataAccountV1GetLeaderboardHistory.js.map +1 -1
- package/funcs/dataAccountV1Queue.d.ts +1 -1
- package/funcs/dataAccountV1Queue.d.ts.map +1 -1
- package/funcs/dataAccountV1Queue.js +17 -5
- package/funcs/dataAccountV1Queue.js.map +1 -1
- package/funcs/publicAccountV1GetApps.d.ts +1 -1
- package/funcs/publicAccountV1GetApps.d.ts.map +1 -1
- package/funcs/publicAccountV1GetApps.js +17 -5
- package/funcs/publicAccountV1GetApps.js.map +1 -1
- package/funcs/publicAccountV1GetBadges.d.ts +1 -1
- package/funcs/publicAccountV1GetBadges.d.ts.map +1 -1
- package/funcs/publicAccountV1GetBadges.js +17 -5
- package/funcs/publicAccountV1GetBadges.js.map +1 -1
- package/funcs/publicAccountV1GetDataPoints.d.ts +1 -1
- package/funcs/publicAccountV1GetDataPoints.d.ts.map +1 -1
- package/funcs/publicAccountV1GetDataPoints.js +17 -5
- package/funcs/publicAccountV1GetDataPoints.js.map +1 -1
- package/funcs/publicAccountV1GetFriends.d.ts +1 -1
- package/funcs/publicAccountV1GetFriends.d.ts.map +1 -1
- package/funcs/publicAccountV1GetFriends.js +17 -5
- package/funcs/publicAccountV1GetFriends.js.map +1 -1
- package/funcs/publicAccountV1GetInfo.d.ts +1 -1
- package/funcs/publicAccountV1GetInfo.d.ts.map +1 -1
- package/funcs/publicAccountV1GetInfo.js +17 -5
- package/funcs/publicAccountV1GetInfo.js.map +1 -1
- package/funcs/publicAccountV1GetLeaderboardHistory.d.ts +1 -1
- package/funcs/publicAccountV1GetLeaderboardHistory.d.ts.map +1 -1
- package/funcs/publicAccountV1GetLeaderboardHistory.js +17 -5
- package/funcs/publicAccountV1GetLeaderboardHistory.js.map +1 -1
- package/funcs/publicAccountV1Queue.d.ts +1 -1
- package/funcs/publicAccountV1Queue.d.ts.map +1 -1
- package/funcs/publicAccountV1Queue.js +17 -5
- package/funcs/publicAccountV1Queue.js.map +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/models/operations/accountv1getapps.d.ts +25 -0
- package/models/operations/accountv1getapps.d.ts.map +1 -1
- package/models/operations/accountv1getapps.js +22 -1
- package/models/operations/accountv1getapps.js.map +1 -1
- package/models/operations/accountv1getbadges.d.ts +25 -0
- package/models/operations/accountv1getbadges.d.ts.map +1 -1
- package/models/operations/accountv1getbadges.js +22 -1
- package/models/operations/accountv1getbadges.js.map +1 -1
- package/models/operations/accountv1getdatapoints.d.ts +25 -0
- package/models/operations/accountv1getdatapoints.d.ts.map +1 -1
- package/models/operations/accountv1getdatapoints.js +22 -1
- package/models/operations/accountv1getdatapoints.js.map +1 -1
- package/models/operations/accountv1getfriends.d.ts +25 -0
- package/models/operations/accountv1getfriends.d.ts.map +1 -1
- package/models/operations/accountv1getfriends.js +22 -1
- package/models/operations/accountv1getfriends.js.map +1 -1
- package/models/operations/accountv1getinfo.d.ts +25 -0
- package/models/operations/accountv1getinfo.d.ts.map +1 -1
- package/models/operations/accountv1getinfo.js +22 -1
- package/models/operations/accountv1getinfo.js.map +1 -1
- package/models/operations/accountv1getleaderboardhistory.d.ts +25 -0
- package/models/operations/accountv1getleaderboardhistory.d.ts.map +1 -1
- package/models/operations/accountv1getleaderboardhistory.js +22 -1
- package/models/operations/accountv1getleaderboardhistory.js.map +1 -1
- package/models/operations/accountv1queue.d.ts +25 -0
- package/models/operations/accountv1queue.d.ts.map +1 -1
- package/models/operations/accountv1queue.js +22 -1
- package/models/operations/accountv1queue.js.map +1 -1
- package/models/operations/appv1get.d.ts +25 -0
- package/models/operations/appv1get.d.ts.map +1 -1
- package/models/operations/appv1get.js +22 -1
- package/models/operations/appv1get.js.map +1 -1
- package/package.json +1 -1
- package/sdk/account.d.ts +6 -6
- package/sdk/account.d.ts.map +1 -1
- package/sdk/account.js +12 -12
- package/sdk/account.js.map +1 -1
- package/sdk/app.d.ts +2 -2
- package/sdk/app.d.ts.map +1 -1
- package/sdk/app.js +4 -4
- package/sdk/app.js.map +1 -1
- package/sdk/data.d.ts +7 -7
- package/sdk/data.d.ts.map +1 -1
- package/sdk/data.js +14 -14
- package/sdk/data.js.map +1 -1
- package/sdk/public.d.ts +7 -7
- package/sdk/public.d.ts.map +1 -1
- package/sdk/public.js +14 -14
- package/sdk/public.js.map +1 -1
- package/src/funcs/accountAccountV1GetApps.ts +18 -5
- package/src/funcs/accountAccountV1GetBadges.ts +18 -5
- package/src/funcs/accountAccountV1GetDataPoints.ts +18 -5
- package/src/funcs/accountAccountV1GetFriends.ts +18 -5
- package/src/funcs/accountAccountV1GetInfo.ts +18 -5
- package/src/funcs/accountAccountV1GetLeaderboardHistory.ts +18 -5
- package/src/funcs/appAccountV1Queue.ts +18 -5
- package/src/funcs/appAppV1Get.ts +18 -5
- package/src/funcs/dataAccountV1GetApps.ts +18 -5
- package/src/funcs/dataAccountV1GetBadges.ts +18 -5
- package/src/funcs/dataAccountV1GetDataPoints.ts +18 -5
- package/src/funcs/dataAccountV1GetFriends.ts +18 -5
- package/src/funcs/dataAccountV1GetInfo.ts +18 -5
- package/src/funcs/dataAccountV1GetLeaderboardHistory.ts +18 -5
- package/src/funcs/dataAccountV1Queue.ts +18 -5
- package/src/funcs/publicAccountV1GetApps.ts +18 -5
- package/src/funcs/publicAccountV1GetBadges.ts +18 -5
- package/src/funcs/publicAccountV1GetDataPoints.ts +18 -5
- package/src/funcs/publicAccountV1GetFriends.ts +18 -5
- package/src/funcs/publicAccountV1GetInfo.ts +18 -5
- package/src/funcs/publicAccountV1GetLeaderboardHistory.ts +18 -5
- package/src/funcs/publicAccountV1Queue.ts +18 -5
- package/src/lib/config.ts +2 -2
- package/src/models/operations/accountv1getapps.ts +44 -0
- package/src/models/operations/accountv1getbadges.ts +44 -0
- package/src/models/operations/accountv1getdatapoints.ts +44 -0
- package/src/models/operations/accountv1getfriends.ts +44 -0
- package/src/models/operations/accountv1getinfo.ts +44 -0
- package/src/models/operations/accountv1getleaderboardhistory.ts +46 -0
- package/src/models/operations/accountv1queue.ts +44 -0
- package/src/models/operations/appv1get.ts +44 -0
- package/src/sdk/account.ts +12 -0
- package/src/sdk/app.ts +4 -0
- package/src/sdk/data.ts +14 -0
- package/src/sdk/public.ts +14 -0
package/docs/sdks/app/README.md
CHANGED
|
@@ -24,6 +24,9 @@ const steamSets = new SteamSets();
|
|
|
24
24
|
async function run() {
|
|
25
25
|
const result = await steamSets.app.appV1Get({
|
|
26
26
|
appId: 123456,
|
|
27
|
+
}, {
|
|
28
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
29
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
27
30
|
});
|
|
28
31
|
|
|
29
32
|
// Handle the result
|
|
@@ -48,6 +51,9 @@ const steamSets = new SteamSetsCore();
|
|
|
48
51
|
async function run() {
|
|
49
52
|
const res = await appAppV1Get(steamSets, {
|
|
50
53
|
appId: 123456,
|
|
54
|
+
}, {
|
|
55
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
56
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
51
57
|
});
|
|
52
58
|
|
|
53
59
|
if (!res.ok) {
|
|
@@ -68,6 +74,7 @@ run();
|
|
|
68
74
|
| Parameter | Type | Required | Description |
|
|
69
75
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
70
76
|
| `request` | [components.V1AppRequestBody](../../models/components/v1apprequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
77
|
+
| `security` | [operations.AppV1GetSecurity](../../models/operations/appv1getsecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
71
78
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
72
79
|
| `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. |
|
|
73
80
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -100,6 +107,9 @@ async function run() {
|
|
|
100
107
|
appSearch: {
|
|
101
108
|
id: 730,
|
|
102
109
|
},
|
|
110
|
+
}, {
|
|
111
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
112
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
103
113
|
});
|
|
104
114
|
|
|
105
115
|
// Handle the result
|
|
@@ -126,6 +136,9 @@ async function run() {
|
|
|
126
136
|
appSearch: {
|
|
127
137
|
id: 730,
|
|
128
138
|
},
|
|
139
|
+
}, {
|
|
140
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
141
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
129
142
|
});
|
|
130
143
|
|
|
131
144
|
if (!res.ok) {
|
|
@@ -146,6 +159,7 @@ run();
|
|
|
146
159
|
| Parameter | Type | Required | Description |
|
|
147
160
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
148
161
|
| `request` | [operations.AccountV1QueueRequest](../../models/operations/accountv1queuerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
162
|
+
| `security` | [operations.AccountV1QueueSecurity](../../models/operations/accountv1queuesecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
149
163
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
150
164
|
| `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. |
|
|
151
165
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -21,7 +21,9 @@ Connect a new Social Provider
|
|
|
21
21
|
```typescript
|
|
22
22
|
import { SteamSets } from "@steamsets/client-ts";
|
|
23
23
|
|
|
24
|
-
const steamSets = new SteamSets(
|
|
24
|
+
const steamSets = new SteamSets({
|
|
25
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
26
|
+
});
|
|
25
27
|
|
|
26
28
|
async function run() {
|
|
27
29
|
const result = await steamSets.connection.accountV1ConnectionConnect({
|
|
@@ -46,7 +48,9 @@ import { connectionAccountV1ConnectionConnect } from "@steamsets/client-ts/funcs
|
|
|
46
48
|
|
|
47
49
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
48
50
|
// You can create one instance of it to use across an application.
|
|
49
|
-
const steamSets = new SteamSetsCore(
|
|
51
|
+
const steamSets = new SteamSetsCore({
|
|
52
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
53
|
+
});
|
|
50
54
|
|
|
51
55
|
async function run() {
|
|
52
56
|
const res = await connectionAccountV1ConnectionConnect(steamSets, {
|
|
@@ -97,7 +101,9 @@ Remove a connection
|
|
|
97
101
|
```typescript
|
|
98
102
|
import { SteamSets } from "@steamsets/client-ts";
|
|
99
103
|
|
|
100
|
-
const steamSets = new SteamSets(
|
|
104
|
+
const steamSets = new SteamSets({
|
|
105
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
106
|
+
});
|
|
101
107
|
|
|
102
108
|
async function run() {
|
|
103
109
|
const result = await steamSets.connection.accountV1ConnectionDeleteConnection({
|
|
@@ -121,7 +127,9 @@ import { connectionAccountV1ConnectionDeleteConnection } from "@steamsets/client
|
|
|
121
127
|
|
|
122
128
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
123
129
|
// You can create one instance of it to use across an application.
|
|
124
|
-
const steamSets = new SteamSetsCore(
|
|
130
|
+
const steamSets = new SteamSetsCore({
|
|
131
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
132
|
+
});
|
|
125
133
|
|
|
126
134
|
async function run() {
|
|
127
135
|
const res = await connectionAccountV1ConnectionDeleteConnection(steamSets, {
|
|
@@ -171,7 +179,9 @@ Make a connection visible/invisible
|
|
|
171
179
|
```typescript
|
|
172
180
|
import { SteamSets } from "@steamsets/client-ts";
|
|
173
181
|
|
|
174
|
-
const steamSets = new SteamSets(
|
|
182
|
+
const steamSets = new SteamSets({
|
|
183
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
184
|
+
});
|
|
175
185
|
|
|
176
186
|
async function run() {
|
|
177
187
|
const result = await steamSets.connection.accountV1ConnectionUpdateConnection({
|
|
@@ -196,7 +206,9 @@ import { connectionAccountV1ConnectionUpdateConnection } from "@steamsets/client
|
|
|
196
206
|
|
|
197
207
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
198
208
|
// You can create one instance of it to use across an application.
|
|
199
|
-
const steamSets = new SteamSetsCore(
|
|
209
|
+
const steamSets = new SteamSetsCore({
|
|
210
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
211
|
+
});
|
|
200
212
|
|
|
201
213
|
async function run() {
|
|
202
214
|
const res = await connectionAccountV1ConnectionUpdateConnection(steamSets, {
|
|
@@ -247,7 +259,9 @@ Verify a domain connection only atm
|
|
|
247
259
|
```typescript
|
|
248
260
|
import { SteamSets } from "@steamsets/client-ts";
|
|
249
261
|
|
|
250
|
-
const steamSets = new SteamSets(
|
|
262
|
+
const steamSets = new SteamSets({
|
|
263
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
264
|
+
});
|
|
251
265
|
|
|
252
266
|
async function run() {
|
|
253
267
|
const result = await steamSets.connection.accountV1ConnectionVerifyConnection({
|
|
@@ -271,7 +285,9 @@ import { connectionAccountV1ConnectionVerifyConnection } from "@steamsets/client
|
|
|
271
285
|
|
|
272
286
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
273
287
|
// You can create one instance of it to use across an application.
|
|
274
|
-
const steamSets = new SteamSetsCore(
|
|
288
|
+
const steamSets = new SteamSetsCore({
|
|
289
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
290
|
+
});
|
|
275
291
|
|
|
276
292
|
async function run() {
|
|
277
293
|
const res = await connectionAccountV1ConnectionVerifyConnection(steamSets, {
|
package/docs/sdks/data/README.md
CHANGED
|
@@ -30,6 +30,9 @@ const steamSets = new SteamSets();
|
|
|
30
30
|
async function run() {
|
|
31
31
|
const result = await steamSets.data.accountV1GetApps({
|
|
32
32
|
accountSearch: {},
|
|
33
|
+
}, {
|
|
34
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
35
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
33
36
|
});
|
|
34
37
|
|
|
35
38
|
// Handle the result
|
|
@@ -54,6 +57,9 @@ const steamSets = new SteamSetsCore();
|
|
|
54
57
|
async function run() {
|
|
55
58
|
const res = await dataAccountV1GetApps(steamSets, {
|
|
56
59
|
accountSearch: {},
|
|
60
|
+
}, {
|
|
61
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
62
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
57
63
|
});
|
|
58
64
|
|
|
59
65
|
if (!res.ok) {
|
|
@@ -74,6 +80,7 @@ run();
|
|
|
74
80
|
| Parameter | Type | Required | Description |
|
|
75
81
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
76
82
|
| `request` | [operations.AccountV1GetAppsRequest](../../models/operations/accountv1getappsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
83
|
+
| `security` | [operations.AccountV1GetAppsSecurity](../../models/operations/accountv1getappssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
77
84
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
78
85
|
| `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. |
|
|
79
86
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -104,6 +111,9 @@ const steamSets = new SteamSets();
|
|
|
104
111
|
async function run() {
|
|
105
112
|
const result = await steamSets.data.accountV1GetBadges({
|
|
106
113
|
accountSearch: {},
|
|
114
|
+
}, {
|
|
115
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
116
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
107
117
|
});
|
|
108
118
|
|
|
109
119
|
// Handle the result
|
|
@@ -128,6 +138,9 @@ const steamSets = new SteamSetsCore();
|
|
|
128
138
|
async function run() {
|
|
129
139
|
const res = await dataAccountV1GetBadges(steamSets, {
|
|
130
140
|
accountSearch: {},
|
|
141
|
+
}, {
|
|
142
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
143
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
131
144
|
});
|
|
132
145
|
|
|
133
146
|
if (!res.ok) {
|
|
@@ -148,6 +161,7 @@ run();
|
|
|
148
161
|
| Parameter | Type | Required | Description |
|
|
149
162
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
150
163
|
| `request` | [operations.AccountV1GetBadgesRequest](../../models/operations/accountv1getbadgesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
164
|
+
| `security` | [operations.AccountV1GetBadgesSecurity](../../models/operations/accountv1getbadgessecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
151
165
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
152
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. |
|
|
153
167
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -178,6 +192,9 @@ const steamSets = new SteamSets();
|
|
|
178
192
|
async function run() {
|
|
179
193
|
const result = await steamSets.data.accountV1GetDataPoints({
|
|
180
194
|
accountSearch: {},
|
|
195
|
+
}, {
|
|
196
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
197
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
181
198
|
});
|
|
182
199
|
|
|
183
200
|
// Handle the result
|
|
@@ -202,6 +219,9 @@ const steamSets = new SteamSetsCore();
|
|
|
202
219
|
async function run() {
|
|
203
220
|
const res = await dataAccountV1GetDataPoints(steamSets, {
|
|
204
221
|
accountSearch: {},
|
|
222
|
+
}, {
|
|
223
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
224
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
205
225
|
});
|
|
206
226
|
|
|
207
227
|
if (!res.ok) {
|
|
@@ -222,6 +242,7 @@ run();
|
|
|
222
242
|
| Parameter | Type | Required | Description |
|
|
223
243
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
224
244
|
| `request` | [operations.AccountV1GetDataPointsRequest](../../models/operations/accountv1getdatapointsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
245
|
+
| `security` | [operations.AccountV1GetDataPointsSecurity](../../models/operations/accountv1getdatapointssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
225
246
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
226
247
|
| `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. |
|
|
227
248
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -252,6 +273,9 @@ const steamSets = new SteamSets();
|
|
|
252
273
|
async function run() {
|
|
253
274
|
const result = await steamSets.data.accountV1GetFriends({
|
|
254
275
|
accountSearch: {},
|
|
276
|
+
}, {
|
|
277
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
278
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
255
279
|
});
|
|
256
280
|
|
|
257
281
|
// Handle the result
|
|
@@ -276,6 +300,9 @@ const steamSets = new SteamSetsCore();
|
|
|
276
300
|
async function run() {
|
|
277
301
|
const res = await dataAccountV1GetFriends(steamSets, {
|
|
278
302
|
accountSearch: {},
|
|
303
|
+
}, {
|
|
304
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
305
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
279
306
|
});
|
|
280
307
|
|
|
281
308
|
if (!res.ok) {
|
|
@@ -296,6 +323,7 @@ run();
|
|
|
296
323
|
| Parameter | Type | Required | Description |
|
|
297
324
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
298
325
|
| `request` | [operations.AccountV1GetFriendsRequest](../../models/operations/accountv1getfriendsrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
326
|
+
| `security` | [operations.AccountV1GetFriendsSecurity](../../models/operations/accountv1getfriendssecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
299
327
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
300
328
|
| `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. |
|
|
301
329
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -324,7 +352,10 @@ import { SteamSets } from "@steamsets/client-ts";
|
|
|
324
352
|
const steamSets = new SteamSets();
|
|
325
353
|
|
|
326
354
|
async function run() {
|
|
327
|
-
const result = await steamSets.data.accountV1GetInfo({}
|
|
355
|
+
const result = await steamSets.data.accountV1GetInfo({}, {
|
|
356
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
357
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
358
|
+
});
|
|
328
359
|
|
|
329
360
|
// Handle the result
|
|
330
361
|
console.log(result)
|
|
@@ -346,7 +377,10 @@ import { dataAccountV1GetInfo } from "@steamsets/client-ts/funcs/dataAccountV1Ge
|
|
|
346
377
|
const steamSets = new SteamSetsCore();
|
|
347
378
|
|
|
348
379
|
async function run() {
|
|
349
|
-
const res = await dataAccountV1GetInfo(steamSets, {}
|
|
380
|
+
const res = await dataAccountV1GetInfo(steamSets, {}, {
|
|
381
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
382
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
383
|
+
});
|
|
350
384
|
|
|
351
385
|
if (!res.ok) {
|
|
352
386
|
throw res.error;
|
|
@@ -366,6 +400,7 @@ run();
|
|
|
366
400
|
| Parameter | Type | Required | Description |
|
|
367
401
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
368
402
|
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
403
|
+
| `security` | [operations.AccountV1GetInfoSecurity](../../models/operations/accountv1getinfosecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
369
404
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
370
405
|
| `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. |
|
|
371
406
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -396,6 +431,9 @@ const steamSets = new SteamSets();
|
|
|
396
431
|
async function run() {
|
|
397
432
|
const result = await steamSets.data.accountV1GetLeaderboardHistory({
|
|
398
433
|
accountSearch: {},
|
|
434
|
+
}, {
|
|
435
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
436
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
399
437
|
});
|
|
400
438
|
|
|
401
439
|
// Handle the result
|
|
@@ -420,6 +458,9 @@ const steamSets = new SteamSetsCore();
|
|
|
420
458
|
async function run() {
|
|
421
459
|
const res = await dataAccountV1GetLeaderboardHistory(steamSets, {
|
|
422
460
|
accountSearch: {},
|
|
461
|
+
}, {
|
|
462
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
463
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
423
464
|
});
|
|
424
465
|
|
|
425
466
|
if (!res.ok) {
|
|
@@ -440,6 +481,7 @@ run();
|
|
|
440
481
|
| Parameter | Type | Required | Description |
|
|
441
482
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
442
483
|
| `request` | [operations.AccountV1GetLeaderboardHistoryRequest](../../models/operations/accountv1getleaderboardhistoryrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
484
|
+
| `security` | [operations.AccountV1GetLeaderboardHistorySecurity](../../models/operations/accountv1getleaderboardhistorysecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
443
485
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
444
486
|
| `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. |
|
|
445
487
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -465,7 +507,9 @@ Get Staff Members and their info
|
|
|
465
507
|
```typescript
|
|
466
508
|
import { SteamSets } from "@steamsets/client-ts";
|
|
467
509
|
|
|
468
|
-
const steamSets = new SteamSets(
|
|
510
|
+
const steamSets = new SteamSets({
|
|
511
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
512
|
+
});
|
|
469
513
|
|
|
470
514
|
async function run() {
|
|
471
515
|
const result = await steamSets.data.accountV1GetStaff();
|
|
@@ -487,7 +531,9 @@ import { dataAccountV1GetStaff } from "@steamsets/client-ts/funcs/dataAccountV1G
|
|
|
487
531
|
|
|
488
532
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
489
533
|
// You can create one instance of it to use across an application.
|
|
490
|
-
const steamSets = new SteamSetsCore(
|
|
534
|
+
const steamSets = new SteamSetsCore({
|
|
535
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
536
|
+
});
|
|
491
537
|
|
|
492
538
|
async function run() {
|
|
493
539
|
const res = await dataAccountV1GetStaff(steamSets);
|
|
@@ -541,6 +587,9 @@ async function run() {
|
|
|
541
587
|
appSearch: {
|
|
542
588
|
id: 730,
|
|
543
589
|
},
|
|
590
|
+
}, {
|
|
591
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
592
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
544
593
|
});
|
|
545
594
|
|
|
546
595
|
// Handle the result
|
|
@@ -567,6 +616,9 @@ async function run() {
|
|
|
567
616
|
appSearch: {
|
|
568
617
|
id: 730,
|
|
569
618
|
},
|
|
619
|
+
}, {
|
|
620
|
+
apiKey: "<YOUR_API_KEY_HERE>",
|
|
621
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
570
622
|
});
|
|
571
623
|
|
|
572
624
|
if (!res.ok) {
|
|
@@ -587,6 +639,7 @@ run();
|
|
|
587
639
|
| Parameter | Type | Required | Description |
|
|
588
640
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
589
641
|
| `request` | [operations.AccountV1QueueRequest](../../models/operations/accountv1queuerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
642
|
+
| `security` | [operations.AccountV1QueueSecurity](../../models/operations/accountv1queuesecurity.md) | :heavy_check_mark: | The security requirements to use for the request. |
|
|
590
643
|
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
591
644
|
| `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. |
|
|
592
645
|
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
@@ -18,7 +18,9 @@ This endpoint checks if the service is alive.
|
|
|
18
18
|
```typescript
|
|
19
19
|
import { SteamSets } from "@steamsets/client-ts";
|
|
20
20
|
|
|
21
|
-
const steamSets = new SteamSets(
|
|
21
|
+
const steamSets = new SteamSets({
|
|
22
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
23
|
+
});
|
|
22
24
|
|
|
23
25
|
async function run() {
|
|
24
26
|
const result = await steamSets.liveness.liveness();
|
|
@@ -40,7 +42,9 @@ import { livenessLiveness } from "@steamsets/client-ts/funcs/livenessLiveness.js
|
|
|
40
42
|
|
|
41
43
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
42
44
|
// You can create one instance of it to use across an application.
|
|
43
|
-
const steamSets = new SteamSetsCore(
|
|
45
|
+
const steamSets = new SteamSetsCore({
|
|
46
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
47
|
+
});
|
|
44
48
|
|
|
45
49
|
async function run() {
|
|
46
50
|
const res = await livenessLiveness(steamSets);
|
|
@@ -16,7 +16,9 @@ Get all of our available locations
|
|
|
16
16
|
```typescript
|
|
17
17
|
import { SteamSets } from "@steamsets/client-ts";
|
|
18
18
|
|
|
19
|
-
const steamSets = new SteamSets(
|
|
19
|
+
const steamSets = new SteamSets({
|
|
20
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
21
|
+
});
|
|
20
22
|
|
|
21
23
|
async function run() {
|
|
22
24
|
const result = await steamSets.location.location();
|
|
@@ -38,7 +40,9 @@ import { locationLocation } from "@steamsets/client-ts/funcs/locationLocation.js
|
|
|
38
40
|
|
|
39
41
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
40
42
|
// You can create one instance of it to use across an application.
|
|
41
|
-
const steamSets = new SteamSetsCore(
|
|
43
|
+
const steamSets = new SteamSetsCore({
|
|
44
|
+
session: "<YOUR_BEARER_TOKEN_HERE>",
|
|
45
|
+
});
|
|
42
46
|
|
|
43
47
|
async function run() {
|
|
44
48
|
const res = await locationLocation(steamSets);
|