@steamsets/client-ts 0.19.3 → 0.19.5
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 +6 -82
- package/docs/sdks/account/README.md +0 -180
- package/docs/sdks/admin/README.md +73 -0
- package/docs/sdks/badge/README.md +77 -0
- package/docs/sdks/images/README.md +0 -164
- package/docs/sdks/leaderboard/README.md +32 -8
- package/funcs/{externalGetApps.d.ts → adminAdminV1RemoveVanity.d.ts} +2 -2
- package/funcs/{internalAccountV1GetMeta.d.ts.map → adminAdminV1RemoveVanity.d.ts.map} +1 -1
- package/funcs/{accountGetAccount.js → adminAdminV1RemoveVanity.js} +7 -7
- package/funcs/{internalAccountV1GetMeta.js.map → adminAdminV1RemoveVanity.js.map} +1 -1
- package/funcs/{accountGetAccount.d.ts → badgeBadgeV1SearchSuggest.d.ts} +2 -2
- package/funcs/{dataGetLeaderboardHistory.d.ts.map → badgeBadgeV1SearchSuggest.d.ts.map} +1 -1
- package/funcs/{internalBadgeV1TagsSuggest.js → badgeBadgeV1SearchSuggest.js} +8 -8
- package/funcs/{dataGetLeaderboardHistory.js.map → badgeBadgeV1SearchSuggest.js.map} +1 -1
- package/funcs/{accountLeaderboardV1GetAccountMeta.d.ts → leaderboardLeaderboardV1GetLeaderboardAccountMeta.d.ts} +2 -2
- package/funcs/{externalGetBadges.d.ts.map → leaderboardLeaderboardV1GetLeaderboardAccountMeta.d.ts.map} +1 -1
- package/funcs/{internalLeaderboardV1GetAccountMeta.js → leaderboardLeaderboardV1GetLeaderboardAccountMeta.js} +5 -7
- package/funcs/leaderboardLeaderboardV1GetLeaderboardAccountMeta.js.map +1 -0
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/models/components/index.d.ts +3 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +3 -0
- package/models/components/index.js.map +1 -1
- package/models/components/v1adminremovevanityresponsebody.d.ts +32 -0
- package/models/components/v1adminremovevanityresponsebody.d.ts.map +1 -0
- package/models/components/v1adminremovevanityresponsebody.js +68 -0
- package/models/components/v1adminremovevanityresponsebody.js.map +1 -0
- package/models/components/v1badgesearchsuggestbody.d.ts +37 -0
- package/models/components/v1badgesearchsuggestbody.d.ts.map +1 -0
- package/models/components/v1badgesearchsuggestbody.js +70 -0
- package/models/components/v1badgesearchsuggestbody.js.map +1 -0
- package/models/components/v1badgesearchsuggesttrequestbody.d.ts +32 -0
- package/models/components/v1badgesearchsuggesttrequestbody.d.ts.map +1 -0
- package/models/components/v1badgesearchsuggesttrequestbody.js +59 -0
- package/models/components/v1badgesearchsuggesttrequestbody.js.map +1 -0
- package/models/operations/adminv1removevanity.d.ts +35 -0
- package/models/operations/adminv1removevanity.d.ts.map +1 -0
- package/models/operations/adminv1removevanity.js +75 -0
- package/models/operations/adminv1removevanity.js.map +1 -0
- package/models/operations/badgev1searchsuggest.d.ts +35 -0
- package/models/operations/badgev1searchsuggest.d.ts.map +1 -0
- package/models/operations/badgev1searchsuggest.js +75 -0
- package/models/operations/badgev1searchsuggest.js.map +1 -0
- package/models/operations/index.d.ts +3 -1
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +3 -1
- package/models/operations/index.js.map +1 -1
- package/models/operations/leaderboardv1getleaderboardaccountmeta.d.ts +35 -0
- package/models/operations/leaderboardv1getleaderboardaccountmeta.d.ts.map +1 -0
- package/models/operations/{leaderboardv1getaccountmeta.js → leaderboardv1getleaderboardaccountmeta.js} +17 -17
- package/models/operations/leaderboardv1getleaderboardaccountmeta.js.map +1 -0
- package/package.json +1 -1
- package/sdk/account.d.ts +0 -2
- package/sdk/account.d.ts.map +1 -1
- package/sdk/account.js +0 -8
- package/sdk/account.js.map +1 -1
- package/sdk/admin.d.ts +1 -0
- package/sdk/admin.d.ts.map +1 -1
- package/sdk/admin.js +4 -0
- package/sdk/admin.js.map +1 -1
- package/sdk/badge.d.ts +1 -0
- package/sdk/badge.d.ts.map +1 -1
- package/sdk/badge.js +4 -0
- package/sdk/badge.js.map +1 -1
- package/sdk/images.d.ts +0 -2
- package/sdk/images.d.ts.map +1 -1
- package/sdk/images.js +0 -8
- package/sdk/images.js.map +1 -1
- package/sdk/leaderboard.d.ts +1 -1
- package/sdk/leaderboard.d.ts.map +1 -1
- package/sdk/leaderboard.js +3 -3
- package/sdk/leaderboard.js.map +1 -1
- package/sdk/sdk.d.ts +2 -14
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +2 -18
- package/sdk/sdk.js.map +1 -1
- package/src/funcs/{externalGetInfo.ts → adminAdminV1RemoveVanity.ts} +8 -8
- package/src/funcs/{internalBadgeV1TagsSuggest.ts → badgeBadgeV1SearchSuggest.ts} +11 -11
- package/src/funcs/{internalLeaderboardV1GetAccountMeta.ts → leaderboardLeaderboardV1GetLeaderboardAccountMeta.ts} +10 -8
- package/src/lib/config.ts +2 -2
- package/src/models/components/index.ts +3 -0
- package/src/models/components/v1adminremovevanityresponsebody.ts +80 -0
- package/src/models/components/v1badgesearchsuggestbody.ts +85 -0
- package/src/models/components/v1badgesearchsuggesttrequestbody.ts +71 -0
- package/src/models/operations/adminv1removevanity.ts +93 -0
- package/src/models/operations/badgev1searchsuggest.ts +91 -0
- package/src/models/operations/index.ts +3 -1
- package/src/models/operations/leaderboardv1getleaderboardaccountmeta.ts +107 -0
- package/src/sdk/account.ts +0 -24
- package/src/sdk/admin.ts +12 -0
- package/src/sdk/badge.ts +12 -0
- package/src/sdk/images.ts +0 -24
- package/src/sdk/leaderboard.ts +4 -4
- package/src/sdk/sdk.ts +3 -27
- package/docs/sdks/data/README.md +0 -520
- package/docs/sdks/developer/README.md +0 -252
- package/docs/sdks/external/README.md +0 -596
- package/docs/sdks/internal/README.md +0 -963
- package/funcs/accountGetAccount.d.ts.map +0 -1
- package/funcs/accountGetAccount.js.map +0 -1
- package/funcs/accountLeaderboardV1GetAccountMeta.d.ts.map +0 -1
- package/funcs/accountLeaderboardV1GetAccountMeta.js +0 -118
- package/funcs/accountLeaderboardV1GetAccountMeta.js.map +0 -1
- package/funcs/dataAccountV1GetMeta.d.ts +0 -12
- package/funcs/dataAccountV1GetMeta.d.ts.map +0 -1
- package/funcs/dataAccountV1GetMeta.js +0 -118
- package/funcs/dataAccountV1GetMeta.js.map +0 -1
- package/funcs/dataGetApps.d.ts +0 -12
- package/funcs/dataGetApps.d.ts.map +0 -1
- package/funcs/dataGetApps.js +0 -118
- package/funcs/dataGetApps.js.map +0 -1
- package/funcs/dataGetBadges.d.ts +0 -12
- package/funcs/dataGetBadges.d.ts.map +0 -1
- package/funcs/dataGetBadges.js +0 -118
- package/funcs/dataGetBadges.js.map +0 -1
- package/funcs/dataGetDataPoints.d.ts +0 -12
- package/funcs/dataGetDataPoints.d.ts.map +0 -1
- package/funcs/dataGetDataPoints.js +0 -118
- package/funcs/dataGetDataPoints.js.map +0 -1
- package/funcs/dataGetFriends.d.ts +0 -12
- package/funcs/dataGetFriends.d.ts.map +0 -1
- package/funcs/dataGetFriends.js +0 -118
- package/funcs/dataGetFriends.js.map +0 -1
- package/funcs/dataGetInfo.d.ts +0 -12
- package/funcs/dataGetInfo.d.ts.map +0 -1
- package/funcs/dataGetInfo.js +0 -118
- package/funcs/dataGetInfo.js.map +0 -1
- package/funcs/dataGetLeaderboardHistory.d.ts +0 -12
- package/funcs/dataGetLeaderboardHistory.js +0 -116
- package/funcs/developerCreateDeveloperApp.d.ts +0 -12
- package/funcs/developerCreateDeveloperApp.d.ts.map +0 -1
- package/funcs/developerCreateDeveloperApp.js +0 -116
- package/funcs/developerCreateDeveloperApp.js.map +0 -1
- package/funcs/developerDeleteDeveloperApp.d.ts +0 -12
- package/funcs/developerDeleteDeveloperApp.d.ts.map +0 -1
- package/funcs/developerDeleteDeveloperApp.js +0 -116
- package/funcs/developerDeleteDeveloperApp.js.map +0 -1
- package/funcs/developerUpdateApp.d.ts +0 -12
- package/funcs/developerUpdateApp.d.ts.map +0 -1
- package/funcs/developerUpdateApp.js +0 -116
- package/funcs/developerUpdateApp.js.map +0 -1
- package/funcs/externalAppV1ListBadges.d.ts +0 -12
- package/funcs/externalAppV1ListBadges.d.ts.map +0 -1
- package/funcs/externalAppV1ListBadges.js +0 -118
- package/funcs/externalAppV1ListBadges.js.map +0 -1
- package/funcs/externalGet.d.ts +0 -11
- package/funcs/externalGet.d.ts.map +0 -1
- package/funcs/externalGet.js +0 -107
- package/funcs/externalGet.js.map +0 -1
- package/funcs/externalGetApps.d.ts.map +0 -1
- package/funcs/externalGetApps.js +0 -118
- package/funcs/externalGetApps.js.map +0 -1
- package/funcs/externalGetBadges.d.ts +0 -12
- package/funcs/externalGetBadges.js +0 -118
- package/funcs/externalGetBadges.js.map +0 -1
- package/funcs/externalGetDataPoints.d.ts +0 -12
- package/funcs/externalGetDataPoints.d.ts.map +0 -1
- package/funcs/externalGetDataPoints.js +0 -118
- package/funcs/externalGetDataPoints.js.map +0 -1
- package/funcs/externalGetFriends.d.ts +0 -12
- package/funcs/externalGetFriends.d.ts.map +0 -1
- package/funcs/externalGetFriends.js +0 -118
- package/funcs/externalGetFriends.js.map +0 -1
- package/funcs/externalGetInfo.d.ts +0 -12
- package/funcs/externalGetInfo.d.ts.map +0 -1
- package/funcs/externalGetInfo.js +0 -118
- package/funcs/externalGetInfo.js.map +0 -1
- package/funcs/externalGetLeaderboardHistory.d.ts +0 -12
- package/funcs/externalGetLeaderboardHistory.d.ts.map +0 -1
- package/funcs/externalGetLeaderboardHistory.js +0 -116
- package/funcs/externalGetLeaderboardHistory.js.map +0 -1
- package/funcs/imagesDeleteImages.d.ts +0 -12
- package/funcs/imagesDeleteImages.d.ts.map +0 -1
- package/funcs/imagesDeleteImages.js +0 -118
- package/funcs/imagesDeleteImages.js.map +0 -1
- package/funcs/imagesUploadImages.d.ts +0 -12
- package/funcs/imagesUploadImages.d.ts.map +0 -1
- package/funcs/imagesUploadImages.js +0 -118
- package/funcs/imagesUploadImages.js.map +0 -1
- package/funcs/internalAccountV1GetMeta.d.ts +0 -12
- package/funcs/internalAccountV1GetMeta.js +0 -118
- package/funcs/internalBadgeV1TagsSuggest.d.ts +0 -12
- package/funcs/internalBadgeV1TagsSuggest.d.ts.map +0 -1
- package/funcs/internalBadgeV1TagsSuggest.js.map +0 -1
- package/funcs/internalCheck.d.ts +0 -17
- package/funcs/internalCheck.d.ts.map +0 -1
- package/funcs/internalCheck.js +0 -111
- package/funcs/internalCheck.js.map +0 -1
- package/funcs/internalCreateDeveloperApp.d.ts +0 -12
- package/funcs/internalCreateDeveloperApp.d.ts.map +0 -1
- package/funcs/internalCreateDeveloperApp.js +0 -116
- package/funcs/internalCreateDeveloperApp.js.map +0 -1
- package/funcs/internalDeleteDeveloperApp.d.ts +0 -12
- package/funcs/internalDeleteDeveloperApp.d.ts.map +0 -1
- package/funcs/internalDeleteDeveloperApp.js +0 -116
- package/funcs/internalDeleteDeveloperApp.js.map +0 -1
- package/funcs/internalDeleteImages.d.ts +0 -12
- package/funcs/internalDeleteImages.d.ts.map +0 -1
- package/funcs/internalDeleteImages.js +0 -118
- package/funcs/internalDeleteImages.js.map +0 -1
- package/funcs/internalGetAccount.d.ts +0 -12
- package/funcs/internalGetAccount.d.ts.map +0 -1
- package/funcs/internalGetAccount.js +0 -118
- package/funcs/internalGetAccount.js.map +0 -1
- package/funcs/internalGetStaff.d.ts +0 -11
- package/funcs/internalGetStaff.d.ts.map +0 -1
- package/funcs/internalGetStaff.js +0 -107
- package/funcs/internalGetStaff.js.map +0 -1
- package/funcs/internalGetTags.d.ts +0 -11
- package/funcs/internalGetTags.d.ts.map +0 -1
- package/funcs/internalGetTags.js +0 -107
- package/funcs/internalGetTags.js.map +0 -1
- package/funcs/internalLeaderboardV1GetAccountMeta.d.ts +0 -12
- package/funcs/internalLeaderboardV1GetAccountMeta.d.ts.map +0 -1
- package/funcs/internalLeaderboardV1GetAccountMeta.js.map +0 -1
- package/funcs/internalUpdateApp.d.ts +0 -12
- package/funcs/internalUpdateApp.d.ts.map +0 -1
- package/funcs/internalUpdateApp.js +0 -116
- package/funcs/internalUpdateApp.js.map +0 -1
- package/funcs/internalUploadImages.d.ts +0 -12
- package/funcs/internalUploadImages.d.ts.map +0 -1
- package/funcs/internalUploadImages.js +0 -118
- package/funcs/internalUploadImages.js.map +0 -1
- package/funcs/leaderboardLeaderboardV1GetAccountMeta.d.ts +0 -12
- package/funcs/leaderboardLeaderboardV1GetAccountMeta.d.ts.map +0 -1
- package/funcs/leaderboardLeaderboardV1GetAccountMeta.js +0 -118
- package/funcs/leaderboardLeaderboardV1GetAccountMeta.js.map +0 -1
- package/models/operations/leaderboardv1getaccountmeta.d.ts +0 -35
- package/models/operations/leaderboardv1getaccountmeta.d.ts.map +0 -1
- package/models/operations/leaderboardv1getaccountmeta.js.map +0 -1
- package/sdk/data.d.ts +0 -13
- package/sdk/data.d.ts.map +0 -1
- package/sdk/data.js +0 -40
- package/sdk/data.js.map +0 -1
- package/sdk/developer.d.ts +0 -9
- package/sdk/developer.d.ts.map +0 -1
- package/sdk/developer.js +0 -24
- package/sdk/developer.js.map +0 -1
- package/sdk/external.d.ts +0 -14
- package/sdk/external.d.ts.map +0 -1
- package/sdk/external.js +0 -44
- package/sdk/external.js.map +0 -1
- package/sdk/internal.d.ts +0 -24
- package/sdk/internal.d.ts.map +0 -1
- package/sdk/internal.js +0 -66
- package/sdk/internal.js.map +0 -1
- package/src/funcs/accountGetAccount.ts +0 -179
- package/src/funcs/accountLeaderboardV1GetAccountMeta.ts +0 -184
- package/src/funcs/dataAccountV1GetMeta.ts +0 -179
- package/src/funcs/dataGetApps.ts +0 -179
- package/src/funcs/dataGetBadges.ts +0 -179
- package/src/funcs/dataGetDataPoints.ts +0 -179
- package/src/funcs/dataGetFriends.ts +0 -179
- package/src/funcs/dataGetInfo.ts +0 -179
- package/src/funcs/dataGetLeaderboardHistory.ts +0 -181
- package/src/funcs/developerCreateDeveloperApp.ts +0 -182
- package/src/funcs/developerDeleteDeveloperApp.ts +0 -184
- package/src/funcs/developerUpdateApp.ts +0 -184
- package/src/funcs/externalAppV1ListBadges.ts +0 -179
- package/src/funcs/externalGet.ts +0 -160
- package/src/funcs/externalGetApps.ts +0 -179
- package/src/funcs/externalGetBadges.ts +0 -179
- package/src/funcs/externalGetDataPoints.ts +0 -179
- package/src/funcs/externalGetFriends.ts +0 -179
- package/src/funcs/externalGetLeaderboardHistory.ts +0 -181
- package/src/funcs/imagesDeleteImages.ts +0 -179
- package/src/funcs/imagesUploadImages.ts +0 -179
- package/src/funcs/internalAccountV1GetMeta.ts +0 -179
- package/src/funcs/internalCheck.ts +0 -160
- package/src/funcs/internalCreateDeveloperApp.ts +0 -182
- package/src/funcs/internalDeleteDeveloperApp.ts +0 -184
- package/src/funcs/internalDeleteImages.ts +0 -179
- package/src/funcs/internalGetAccount.ts +0 -179
- package/src/funcs/internalGetStaff.ts +0 -160
- package/src/funcs/internalGetTags.ts +0 -160
- package/src/funcs/internalUpdateApp.ts +0 -184
- package/src/funcs/internalUploadImages.ts +0 -179
- package/src/funcs/leaderboardLeaderboardV1GetAccountMeta.ts +0 -184
- package/src/models/operations/leaderboardv1getaccountmeta.ts +0 -98
- package/src/sdk/data.ts +0 -94
- package/src/sdk/developer.ts +0 -46
- package/src/sdk/external.ts +0 -104
- package/src/sdk/internal.ts +0 -154
|
@@ -1,963 +0,0 @@
|
|
|
1
|
-
# Internal
|
|
2
|
-
(*internal*)
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
There requests are just document for documentations sake, they are not meant to be used. If you are looking to use one of these endpoints, please contact us.
|
|
7
|
-
|
|
8
|
-
### Available Operations
|
|
9
|
-
|
|
10
|
-
* [createDeveloperApp](#createdeveloperapp)
|
|
11
|
-
* [deleteDeveloperApp](#deletedeveloperapp)
|
|
12
|
-
* [deleteImages](#deleteimages)
|
|
13
|
-
* [updateApp](#updateapp)
|
|
14
|
-
* [accountV1GetMeta](#accountv1getmeta)
|
|
15
|
-
* [getStaff](#getstaff)
|
|
16
|
-
* [uploadImages](#uploadimages)
|
|
17
|
-
* [getAccount](#getaccount)
|
|
18
|
-
* [getTags](#gettags)
|
|
19
|
-
* [badgeV1TagsSuggest](#badgev1tagssuggest)
|
|
20
|
-
* [leaderboardV1GetAccountMeta](#leaderboardv1getaccountmeta)
|
|
21
|
-
* [check](#check) - Liveness check
|
|
22
|
-
|
|
23
|
-
## createDeveloperApp
|
|
24
|
-
|
|
25
|
-
### Example Usage
|
|
26
|
-
|
|
27
|
-
```typescript
|
|
28
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
29
|
-
|
|
30
|
-
const steamSets = new SteamSets({
|
|
31
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
32
|
-
});
|
|
33
|
-
|
|
34
|
-
async function run() {
|
|
35
|
-
const result = await steamSets.internal.createDeveloperApp({
|
|
36
|
-
description: "Your App Description",
|
|
37
|
-
environment: "production",
|
|
38
|
-
generateKey: true,
|
|
39
|
-
name: "Your App",
|
|
40
|
-
});
|
|
41
|
-
|
|
42
|
-
// Handle the result
|
|
43
|
-
console.log(result);
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
run();
|
|
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 { internalCreateDeveloperApp } from "@steamsets/client-ts/funcs/internalCreateDeveloperApp.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
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
61
|
-
});
|
|
62
|
-
|
|
63
|
-
async function run() {
|
|
64
|
-
const res = await internalCreateDeveloperApp(steamSets, {
|
|
65
|
-
description: "Your App Description",
|
|
66
|
-
environment: "production",
|
|
67
|
-
generateKey: true,
|
|
68
|
-
name: "Your App",
|
|
69
|
-
});
|
|
70
|
-
|
|
71
|
-
if (!res.ok) {
|
|
72
|
-
throw res.error;
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
const { value: result } = res;
|
|
76
|
-
|
|
77
|
-
// Handle the result
|
|
78
|
-
console.log(result);
|
|
79
|
-
}
|
|
80
|
-
|
|
81
|
-
run();
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
### Parameters
|
|
85
|
-
|
|
86
|
-
| Parameter | Type | Required | Description |
|
|
87
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
88
|
-
| `request` | [components.V1DeveloperAppCreateRequestBody](../../models/components/v1developerappcreaterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
89
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
90
|
-
| `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. |
|
|
91
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
92
|
-
|
|
93
|
-
### Response
|
|
94
|
-
|
|
95
|
-
**Promise\<[operations.AccountV1SettingsDeveloperAppCreateResponse](../../models/operations/accountv1settingsdeveloperappcreateresponse.md)\>**
|
|
96
|
-
|
|
97
|
-
### Errors
|
|
98
|
-
|
|
99
|
-
| Error Type | Status Code | Content Type |
|
|
100
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
101
|
-
| errors.ErrorModel | 400, 404, 422 | application/problem+json |
|
|
102
|
-
| errors.ErrorModel | 500 | application/problem+json |
|
|
103
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
104
|
-
|
|
105
|
-
## deleteDeveloperApp
|
|
106
|
-
|
|
107
|
-
### Example Usage
|
|
108
|
-
|
|
109
|
-
```typescript
|
|
110
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
111
|
-
|
|
112
|
-
const steamSets = new SteamSets({
|
|
113
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
114
|
-
});
|
|
115
|
-
|
|
116
|
-
async function run() {
|
|
117
|
-
const result = await steamSets.internal.deleteDeveloperApp({
|
|
118
|
-
developerAppId: "da_123456",
|
|
119
|
-
});
|
|
120
|
-
|
|
121
|
-
// Handle the result
|
|
122
|
-
console.log(result);
|
|
123
|
-
}
|
|
124
|
-
|
|
125
|
-
run();
|
|
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 { internalDeleteDeveloperApp } from "@steamsets/client-ts/funcs/internalDeleteDeveloperApp.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
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
140
|
-
});
|
|
141
|
-
|
|
142
|
-
async function run() {
|
|
143
|
-
const res = await internalDeleteDeveloperApp(steamSets, {
|
|
144
|
-
developerAppId: "da_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.V1AccountDeveloperAppDeleteRequestBody](../../models/components/v1accountdeveloperappdeleterequestbody.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
|
-
### Response
|
|
170
|
-
|
|
171
|
-
**Promise\<[operations.AccountV1SettingsDeveloperAppDeleteResponse](../../models/operations/accountv1settingsdeveloperappdeleteresponse.md)\>**
|
|
172
|
-
|
|
173
|
-
### Errors
|
|
174
|
-
|
|
175
|
-
| Error Type | Status Code | Content Type |
|
|
176
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
177
|
-
| errors.ErrorModel | 404, 422, 429 | application/problem+json |
|
|
178
|
-
| errors.ErrorModel | 500 | application/problem+json |
|
|
179
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
180
|
-
|
|
181
|
-
## deleteImages
|
|
182
|
-
|
|
183
|
-
### Example Usage
|
|
184
|
-
|
|
185
|
-
```typescript
|
|
186
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
187
|
-
|
|
188
|
-
const steamSets = new SteamSets({
|
|
189
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
190
|
-
});
|
|
191
|
-
|
|
192
|
-
async function run() {
|
|
193
|
-
const result = await steamSets.internal.deleteImages({
|
|
194
|
-
imageIds: [
|
|
195
|
-
"<value>",
|
|
196
|
-
"<value>",
|
|
197
|
-
],
|
|
198
|
-
});
|
|
199
|
-
|
|
200
|
-
// Handle the result
|
|
201
|
-
console.log(result);
|
|
202
|
-
}
|
|
203
|
-
|
|
204
|
-
run();
|
|
205
|
-
```
|
|
206
|
-
|
|
207
|
-
### Standalone function
|
|
208
|
-
|
|
209
|
-
The standalone function version of this method:
|
|
210
|
-
|
|
211
|
-
```typescript
|
|
212
|
-
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
213
|
-
import { internalDeleteImages } from "@steamsets/client-ts/funcs/internalDeleteImages.js";
|
|
214
|
-
|
|
215
|
-
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
216
|
-
// You can create one instance of it to use across an application.
|
|
217
|
-
const steamSets = new SteamSetsCore({
|
|
218
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
219
|
-
});
|
|
220
|
-
|
|
221
|
-
async function run() {
|
|
222
|
-
const res = await internalDeleteImages(steamSets, {
|
|
223
|
-
imageIds: [
|
|
224
|
-
"<value>",
|
|
225
|
-
"<value>",
|
|
226
|
-
],
|
|
227
|
-
});
|
|
228
|
-
|
|
229
|
-
if (!res.ok) {
|
|
230
|
-
throw res.error;
|
|
231
|
-
}
|
|
232
|
-
|
|
233
|
-
const { value: result } = res;
|
|
234
|
-
|
|
235
|
-
// Handle the result
|
|
236
|
-
console.log(result);
|
|
237
|
-
}
|
|
238
|
-
|
|
239
|
-
run();
|
|
240
|
-
```
|
|
241
|
-
|
|
242
|
-
### Parameters
|
|
243
|
-
|
|
244
|
-
| Parameter | Type | Required | Description |
|
|
245
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
246
|
-
| `request` | [components.V1DeleteImagesRequestBody](../../models/components/v1deleteimagesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
247
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
248
|
-
| `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. |
|
|
249
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
250
|
-
|
|
251
|
-
### Response
|
|
252
|
-
|
|
253
|
-
**Promise\<[operations.AccountV1ImagesDeleteResponse](../../models/operations/accountv1imagesdeleteresponse.md)\>**
|
|
254
|
-
|
|
255
|
-
### Errors
|
|
256
|
-
|
|
257
|
-
| Error Type | Status Code | Content Type |
|
|
258
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
259
|
-
| errors.ErrorModel | 404, 422 | application/problem+json |
|
|
260
|
-
| errors.ErrorModel | 500 | application/problem+json |
|
|
261
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
262
|
-
|
|
263
|
-
## updateApp
|
|
264
|
-
|
|
265
|
-
### Example Usage
|
|
266
|
-
|
|
267
|
-
```typescript
|
|
268
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
269
|
-
|
|
270
|
-
const steamSets = new SteamSets({
|
|
271
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
272
|
-
});
|
|
273
|
-
|
|
274
|
-
async function run() {
|
|
275
|
-
const result = await steamSets.internal.updateApp({
|
|
276
|
-
description: "My App Description",
|
|
277
|
-
developerAppId: "da_123456",
|
|
278
|
-
name: "My App",
|
|
279
|
-
regenerate: true,
|
|
280
|
-
});
|
|
281
|
-
|
|
282
|
-
// Handle the result
|
|
283
|
-
console.log(result);
|
|
284
|
-
}
|
|
285
|
-
|
|
286
|
-
run();
|
|
287
|
-
```
|
|
288
|
-
|
|
289
|
-
### Standalone function
|
|
290
|
-
|
|
291
|
-
The standalone function version of this method:
|
|
292
|
-
|
|
293
|
-
```typescript
|
|
294
|
-
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
295
|
-
import { internalUpdateApp } from "@steamsets/client-ts/funcs/internalUpdateApp.js";
|
|
296
|
-
|
|
297
|
-
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
298
|
-
// You can create one instance of it to use across an application.
|
|
299
|
-
const steamSets = new SteamSetsCore({
|
|
300
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
301
|
-
});
|
|
302
|
-
|
|
303
|
-
async function run() {
|
|
304
|
-
const res = await internalUpdateApp(steamSets, {
|
|
305
|
-
description: "My App Description",
|
|
306
|
-
developerAppId: "da_123456",
|
|
307
|
-
name: "My App",
|
|
308
|
-
regenerate: true,
|
|
309
|
-
});
|
|
310
|
-
|
|
311
|
-
if (!res.ok) {
|
|
312
|
-
throw res.error;
|
|
313
|
-
}
|
|
314
|
-
|
|
315
|
-
const { value: result } = res;
|
|
316
|
-
|
|
317
|
-
// Handle the result
|
|
318
|
-
console.log(result);
|
|
319
|
-
}
|
|
320
|
-
|
|
321
|
-
run();
|
|
322
|
-
```
|
|
323
|
-
|
|
324
|
-
### Parameters
|
|
325
|
-
|
|
326
|
-
| Parameter | Type | Required | Description |
|
|
327
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
328
|
-
| `request` | [components.V1AccountDeveloperAppUpdateRequestBody](../../models/components/v1accountdeveloperappupdaterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
329
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
330
|
-
| `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. |
|
|
331
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
332
|
-
|
|
333
|
-
### Response
|
|
334
|
-
|
|
335
|
-
**Promise\<[operations.AccountV1SettingsDeveloperAppUpdateResponse](../../models/operations/accountv1settingsdeveloperappupdateresponse.md)\>**
|
|
336
|
-
|
|
337
|
-
### Errors
|
|
338
|
-
|
|
339
|
-
| Error Type | Status Code | Content Type |
|
|
340
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
341
|
-
| errors.ErrorModel | 404, 422, 429 | application/problem+json |
|
|
342
|
-
| errors.ErrorModel | 500 | application/problem+json |
|
|
343
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
344
|
-
|
|
345
|
-
## accountV1GetMeta
|
|
346
|
-
|
|
347
|
-
### Example Usage
|
|
348
|
-
|
|
349
|
-
```typescript
|
|
350
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
351
|
-
|
|
352
|
-
const steamSets = new SteamSets({
|
|
353
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
354
|
-
});
|
|
355
|
-
|
|
356
|
-
async function run() {
|
|
357
|
-
const result = await steamSets.internal.accountV1GetMeta({});
|
|
358
|
-
|
|
359
|
-
// Handle the result
|
|
360
|
-
console.log(result);
|
|
361
|
-
}
|
|
362
|
-
|
|
363
|
-
run();
|
|
364
|
-
```
|
|
365
|
-
|
|
366
|
-
### Standalone function
|
|
367
|
-
|
|
368
|
-
The standalone function version of this method:
|
|
369
|
-
|
|
370
|
-
```typescript
|
|
371
|
-
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
372
|
-
import { internalAccountV1GetMeta } from "@steamsets/client-ts/funcs/internalAccountV1GetMeta.js";
|
|
373
|
-
|
|
374
|
-
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
375
|
-
// You can create one instance of it to use across an application.
|
|
376
|
-
const steamSets = new SteamSetsCore({
|
|
377
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
378
|
-
});
|
|
379
|
-
|
|
380
|
-
async function run() {
|
|
381
|
-
const res = await internalAccountV1GetMeta(steamSets, {});
|
|
382
|
-
|
|
383
|
-
if (!res.ok) {
|
|
384
|
-
throw res.error;
|
|
385
|
-
}
|
|
386
|
-
|
|
387
|
-
const { value: result } = res;
|
|
388
|
-
|
|
389
|
-
// Handle the result
|
|
390
|
-
console.log(result);
|
|
391
|
-
}
|
|
392
|
-
|
|
393
|
-
run();
|
|
394
|
-
```
|
|
395
|
-
|
|
396
|
-
### Parameters
|
|
397
|
-
|
|
398
|
-
| Parameter | Type | Required | Description |
|
|
399
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
400
|
-
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
401
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
402
|
-
| `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. |
|
|
403
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
404
|
-
|
|
405
|
-
### Response
|
|
406
|
-
|
|
407
|
-
**Promise\<[operations.AccountV1GetMetaResponse](../../models/operations/accountv1getmetaresponse.md)\>**
|
|
408
|
-
|
|
409
|
-
### Errors
|
|
410
|
-
|
|
411
|
-
| Error Type | Status Code | Content Type |
|
|
412
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
413
|
-
| errors.ErrorModel | 404, 422 | application/problem+json |
|
|
414
|
-
| errors.ErrorModel | 500 | application/problem+json |
|
|
415
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
416
|
-
|
|
417
|
-
## getStaff
|
|
418
|
-
|
|
419
|
-
### Example Usage
|
|
420
|
-
|
|
421
|
-
```typescript
|
|
422
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
423
|
-
|
|
424
|
-
const steamSets = new SteamSets({
|
|
425
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
426
|
-
});
|
|
427
|
-
|
|
428
|
-
async function run() {
|
|
429
|
-
const result = await steamSets.internal.getStaff();
|
|
430
|
-
|
|
431
|
-
// Handle the result
|
|
432
|
-
console.log(result);
|
|
433
|
-
}
|
|
434
|
-
|
|
435
|
-
run();
|
|
436
|
-
```
|
|
437
|
-
|
|
438
|
-
### Standalone function
|
|
439
|
-
|
|
440
|
-
The standalone function version of this method:
|
|
441
|
-
|
|
442
|
-
```typescript
|
|
443
|
-
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
444
|
-
import { internalGetStaff } from "@steamsets/client-ts/funcs/internalGetStaff.js";
|
|
445
|
-
|
|
446
|
-
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
447
|
-
// You can create one instance of it to use across an application.
|
|
448
|
-
const steamSets = new SteamSetsCore({
|
|
449
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
450
|
-
});
|
|
451
|
-
|
|
452
|
-
async function run() {
|
|
453
|
-
const res = await internalGetStaff(steamSets);
|
|
454
|
-
|
|
455
|
-
if (!res.ok) {
|
|
456
|
-
throw res.error;
|
|
457
|
-
}
|
|
458
|
-
|
|
459
|
-
const { value: result } = res;
|
|
460
|
-
|
|
461
|
-
// Handle the result
|
|
462
|
-
console.log(result);
|
|
463
|
-
}
|
|
464
|
-
|
|
465
|
-
run();
|
|
466
|
-
```
|
|
467
|
-
|
|
468
|
-
### Parameters
|
|
469
|
-
|
|
470
|
-
| Parameter | Type | Required | Description |
|
|
471
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
472
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
473
|
-
| `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. |
|
|
474
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
475
|
-
|
|
476
|
-
### Response
|
|
477
|
-
|
|
478
|
-
**Promise\<[operations.AccountV1GetStaffResponse](../../models/operations/accountv1getstaffresponse.md)\>**
|
|
479
|
-
|
|
480
|
-
### Errors
|
|
481
|
-
|
|
482
|
-
| Error Type | Status Code | Content Type |
|
|
483
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
484
|
-
| errors.ErrorModel | 404, 429 | application/problem+json |
|
|
485
|
-
| errors.ErrorModel | 500 | application/problem+json |
|
|
486
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
487
|
-
|
|
488
|
-
## uploadImages
|
|
489
|
-
|
|
490
|
-
### Example Usage
|
|
491
|
-
|
|
492
|
-
```typescript
|
|
493
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
494
|
-
|
|
495
|
-
const steamSets = new SteamSets({
|
|
496
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
497
|
-
});
|
|
498
|
-
|
|
499
|
-
async function run() {
|
|
500
|
-
const result = await steamSets.internal.uploadImages({
|
|
501
|
-
images: [
|
|
502
|
-
|
|
503
|
-
],
|
|
504
|
-
});
|
|
505
|
-
|
|
506
|
-
// Handle the result
|
|
507
|
-
console.log(result);
|
|
508
|
-
}
|
|
509
|
-
|
|
510
|
-
run();
|
|
511
|
-
```
|
|
512
|
-
|
|
513
|
-
### Standalone function
|
|
514
|
-
|
|
515
|
-
The standalone function version of this method:
|
|
516
|
-
|
|
517
|
-
```typescript
|
|
518
|
-
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
519
|
-
import { internalUploadImages } from "@steamsets/client-ts/funcs/internalUploadImages.js";
|
|
520
|
-
|
|
521
|
-
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
522
|
-
// You can create one instance of it to use across an application.
|
|
523
|
-
const steamSets = new SteamSetsCore({
|
|
524
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
525
|
-
});
|
|
526
|
-
|
|
527
|
-
async function run() {
|
|
528
|
-
const res = await internalUploadImages(steamSets, {
|
|
529
|
-
images: [
|
|
530
|
-
|
|
531
|
-
],
|
|
532
|
-
});
|
|
533
|
-
|
|
534
|
-
if (!res.ok) {
|
|
535
|
-
throw res.error;
|
|
536
|
-
}
|
|
537
|
-
|
|
538
|
-
const { value: result } = res;
|
|
539
|
-
|
|
540
|
-
// Handle the result
|
|
541
|
-
console.log(result);
|
|
542
|
-
}
|
|
543
|
-
|
|
544
|
-
run();
|
|
545
|
-
```
|
|
546
|
-
|
|
547
|
-
### Parameters
|
|
548
|
-
|
|
549
|
-
| Parameter | Type | Required | Description |
|
|
550
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
551
|
-
| `request` | [components.V1UploadImagesRequestBody](../../models/components/v1uploadimagesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
552
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
553
|
-
| `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. |
|
|
554
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
555
|
-
|
|
556
|
-
### Response
|
|
557
|
-
|
|
558
|
-
**Promise\<[operations.AccountV1ImagesUploadResponse](../../models/operations/accountv1imagesuploadresponse.md)\>**
|
|
559
|
-
|
|
560
|
-
### Errors
|
|
561
|
-
|
|
562
|
-
| Error Type | Status Code | Content Type |
|
|
563
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
564
|
-
| errors.ErrorModel | 422 | application/problem+json |
|
|
565
|
-
| errors.ErrorModel | 500 | application/problem+json |
|
|
566
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
567
|
-
|
|
568
|
-
## getAccount
|
|
569
|
-
|
|
570
|
-
### Example Usage
|
|
571
|
-
|
|
572
|
-
```typescript
|
|
573
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
574
|
-
|
|
575
|
-
const steamSets = new SteamSets({
|
|
576
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
577
|
-
});
|
|
578
|
-
|
|
579
|
-
async function run() {
|
|
580
|
-
const result = await steamSets.internal.getAccount({});
|
|
581
|
-
|
|
582
|
-
// Handle the result
|
|
583
|
-
console.log(result);
|
|
584
|
-
}
|
|
585
|
-
|
|
586
|
-
run();
|
|
587
|
-
```
|
|
588
|
-
|
|
589
|
-
### Standalone function
|
|
590
|
-
|
|
591
|
-
The standalone function version of this method:
|
|
592
|
-
|
|
593
|
-
```typescript
|
|
594
|
-
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
595
|
-
import { internalGetAccount } from "@steamsets/client-ts/funcs/internalGetAccount.js";
|
|
596
|
-
|
|
597
|
-
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
598
|
-
// You can create one instance of it to use across an application.
|
|
599
|
-
const steamSets = new SteamSetsCore({
|
|
600
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
601
|
-
});
|
|
602
|
-
|
|
603
|
-
async function run() {
|
|
604
|
-
const res = await internalGetAccount(steamSets, {});
|
|
605
|
-
|
|
606
|
-
if (!res.ok) {
|
|
607
|
-
throw res.error;
|
|
608
|
-
}
|
|
609
|
-
|
|
610
|
-
const { value: result } = res;
|
|
611
|
-
|
|
612
|
-
// Handle the result
|
|
613
|
-
console.log(result);
|
|
614
|
-
}
|
|
615
|
-
|
|
616
|
-
run();
|
|
617
|
-
```
|
|
618
|
-
|
|
619
|
-
### Parameters
|
|
620
|
-
|
|
621
|
-
| Parameter | Type | Required | Description |
|
|
622
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
623
|
-
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
624
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
625
|
-
| `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. |
|
|
626
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
627
|
-
|
|
628
|
-
### Response
|
|
629
|
-
|
|
630
|
-
**Promise\<[operations.AdminV1GetAccountResponse](../../models/operations/adminv1getaccountresponse.md)\>**
|
|
631
|
-
|
|
632
|
-
### Errors
|
|
633
|
-
|
|
634
|
-
| Error Type | Status Code | Content Type |
|
|
635
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
636
|
-
| errors.ErrorModel | 403, 404, 422, 429 | application/problem+json |
|
|
637
|
-
| errors.ErrorModel | 500 | application/problem+json |
|
|
638
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
639
|
-
|
|
640
|
-
## getTags
|
|
641
|
-
|
|
642
|
-
### Example Usage
|
|
643
|
-
|
|
644
|
-
```typescript
|
|
645
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
646
|
-
|
|
647
|
-
const steamSets = new SteamSets({
|
|
648
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
649
|
-
});
|
|
650
|
-
|
|
651
|
-
async function run() {
|
|
652
|
-
const result = await steamSets.internal.getTags();
|
|
653
|
-
|
|
654
|
-
// Handle the result
|
|
655
|
-
console.log(result);
|
|
656
|
-
}
|
|
657
|
-
|
|
658
|
-
run();
|
|
659
|
-
```
|
|
660
|
-
|
|
661
|
-
### Standalone function
|
|
662
|
-
|
|
663
|
-
The standalone function version of this method:
|
|
664
|
-
|
|
665
|
-
```typescript
|
|
666
|
-
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
667
|
-
import { internalGetTags } from "@steamsets/client-ts/funcs/internalGetTags.js";
|
|
668
|
-
|
|
669
|
-
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
670
|
-
// You can create one instance of it to use across an application.
|
|
671
|
-
const steamSets = new SteamSetsCore({
|
|
672
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
673
|
-
});
|
|
674
|
-
|
|
675
|
-
async function run() {
|
|
676
|
-
const res = await internalGetTags(steamSets);
|
|
677
|
-
|
|
678
|
-
if (!res.ok) {
|
|
679
|
-
throw res.error;
|
|
680
|
-
}
|
|
681
|
-
|
|
682
|
-
const { value: result } = res;
|
|
683
|
-
|
|
684
|
-
// Handle the result
|
|
685
|
-
console.log(result);
|
|
686
|
-
}
|
|
687
|
-
|
|
688
|
-
run();
|
|
689
|
-
```
|
|
690
|
-
|
|
691
|
-
### Parameters
|
|
692
|
-
|
|
693
|
-
| Parameter | Type | Required | Description |
|
|
694
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
695
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
696
|
-
| `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. |
|
|
697
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
698
|
-
|
|
699
|
-
### Response
|
|
700
|
-
|
|
701
|
-
**Promise\<[operations.BadgeV1TagsResponse](../../models/operations/badgev1tagsresponse.md)\>**
|
|
702
|
-
|
|
703
|
-
### Errors
|
|
704
|
-
|
|
705
|
-
| Error Type | Status Code | Content Type |
|
|
706
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
707
|
-
| errors.ErrorModel | 403, 404 | application/problem+json |
|
|
708
|
-
| errors.ErrorModel | 500 | application/problem+json |
|
|
709
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
710
|
-
|
|
711
|
-
## badgeV1TagsSuggest
|
|
712
|
-
|
|
713
|
-
### Example Usage
|
|
714
|
-
|
|
715
|
-
```typescript
|
|
716
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
717
|
-
|
|
718
|
-
const steamSets = new SteamSets({
|
|
719
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
720
|
-
});
|
|
721
|
-
|
|
722
|
-
async function run() {
|
|
723
|
-
const result = await steamSets.internal.badgeV1TagsSuggest({
|
|
724
|
-
badgeId: "<id>",
|
|
725
|
-
});
|
|
726
|
-
|
|
727
|
-
// Handle the result
|
|
728
|
-
console.log(result);
|
|
729
|
-
}
|
|
730
|
-
|
|
731
|
-
run();
|
|
732
|
-
```
|
|
733
|
-
|
|
734
|
-
### Standalone function
|
|
735
|
-
|
|
736
|
-
The standalone function version of this method:
|
|
737
|
-
|
|
738
|
-
```typescript
|
|
739
|
-
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
740
|
-
import { internalBadgeV1TagsSuggest } from "@steamsets/client-ts/funcs/internalBadgeV1TagsSuggest.js";
|
|
741
|
-
|
|
742
|
-
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
743
|
-
// You can create one instance of it to use across an application.
|
|
744
|
-
const steamSets = new SteamSetsCore({
|
|
745
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
746
|
-
});
|
|
747
|
-
|
|
748
|
-
async function run() {
|
|
749
|
-
const res = await internalBadgeV1TagsSuggest(steamSets, {
|
|
750
|
-
badgeId: "<id>",
|
|
751
|
-
});
|
|
752
|
-
|
|
753
|
-
if (!res.ok) {
|
|
754
|
-
throw res.error;
|
|
755
|
-
}
|
|
756
|
-
|
|
757
|
-
const { value: result } = res;
|
|
758
|
-
|
|
759
|
-
// Handle the result
|
|
760
|
-
console.log(result);
|
|
761
|
-
}
|
|
762
|
-
|
|
763
|
-
run();
|
|
764
|
-
```
|
|
765
|
-
|
|
766
|
-
### Parameters
|
|
767
|
-
|
|
768
|
-
| Parameter | Type | Required | Description |
|
|
769
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
770
|
-
| `request` | [components.V1BadgeTagsSuggestRequestBody](../../models/components/v1badgetagssuggestrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
771
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
772
|
-
| `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. |
|
|
773
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
774
|
-
|
|
775
|
-
### Response
|
|
776
|
-
|
|
777
|
-
**Promise\<[operations.BadgeV1TagsSuggestResponse](../../models/operations/badgev1tagssuggestresponse.md)\>**
|
|
778
|
-
|
|
779
|
-
### Errors
|
|
780
|
-
|
|
781
|
-
| Error Type | Status Code | Content Type |
|
|
782
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
783
|
-
| errors.ErrorModel | 403, 404, 422 | application/problem+json |
|
|
784
|
-
| errors.ErrorModel | 500 | application/problem+json |
|
|
785
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
786
|
-
|
|
787
|
-
## leaderboardV1GetAccountMeta
|
|
788
|
-
|
|
789
|
-
### Example Usage
|
|
790
|
-
|
|
791
|
-
```typescript
|
|
792
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
793
|
-
|
|
794
|
-
const steamSets = new SteamSets({
|
|
795
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
796
|
-
});
|
|
797
|
-
|
|
798
|
-
async function run() {
|
|
799
|
-
const result = await steamSets.internal.leaderboardV1GetAccountMeta({
|
|
800
|
-
app: {
|
|
801
|
-
appId: 730,
|
|
802
|
-
},
|
|
803
|
-
badge: {
|
|
804
|
-
id: 335243,
|
|
805
|
-
isFoil: true,
|
|
806
|
-
},
|
|
807
|
-
leaderboard: "xp",
|
|
808
|
-
location: [
|
|
809
|
-
{
|
|
810
|
-
city: "Bad Krozingen",
|
|
811
|
-
country: "Germany",
|
|
812
|
-
region: "Europe",
|
|
813
|
-
state: "Baden-Wurttemberg",
|
|
814
|
-
},
|
|
815
|
-
],
|
|
816
|
-
});
|
|
817
|
-
|
|
818
|
-
// Handle the result
|
|
819
|
-
console.log(result);
|
|
820
|
-
}
|
|
821
|
-
|
|
822
|
-
run();
|
|
823
|
-
```
|
|
824
|
-
|
|
825
|
-
### Standalone function
|
|
826
|
-
|
|
827
|
-
The standalone function version of this method:
|
|
828
|
-
|
|
829
|
-
```typescript
|
|
830
|
-
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
831
|
-
import { internalLeaderboardV1GetAccountMeta } from "@steamsets/client-ts/funcs/internalLeaderboardV1GetAccountMeta.js";
|
|
832
|
-
|
|
833
|
-
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
834
|
-
// You can create one instance of it to use across an application.
|
|
835
|
-
const steamSets = new SteamSetsCore({
|
|
836
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
837
|
-
});
|
|
838
|
-
|
|
839
|
-
async function run() {
|
|
840
|
-
const res = await internalLeaderboardV1GetAccountMeta(steamSets, {
|
|
841
|
-
app: {
|
|
842
|
-
appId: 730,
|
|
843
|
-
},
|
|
844
|
-
badge: {
|
|
845
|
-
id: 335243,
|
|
846
|
-
isFoil: true,
|
|
847
|
-
},
|
|
848
|
-
leaderboard: "xp",
|
|
849
|
-
location: [
|
|
850
|
-
{
|
|
851
|
-
city: "Bad Krozingen",
|
|
852
|
-
country: "Germany",
|
|
853
|
-
region: "Europe",
|
|
854
|
-
state: "Baden-Wurttemberg",
|
|
855
|
-
},
|
|
856
|
-
],
|
|
857
|
-
});
|
|
858
|
-
|
|
859
|
-
if (!res.ok) {
|
|
860
|
-
throw res.error;
|
|
861
|
-
}
|
|
862
|
-
|
|
863
|
-
const { value: result } = res;
|
|
864
|
-
|
|
865
|
-
// Handle the result
|
|
866
|
-
console.log(result);
|
|
867
|
-
}
|
|
868
|
-
|
|
869
|
-
run();
|
|
870
|
-
```
|
|
871
|
-
|
|
872
|
-
### Parameters
|
|
873
|
-
|
|
874
|
-
| Parameter | Type | Required | Description |
|
|
875
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
876
|
-
| `request` | [components.V1LeaderboardAccountMetaRequestBody](../../models/components/v1leaderboardaccountmetarequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
877
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
878
|
-
| `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. |
|
|
879
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
880
|
-
|
|
881
|
-
### Response
|
|
882
|
-
|
|
883
|
-
**Promise\<[operations.LeaderboardV1GetAccountMetaResponse](../../models/operations/leaderboardv1getaccountmetaresponse.md)\>**
|
|
884
|
-
|
|
885
|
-
### Errors
|
|
886
|
-
|
|
887
|
-
| Error Type | Status Code | Content Type |
|
|
888
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
889
|
-
| errors.ErrorModel | 404, 422 | application/problem+json |
|
|
890
|
-
| errors.ErrorModel | 500 | application/problem+json |
|
|
891
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
892
|
-
|
|
893
|
-
## check
|
|
894
|
-
|
|
895
|
-
This endpoint checks if the service is alive.
|
|
896
|
-
|
|
897
|
-
### Example Usage
|
|
898
|
-
|
|
899
|
-
```typescript
|
|
900
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
901
|
-
|
|
902
|
-
const steamSets = new SteamSets({
|
|
903
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
904
|
-
});
|
|
905
|
-
|
|
906
|
-
async function run() {
|
|
907
|
-
const result = await steamSets.internal.check();
|
|
908
|
-
|
|
909
|
-
// Handle the result
|
|
910
|
-
console.log(result);
|
|
911
|
-
}
|
|
912
|
-
|
|
913
|
-
run();
|
|
914
|
-
```
|
|
915
|
-
|
|
916
|
-
### Standalone function
|
|
917
|
-
|
|
918
|
-
The standalone function version of this method:
|
|
919
|
-
|
|
920
|
-
```typescript
|
|
921
|
-
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
922
|
-
import { internalCheck } from "@steamsets/client-ts/funcs/internalCheck.js";
|
|
923
|
-
|
|
924
|
-
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
925
|
-
// You can create one instance of it to use across an application.
|
|
926
|
-
const steamSets = new SteamSetsCore({
|
|
927
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
928
|
-
});
|
|
929
|
-
|
|
930
|
-
async function run() {
|
|
931
|
-
const res = await internalCheck(steamSets);
|
|
932
|
-
|
|
933
|
-
if (!res.ok) {
|
|
934
|
-
throw res.error;
|
|
935
|
-
}
|
|
936
|
-
|
|
937
|
-
const { value: result } = res;
|
|
938
|
-
|
|
939
|
-
// Handle the result
|
|
940
|
-
console.log(result);
|
|
941
|
-
}
|
|
942
|
-
|
|
943
|
-
run();
|
|
944
|
-
```
|
|
945
|
-
|
|
946
|
-
### Parameters
|
|
947
|
-
|
|
948
|
-
| Parameter | Type | Required | Description |
|
|
949
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
950
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
951
|
-
| `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. |
|
|
952
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
953
|
-
|
|
954
|
-
### Response
|
|
955
|
-
|
|
956
|
-
**Promise\<[operations.LivenessResponse](../../models/operations/livenessresponse.md)\>**
|
|
957
|
-
|
|
958
|
-
### Errors
|
|
959
|
-
|
|
960
|
-
| Error Type | Status Code | Content Type |
|
|
961
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
962
|
-
| errors.ErrorModel | 500 | application/problem+json |
|
|
963
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|