@steamsets/client-ts 0.14.26 → 0.14.28
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 +83 -17
- package/docs/sdks/account/README.md +497 -13
- package/docs/sdks/admin/README.md +1 -1
- package/docs/sdks/badge/README.md +2 -0
- package/docs/sdks/data/README.md +5 -85
- package/docs/sdks/developer/README.md +1 -1
- package/docs/sdks/event/README.md +168 -0
- package/docs/sdks/{public → external}/README.md +93 -29
- package/docs/sdks/internal/README.md +1726 -0
- package/docs/sdks/leaderboard/README.md +2 -0
- package/docs/sdks/liveness/README.md +1 -1
- package/docs/sdks/stats/README.md +1 -1
- package/funcs/accountAdminV1UpdateResources.d.ts +11 -0
- package/funcs/accountAdminV1UpdateResources.d.ts.map +1 -0
- package/funcs/accountAdminV1UpdateResources.js +111 -0
- package/funcs/accountAdminV1UpdateResources.js.map +1 -0
- package/funcs/accountAdminV1UpdateRoles.d.ts +11 -0
- package/funcs/accountAdminV1UpdateRoles.d.ts.map +1 -0
- package/funcs/accountAdminV1UpdateRoles.js +111 -0
- package/funcs/accountAdminV1UpdateRoles.js.map +1 -0
- package/funcs/accountCreateDeveloperApp.d.ts +11 -0
- package/funcs/accountCreateDeveloperApp.d.ts.map +1 -0
- package/funcs/accountCreateDeveloperApp.js +111 -0
- package/funcs/accountCreateDeveloperApp.js.map +1 -0
- package/funcs/accountDeleteDeveloperApp.d.ts +11 -0
- package/funcs/accountDeleteDeveloperApp.d.ts.map +1 -0
- package/funcs/accountDeleteDeveloperApp.js +111 -0
- package/funcs/accountDeleteDeveloperApp.js.map +1 -0
- package/funcs/{publicGetBadges.d.ts → accountGetAccount.d.ts} +2 -2
- package/funcs/accountGetAccount.d.ts.map +1 -0
- package/funcs/accountGetAccount.js +113 -0
- package/funcs/accountGetAccount.js.map +1 -0
- package/funcs/accountUpdateApp.d.ts +11 -0
- package/funcs/{publicGetFriends.d.ts.map → accountUpdateApp.d.ts.map} +1 -1
- package/funcs/accountUpdateApp.js +111 -0
- package/funcs/{publicGetFriends.js.map → accountUpdateApp.js.map} +1 -1
- package/funcs/eventAdminV1GetEvents.d.ts +10 -0
- package/funcs/eventAdminV1GetEvents.d.ts.map +1 -0
- package/funcs/eventAdminV1GetEvents.js +102 -0
- package/funcs/eventAdminV1GetEvents.js.map +1 -0
- package/funcs/{publicGetLeaderboardHistory.d.ts → eventAdminV1UpdateEvent.d.ts} +2 -2
- package/funcs/eventAdminV1UpdateEvent.d.ts.map +1 -0
- package/funcs/eventAdminV1UpdateEvent.js +113 -0
- package/funcs/eventAdminV1UpdateEvent.js.map +1 -0
- package/funcs/externalGetApps.d.ts +11 -0
- package/funcs/{publicGetBadges.d.ts.map → externalGetApps.d.ts.map} +1 -1
- package/funcs/{publicGetApps.js → externalGetApps.js} +3 -3
- package/funcs/{publicGetBadges.js.map → externalGetApps.js.map} +1 -1
- package/funcs/{publicGetApps.d.ts → externalGetBadges.d.ts} +2 -2
- package/funcs/externalGetBadges.d.ts.map +1 -0
- package/funcs/{publicGetBadges.js → externalGetBadges.js} +3 -3
- package/funcs/externalGetBadges.js.map +1 -0
- package/funcs/{publicGetDataPoints.d.ts → externalGetDataPoints.d.ts} +2 -2
- package/funcs/externalGetDataPoints.d.ts.map +1 -0
- package/funcs/{publicGetDataPoints.js → externalGetDataPoints.js} +3 -3
- package/funcs/externalGetDataPoints.js.map +1 -0
- package/funcs/externalGetFriends.d.ts +11 -0
- package/funcs/externalGetFriends.d.ts.map +1 -0
- package/funcs/{publicGetFriends.js → externalGetFriends.js} +3 -3
- package/funcs/externalGetFriends.js.map +1 -0
- package/funcs/{publicGetInfo.d.ts → externalGetInfo.d.ts} +2 -2
- package/funcs/externalGetInfo.d.ts.map +1 -0
- package/funcs/{publicGetInfo.js → externalGetInfo.js} +3 -3
- package/funcs/externalGetInfo.js.map +1 -0
- package/funcs/externalGetLeaderboardHistory.d.ts +11 -0
- package/funcs/externalGetLeaderboardHistory.d.ts.map +1 -0
- package/funcs/{publicGetLeaderboardHistory.js → externalGetLeaderboardHistory.js} +3 -3
- package/funcs/externalGetLeaderboardHistory.js.map +1 -0
- package/funcs/externalStatsV1StatsGet.d.ts +10 -0
- package/funcs/externalStatsV1StatsGet.d.ts.map +1 -0
- package/funcs/externalStatsV1StatsGet.js +102 -0
- package/funcs/externalStatsV1StatsGet.js.map +1 -0
- package/funcs/internalAccountV1BookmarkBadge.d.ts +11 -0
- package/funcs/internalAccountV1BookmarkBadge.d.ts.map +1 -0
- package/funcs/internalAccountV1BookmarkBadge.js +113 -0
- package/funcs/internalAccountV1BookmarkBadge.js.map +1 -0
- package/funcs/internalAccountV1ConnectionReconnect.d.ts +11 -0
- package/funcs/internalAccountV1ConnectionReconnect.d.ts.map +1 -0
- package/funcs/internalAccountV1ConnectionReconnect.js +113 -0
- package/funcs/internalAccountV1ConnectionReconnect.js.map +1 -0
- package/funcs/internalAccountV1GetBadgeBookmarks.d.ts +10 -0
- package/funcs/internalAccountV1GetBadgeBookmarks.d.ts.map +1 -0
- package/funcs/internalAccountV1GetBadgeBookmarks.js +102 -0
- package/funcs/internalAccountV1GetBadgeBookmarks.js.map +1 -0
- package/funcs/internalAccountV1GetOwnedBadges.d.ts +10 -0
- package/funcs/internalAccountV1GetOwnedBadges.d.ts.map +1 -0
- package/funcs/internalAccountV1GetOwnedBadges.js +102 -0
- package/funcs/internalAccountV1GetOwnedBadges.js.map +1 -0
- package/funcs/internalAccountV1ImagesGet.d.ts +10 -0
- package/funcs/internalAccountV1ImagesGet.d.ts.map +1 -0
- package/funcs/internalAccountV1ImagesGet.js +100 -0
- package/funcs/internalAccountV1ImagesGet.js.map +1 -0
- package/funcs/internalAccountV1ImagesUpdate.d.ts +11 -0
- package/funcs/internalAccountV1ImagesUpdate.d.ts.map +1 -0
- package/funcs/internalAccountV1ImagesUpdate.js +113 -0
- package/funcs/internalAccountV1ImagesUpdate.js.map +1 -0
- package/funcs/internalAdminV1GetEvents.d.ts +10 -0
- package/funcs/internalAdminV1GetEvents.d.ts.map +1 -0
- package/funcs/internalAdminV1GetEvents.js +102 -0
- package/funcs/internalAdminV1GetEvents.js.map +1 -0
- package/funcs/internalAdminV1UpdateEvent.d.ts +11 -0
- package/funcs/internalAdminV1UpdateEvent.d.ts.map +1 -0
- package/funcs/internalAdminV1UpdateEvent.js +113 -0
- package/funcs/internalAdminV1UpdateEvent.js.map +1 -0
- package/funcs/internalAdminV1UpdateResources.d.ts +11 -0
- package/funcs/internalAdminV1UpdateResources.d.ts.map +1 -0
- package/funcs/internalAdminV1UpdateResources.js +111 -0
- package/funcs/internalAdminV1UpdateResources.js.map +1 -0
- package/funcs/internalAdminV1UpdateRoles.d.ts +11 -0
- package/funcs/internalAdminV1UpdateRoles.d.ts.map +1 -0
- package/funcs/internalAdminV1UpdateRoles.js +111 -0
- package/funcs/internalAdminV1UpdateRoles.js.map +1 -0
- package/funcs/internalBadgeV1Search.d.ts +11 -0
- package/funcs/internalBadgeV1Search.d.ts.map +1 -0
- package/funcs/internalBadgeV1Search.js +113 -0
- package/funcs/internalBadgeV1Search.js.map +1 -0
- package/funcs/internalCheck.d.ts +16 -0
- package/funcs/internalCheck.d.ts.map +1 -0
- package/funcs/internalCheck.js +106 -0
- package/funcs/internalCheck.js.map +1 -0
- package/funcs/internalCreateDeveloperApp.d.ts +11 -0
- package/funcs/internalCreateDeveloperApp.d.ts.map +1 -0
- package/funcs/internalCreateDeveloperApp.js +111 -0
- package/funcs/internalCreateDeveloperApp.js.map +1 -0
- package/funcs/internalDeleteDeveloperApp.d.ts +11 -0
- package/funcs/internalDeleteDeveloperApp.d.ts.map +1 -0
- package/funcs/internalDeleteDeveloperApp.js +111 -0
- package/funcs/internalDeleteDeveloperApp.js.map +1 -0
- package/funcs/internalDeleteImages.d.ts +11 -0
- package/funcs/internalDeleteImages.d.ts.map +1 -0
- package/funcs/internalDeleteImages.js +113 -0
- package/funcs/internalDeleteImages.js.map +1 -0
- package/funcs/{publicGetFriends.d.ts → internalGetAccount.d.ts} +2 -2
- package/funcs/internalGetAccount.d.ts.map +1 -0
- package/funcs/internalGetAccount.js +113 -0
- package/funcs/internalGetAccount.js.map +1 -0
- package/funcs/internalGetStaff.d.ts +10 -0
- package/funcs/internalGetStaff.d.ts.map +1 -0
- package/funcs/{dataGetStaff.js → internalGetStaff.js} +3 -3
- package/funcs/internalGetStaff.js.map +1 -0
- package/funcs/{dataGetStaff.d.ts → internalGetTags.d.ts} +2 -2
- package/funcs/internalGetTags.d.ts.map +1 -0
- package/funcs/internalGetTags.js +102 -0
- package/funcs/internalGetTags.js.map +1 -0
- package/funcs/internalSendEmailVerification.d.ts +10 -0
- package/funcs/internalSendEmailVerification.d.ts.map +1 -0
- package/funcs/internalSendEmailVerification.js +111 -0
- package/funcs/internalSendEmailVerification.js.map +1 -0
- package/funcs/internalUpdateApp.d.ts +11 -0
- package/funcs/internalUpdateApp.d.ts.map +1 -0
- package/funcs/internalUpdateApp.js +111 -0
- package/funcs/internalUpdateApp.js.map +1 -0
- package/funcs/internalUploadImages.d.ts +11 -0
- package/funcs/internalUploadImages.d.ts.map +1 -0
- package/funcs/internalUploadImages.js +113 -0
- package/funcs/internalUploadImages.js.map +1 -0
- package/funcs/internalVerifyEmail.d.ts +11 -0
- package/funcs/{publicGetDataPoints.d.ts.map → internalVerifyEmail.d.ts.map} +1 -1
- package/funcs/internalVerifyEmail.js +113 -0
- package/funcs/{publicGetDataPoints.js.map → internalVerifyEmail.js.map} +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/retries.js +0 -1
- package/lib/retries.js.map +1 -1
- package/models/components/leaderboardaccount.d.ts +0 -5
- package/models/components/leaderboardaccount.d.ts.map +1 -1
- package/models/components/leaderboardaccount.js +0 -2
- package/models/components/leaderboardaccount.js.map +1 -1
- package/models/components/v1accountfriend.d.ts +0 -5
- package/models/components/v1accountfriend.d.ts.map +1 -1
- package/models/components/v1accountfriend.js +0 -2
- package/models/components/v1accountfriend.js.map +1 -1
- package/models/components/v1accountinforesponsebody.d.ts +0 -5
- package/models/components/v1accountinforesponsebody.d.ts.map +1 -1
- package/models/components/v1accountinforesponsebody.js +0 -2
- package/models/components/v1accountinforesponsebody.js.map +1 -1
- package/models/components/v1accountleaderboardaccount.d.ts +0 -5
- package/models/components/v1accountleaderboardaccount.d.ts.map +1 -1
- package/models/components/v1accountleaderboardaccount.js +0 -2
- package/models/components/v1accountleaderboardaccount.js.map +1 -1
- package/models/components/v1stats.d.ts +0 -5
- package/models/components/v1stats.d.ts.map +1 -1
- package/models/components/v1stats.js +0 -2
- package/models/components/v1stats.js.map +1 -1
- package/package.json +6 -7
- package/sdk/account.d.ts +6 -0
- package/sdk/account.d.ts.map +1 -1
- package/sdk/account.js +24 -0
- package/sdk/account.js.map +1 -1
- package/sdk/data.d.ts +0 -1
- package/sdk/data.d.ts.map +1 -1
- package/sdk/data.js +0 -4
- package/sdk/data.js.map +1 -1
- package/sdk/event.d.ts +8 -0
- package/sdk/event.d.ts.map +1 -0
- package/sdk/event.js +20 -0
- package/sdk/event.js.map +1 -0
- package/sdk/{public.d.ts → external.d.ts} +3 -2
- package/sdk/external.d.ts.map +1 -0
- package/sdk/external.js +40 -0
- package/sdk/external.js.map +1 -0
- package/sdk/internal.d.ts +34 -0
- package/sdk/internal.d.ts.map +1 -0
- package/sdk/internal.js +106 -0
- package/sdk/internal.js.map +1 -0
- package/sdk/sdk.d.ts +11 -5
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +14 -6
- package/sdk/sdk.js.map +1 -1
- package/src/funcs/accountAdminV1UpdateResources.ts +148 -0
- package/src/funcs/accountAdminV1UpdateRoles.ts +148 -0
- package/src/funcs/accountCreateDeveloperApp.ts +152 -0
- package/src/funcs/accountDeleteDeveloperApp.ts +154 -0
- package/src/funcs/accountGetAccount.ts +149 -0
- package/src/funcs/accountUpdateApp.ts +154 -0
- package/src/funcs/eventAdminV1GetEvents.ts +132 -0
- package/src/funcs/eventAdminV1UpdateEvent.ts +150 -0
- package/src/funcs/{publicGetApps.ts → externalGetApps.ts} +1 -1
- package/src/funcs/{publicGetBadges.ts → externalGetBadges.ts} +1 -1
- package/src/funcs/{publicGetDataPoints.ts → externalGetDataPoints.ts} +1 -1
- package/src/funcs/{publicGetFriends.ts → externalGetFriends.ts} +1 -1
- package/src/funcs/{publicGetInfo.ts → externalGetInfo.ts} +1 -1
- package/src/funcs/{publicGetLeaderboardHistory.ts → externalGetLeaderboardHistory.ts} +1 -1
- package/src/funcs/externalStatsV1StatsGet.ts +132 -0
- package/src/funcs/internalAccountV1BookmarkBadge.ts +150 -0
- package/src/funcs/internalAccountV1ConnectionReconnect.ts +149 -0
- package/src/funcs/internalAccountV1GetBadgeBookmarks.ts +132 -0
- package/src/funcs/internalAccountV1GetOwnedBadges.ts +132 -0
- package/src/funcs/internalAccountV1ImagesGet.ts +127 -0
- package/src/funcs/internalAccountV1ImagesUpdate.ts +149 -0
- package/src/funcs/internalAdminV1GetEvents.ts +132 -0
- package/src/funcs/internalAdminV1UpdateEvent.ts +150 -0
- package/src/funcs/internalAdminV1UpdateResources.ts +148 -0
- package/src/funcs/internalAdminV1UpdateRoles.ts +148 -0
- package/src/funcs/internalBadgeV1Search.ts +149 -0
- package/src/funcs/internalCheck.ts +133 -0
- package/src/funcs/internalCreateDeveloperApp.ts +152 -0
- package/src/funcs/internalDeleteDeveloperApp.ts +154 -0
- package/src/funcs/internalDeleteImages.ts +149 -0
- package/src/funcs/internalGetAccount.ts +149 -0
- package/src/funcs/{dataGetStaff.ts → internalGetStaff.ts} +1 -1
- package/src/funcs/internalGetTags.ts +132 -0
- package/src/funcs/internalSendEmailVerification.ts +156 -0
- package/src/funcs/internalUpdateApp.ts +154 -0
- package/src/funcs/internalUploadImages.ts +149 -0
- package/src/funcs/internalVerifyEmail.ts +149 -0
- package/src/lib/config.ts +3 -3
- package/src/lib/retries.ts +0 -1
- package/src/models/components/leaderboardaccount.ts +0 -7
- package/src/models/components/v1accountfriend.ts +0 -7
- package/src/models/components/v1accountinforesponsebody.ts +0 -7
- package/src/models/components/v1accountleaderboardaccount.ts +0 -7
- package/src/models/components/v1stats.ts +0 -7
- package/src/sdk/account.ts +72 -0
- package/src/sdk/data.ts +0 -10
- package/src/sdk/event.ts +32 -0
- package/src/sdk/{public.ts → external.ts} +23 -13
- package/src/sdk/internal.ts +266 -0
- package/src/sdk/sdk.ts +21 -9
- package/funcs/dataGetStaff.d.ts.map +0 -1
- package/funcs/dataGetStaff.js.map +0 -1
- package/funcs/publicGetApps.d.ts.map +0 -1
- package/funcs/publicGetApps.js.map +0 -1
- package/funcs/publicGetInfo.d.ts.map +0 -1
- package/funcs/publicGetInfo.js.map +0 -1
- package/funcs/publicGetLeaderboardHistory.d.ts.map +0 -1
- package/funcs/publicGetLeaderboardHistory.js.map +0 -1
- package/sdk/public.d.ts.map +0 -1
- package/sdk/public.js +0 -36
- package/sdk/public.js.map +0 -1
|
@@ -3,11 +3,14 @@
|
|
|
3
3
|
|
|
4
4
|
## Overview
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
All Requests related to account(s) are grouped here.
|
|
7
7
|
|
|
8
8
|
### Available Operations
|
|
9
9
|
|
|
10
|
+
* [createDeveloperApp](#createdeveloperapp)
|
|
11
|
+
* [deleteDeveloperApp](#deletedeveloperapp)
|
|
10
12
|
* [deleteImages](#deleteimages)
|
|
13
|
+
* [updateApp](#updateapp)
|
|
11
14
|
* [getApps](#getapps)
|
|
12
15
|
* [accountV1GetBadgeBookmarks](#accountv1getbadgebookmarks)
|
|
13
16
|
* [getBadges](#getbadges)
|
|
@@ -23,6 +26,167 @@ Account related operations
|
|
|
23
26
|
* [accountV1ImagesUpdate](#accountv1imagesupdate)
|
|
24
27
|
* [uploadImages](#uploadimages)
|
|
25
28
|
* [verifyEmail](#verifyemail)
|
|
29
|
+
* [getAccount](#getaccount)
|
|
30
|
+
* [adminV1UpdateResources](#adminv1updateresources)
|
|
31
|
+
* [adminV1UpdateRoles](#adminv1updateroles)
|
|
32
|
+
|
|
33
|
+
## createDeveloperApp
|
|
34
|
+
|
|
35
|
+
### Example Usage
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
39
|
+
|
|
40
|
+
const steamSets = new SteamSets({
|
|
41
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
async function run() {
|
|
45
|
+
const result = await steamSets.account.createDeveloperApp({
|
|
46
|
+
description: "Your App Description",
|
|
47
|
+
environment: "production",
|
|
48
|
+
generateKey: true,
|
|
49
|
+
name: "Your App",
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
// Handle the result
|
|
53
|
+
console.log(result);
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
run();
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Standalone function
|
|
60
|
+
|
|
61
|
+
The standalone function version of this method:
|
|
62
|
+
|
|
63
|
+
```typescript
|
|
64
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
65
|
+
import { accountCreateDeveloperApp } from "@steamsets/client-ts/funcs/accountCreateDeveloperApp.js";
|
|
66
|
+
|
|
67
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
68
|
+
// You can create one instance of it to use across an application.
|
|
69
|
+
const steamSets = new SteamSetsCore({
|
|
70
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
71
|
+
});
|
|
72
|
+
|
|
73
|
+
async function run() {
|
|
74
|
+
const res = await accountCreateDeveloperApp(steamSets, {
|
|
75
|
+
description: "Your App Description",
|
|
76
|
+
environment: "production",
|
|
77
|
+
generateKey: true,
|
|
78
|
+
name: "Your App",
|
|
79
|
+
});
|
|
80
|
+
|
|
81
|
+
if (!res.ok) {
|
|
82
|
+
throw res.error;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
const { value: result } = res;
|
|
86
|
+
|
|
87
|
+
// Handle the result
|
|
88
|
+
console.log(result);
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
run();
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Parameters
|
|
95
|
+
|
|
96
|
+
| Parameter | Type | Required | Description |
|
|
97
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
98
|
+
| `request` | [components.V1DeveloperAppCreateRequestBody](../../models/components/v1developerappcreaterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
99
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
100
|
+
| `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. |
|
|
101
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
102
|
+
|
|
103
|
+
### Response
|
|
104
|
+
|
|
105
|
+
**Promise\<[operations.AccountV1SettingsDeveloperAppCreateResponse](../../models/operations/accountv1settingsdeveloperappcreateresponse.md)\>**
|
|
106
|
+
|
|
107
|
+
### Errors
|
|
108
|
+
|
|
109
|
+
| Error Type | Status Code | Content Type |
|
|
110
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
111
|
+
| errors.ErrorModel | 400, 404, 422 | application/problem+json |
|
|
112
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
113
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
114
|
+
|
|
115
|
+
## deleteDeveloperApp
|
|
116
|
+
|
|
117
|
+
### Example Usage
|
|
118
|
+
|
|
119
|
+
```typescript
|
|
120
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
121
|
+
|
|
122
|
+
const steamSets = new SteamSets({
|
|
123
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
124
|
+
});
|
|
125
|
+
|
|
126
|
+
async function run() {
|
|
127
|
+
const result = await steamSets.account.deleteDeveloperApp({
|
|
128
|
+
developerAppId: "da_123456",
|
|
129
|
+
});
|
|
130
|
+
|
|
131
|
+
// Handle the result
|
|
132
|
+
console.log(result);
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
run();
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### Standalone function
|
|
139
|
+
|
|
140
|
+
The standalone function version of this method:
|
|
141
|
+
|
|
142
|
+
```typescript
|
|
143
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
144
|
+
import { accountDeleteDeveloperApp } from "@steamsets/client-ts/funcs/accountDeleteDeveloperApp.js";
|
|
145
|
+
|
|
146
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
147
|
+
// You can create one instance of it to use across an application.
|
|
148
|
+
const steamSets = new SteamSetsCore({
|
|
149
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
150
|
+
});
|
|
151
|
+
|
|
152
|
+
async function run() {
|
|
153
|
+
const res = await accountDeleteDeveloperApp(steamSets, {
|
|
154
|
+
developerAppId: "da_123456",
|
|
155
|
+
});
|
|
156
|
+
|
|
157
|
+
if (!res.ok) {
|
|
158
|
+
throw res.error;
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
const { value: result } = res;
|
|
162
|
+
|
|
163
|
+
// Handle the result
|
|
164
|
+
console.log(result);
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
run();
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### Parameters
|
|
171
|
+
|
|
172
|
+
| Parameter | Type | Required | Description |
|
|
173
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
174
|
+
| `request` | [components.V1AccountDeveloperAppDeleteRequestBody](../../models/components/v1accountdeveloperappdeleterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
175
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
176
|
+
| `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. |
|
|
177
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
178
|
+
|
|
179
|
+
### Response
|
|
180
|
+
|
|
181
|
+
**Promise\<[operations.AccountV1SettingsDeveloperAppDeleteResponse](../../models/operations/accountv1settingsdeveloperappdeleteresponse.md)\>**
|
|
182
|
+
|
|
183
|
+
### Errors
|
|
184
|
+
|
|
185
|
+
| Error Type | Status Code | Content Type |
|
|
186
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
187
|
+
| errors.ErrorModel | 404, 422, 429 | application/problem+json |
|
|
188
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
189
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
26
190
|
|
|
27
191
|
## deleteImages
|
|
28
192
|
|
|
@@ -106,7 +270,7 @@ run();
|
|
|
106
270
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
107
271
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
108
272
|
|
|
109
|
-
##
|
|
273
|
+
## updateApp
|
|
110
274
|
|
|
111
275
|
### Example Usage
|
|
112
276
|
|
|
@@ -118,8 +282,11 @@ const steamSets = new SteamSets({
|
|
|
118
282
|
});
|
|
119
283
|
|
|
120
284
|
async function run() {
|
|
121
|
-
const result = await steamSets.account.
|
|
122
|
-
|
|
285
|
+
const result = await steamSets.account.updateApp({
|
|
286
|
+
description: "My App Description",
|
|
287
|
+
developerAppId: "da_123456",
|
|
288
|
+
name: "My App",
|
|
289
|
+
regenerate: true,
|
|
123
290
|
});
|
|
124
291
|
|
|
125
292
|
// Handle the result
|
|
@@ -135,7 +302,7 @@ The standalone function version of this method:
|
|
|
135
302
|
|
|
136
303
|
```typescript
|
|
137
304
|
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
138
|
-
import {
|
|
305
|
+
import { accountUpdateApp } from "@steamsets/client-ts/funcs/accountUpdateApp.js";
|
|
139
306
|
|
|
140
307
|
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
141
308
|
// You can create one instance of it to use across an application.
|
|
@@ -144,8 +311,11 @@ const steamSets = new SteamSetsCore({
|
|
|
144
311
|
});
|
|
145
312
|
|
|
146
313
|
async function run() {
|
|
147
|
-
const res = await
|
|
148
|
-
|
|
314
|
+
const res = await accountUpdateApp(steamSets, {
|
|
315
|
+
description: "My App Description",
|
|
316
|
+
developerAppId: "da_123456",
|
|
317
|
+
name: "My App",
|
|
318
|
+
regenerate: true,
|
|
149
319
|
});
|
|
150
320
|
|
|
151
321
|
if (!res.ok) {
|
|
@@ -163,6 +333,78 @@ run();
|
|
|
163
333
|
|
|
164
334
|
### Parameters
|
|
165
335
|
|
|
336
|
+
| Parameter | Type | Required | Description |
|
|
337
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
338
|
+
| `request` | [components.V1AccountDeveloperAppUpdateRequestBody](../../models/components/v1accountdeveloperappupdaterequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
339
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
340
|
+
| `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. |
|
|
341
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
342
|
+
|
|
343
|
+
### Response
|
|
344
|
+
|
|
345
|
+
**Promise\<[operations.AccountV1SettingsDeveloperAppUpdateResponse](../../models/operations/accountv1settingsdeveloperappupdateresponse.md)\>**
|
|
346
|
+
|
|
347
|
+
### Errors
|
|
348
|
+
|
|
349
|
+
| Error Type | Status Code | Content Type |
|
|
350
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
351
|
+
| errors.ErrorModel | 404, 422, 429 | application/problem+json |
|
|
352
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
353
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
354
|
+
|
|
355
|
+
## getApps
|
|
356
|
+
|
|
357
|
+
### Example Usage
|
|
358
|
+
|
|
359
|
+
```typescript
|
|
360
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
361
|
+
|
|
362
|
+
const steamSets = new SteamSets({
|
|
363
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
364
|
+
});
|
|
365
|
+
|
|
366
|
+
async function run() {
|
|
367
|
+
const result = await steamSets.account.getApps({});
|
|
368
|
+
|
|
369
|
+
// Handle the result
|
|
370
|
+
console.log(result);
|
|
371
|
+
}
|
|
372
|
+
|
|
373
|
+
run();
|
|
374
|
+
```
|
|
375
|
+
|
|
376
|
+
### Standalone function
|
|
377
|
+
|
|
378
|
+
The standalone function version of this method:
|
|
379
|
+
|
|
380
|
+
```typescript
|
|
381
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
382
|
+
import { accountGetApps } from "@steamsets/client-ts/funcs/accountGetApps.js";
|
|
383
|
+
|
|
384
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
385
|
+
// You can create one instance of it to use across an application.
|
|
386
|
+
const steamSets = new SteamSetsCore({
|
|
387
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
388
|
+
});
|
|
389
|
+
|
|
390
|
+
async function run() {
|
|
391
|
+
const res = await accountGetApps(steamSets, {});
|
|
392
|
+
|
|
393
|
+
if (!res.ok) {
|
|
394
|
+
throw res.error;
|
|
395
|
+
}
|
|
396
|
+
|
|
397
|
+
const { value: result } = res;
|
|
398
|
+
|
|
399
|
+
// Handle the result
|
|
400
|
+
console.log(result);
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
run();
|
|
404
|
+
```
|
|
405
|
+
|
|
406
|
+
### Parameters
|
|
407
|
+
|
|
166
408
|
| Parameter | Type | Required | Description |
|
|
167
409
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
168
410
|
| `request` | [components.V1AccountsAppsRequestBody](../../models/components/v1accountsappsrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
@@ -265,9 +507,7 @@ const steamSets = new SteamSets({
|
|
|
265
507
|
});
|
|
266
508
|
|
|
267
509
|
async function run() {
|
|
268
|
-
const result = await steamSets.account.getBadges({
|
|
269
|
-
page: 1,
|
|
270
|
-
});
|
|
510
|
+
const result = await steamSets.account.getBadges({});
|
|
271
511
|
|
|
272
512
|
// Handle the result
|
|
273
513
|
console.log(result);
|
|
@@ -291,9 +531,7 @@ const steamSets = new SteamSetsCore({
|
|
|
291
531
|
});
|
|
292
532
|
|
|
293
533
|
async function run() {
|
|
294
|
-
const res = await accountGetBadges(steamSets, {
|
|
295
|
-
page: 1,
|
|
296
|
-
});
|
|
534
|
+
const res = await accountGetBadges(steamSets, {});
|
|
297
535
|
|
|
298
536
|
if (!res.ok) {
|
|
299
537
|
throw res.error;
|
|
@@ -1213,4 +1451,250 @@ run();
|
|
|
1213
1451
|
| ------------------------ | ------------------------ | ------------------------ |
|
|
1214
1452
|
| errors.ErrorModel | 404, 422, 429 | application/problem+json |
|
|
1215
1453
|
| errors.ErrorModel | 500 | application/problem+json |
|
|
1454
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1455
|
+
|
|
1456
|
+
## getAccount
|
|
1457
|
+
|
|
1458
|
+
### Example Usage
|
|
1459
|
+
|
|
1460
|
+
```typescript
|
|
1461
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
1462
|
+
|
|
1463
|
+
const steamSets = new SteamSets({
|
|
1464
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1465
|
+
});
|
|
1466
|
+
|
|
1467
|
+
async function run() {
|
|
1468
|
+
const result = await steamSets.account.getAccount({});
|
|
1469
|
+
|
|
1470
|
+
// Handle the result
|
|
1471
|
+
console.log(result);
|
|
1472
|
+
}
|
|
1473
|
+
|
|
1474
|
+
run();
|
|
1475
|
+
```
|
|
1476
|
+
|
|
1477
|
+
### Standalone function
|
|
1478
|
+
|
|
1479
|
+
The standalone function version of this method:
|
|
1480
|
+
|
|
1481
|
+
```typescript
|
|
1482
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1483
|
+
import { accountGetAccount } from "@steamsets/client-ts/funcs/accountGetAccount.js";
|
|
1484
|
+
|
|
1485
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1486
|
+
// You can create one instance of it to use across an application.
|
|
1487
|
+
const steamSets = new SteamSetsCore({
|
|
1488
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1489
|
+
});
|
|
1490
|
+
|
|
1491
|
+
async function run() {
|
|
1492
|
+
const res = await accountGetAccount(steamSets, {});
|
|
1493
|
+
|
|
1494
|
+
if (!res.ok) {
|
|
1495
|
+
throw res.error;
|
|
1496
|
+
}
|
|
1497
|
+
|
|
1498
|
+
const { value: result } = res;
|
|
1499
|
+
|
|
1500
|
+
// Handle the result
|
|
1501
|
+
console.log(result);
|
|
1502
|
+
}
|
|
1503
|
+
|
|
1504
|
+
run();
|
|
1505
|
+
```
|
|
1506
|
+
|
|
1507
|
+
### Parameters
|
|
1508
|
+
|
|
1509
|
+
| Parameter | Type | Required | Description |
|
|
1510
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1511
|
+
| `request` | [components.AccountSearch](../../models/components/accountsearch.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1512
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1513
|
+
| `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. |
|
|
1514
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1515
|
+
|
|
1516
|
+
### Response
|
|
1517
|
+
|
|
1518
|
+
**Promise\<[operations.AdminV1GetAccountResponse](../../models/operations/adminv1getaccountresponse.md)\>**
|
|
1519
|
+
|
|
1520
|
+
### Errors
|
|
1521
|
+
|
|
1522
|
+
| Error Type | Status Code | Content Type |
|
|
1523
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
1524
|
+
| errors.ErrorModel | 403, 404, 422, 429 | application/problem+json |
|
|
1525
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
1526
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1527
|
+
|
|
1528
|
+
## adminV1UpdateResources
|
|
1529
|
+
|
|
1530
|
+
### Example Usage
|
|
1531
|
+
|
|
1532
|
+
```typescript
|
|
1533
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
1534
|
+
|
|
1535
|
+
const steamSets = new SteamSets({
|
|
1536
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1537
|
+
});
|
|
1538
|
+
|
|
1539
|
+
async function run() {
|
|
1540
|
+
const result = await steamSets.account.adminV1UpdateResources({
|
|
1541
|
+
newResources: [
|
|
1542
|
+
{
|
|
1543
|
+
resource: "max_leaderboard_entries",
|
|
1544
|
+
value: "1",
|
|
1545
|
+
},
|
|
1546
|
+
],
|
|
1547
|
+
resource: [
|
|
1548
|
+
"short_link_domain",
|
|
1549
|
+
"background",
|
|
1550
|
+
],
|
|
1551
|
+
});
|
|
1552
|
+
|
|
1553
|
+
// Handle the result
|
|
1554
|
+
console.log(result);
|
|
1555
|
+
}
|
|
1556
|
+
|
|
1557
|
+
run();
|
|
1558
|
+
```
|
|
1559
|
+
|
|
1560
|
+
### Standalone function
|
|
1561
|
+
|
|
1562
|
+
The standalone function version of this method:
|
|
1563
|
+
|
|
1564
|
+
```typescript
|
|
1565
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1566
|
+
import { accountAdminV1UpdateResources } from "@steamsets/client-ts/funcs/accountAdminV1UpdateResources.js";
|
|
1567
|
+
|
|
1568
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1569
|
+
// You can create one instance of it to use across an application.
|
|
1570
|
+
const steamSets = new SteamSetsCore({
|
|
1571
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1572
|
+
});
|
|
1573
|
+
|
|
1574
|
+
async function run() {
|
|
1575
|
+
const res = await accountAdminV1UpdateResources(steamSets, {
|
|
1576
|
+
newResources: [
|
|
1577
|
+
{
|
|
1578
|
+
resource: "max_leaderboard_entries",
|
|
1579
|
+
value: "1",
|
|
1580
|
+
},
|
|
1581
|
+
],
|
|
1582
|
+
resource: [
|
|
1583
|
+
"short_link_domain",
|
|
1584
|
+
"background",
|
|
1585
|
+
],
|
|
1586
|
+
});
|
|
1587
|
+
|
|
1588
|
+
if (!res.ok) {
|
|
1589
|
+
throw res.error;
|
|
1590
|
+
}
|
|
1591
|
+
|
|
1592
|
+
const { value: result } = res;
|
|
1593
|
+
|
|
1594
|
+
// Handle the result
|
|
1595
|
+
console.log(result);
|
|
1596
|
+
}
|
|
1597
|
+
|
|
1598
|
+
run();
|
|
1599
|
+
```
|
|
1600
|
+
|
|
1601
|
+
### Parameters
|
|
1602
|
+
|
|
1603
|
+
| Parameter | Type | Required | Description |
|
|
1604
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1605
|
+
| `request` | [components.V1AdminUpdateResourcesRequestBody](../../models/components/v1adminupdateresourcesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1606
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1607
|
+
| `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. |
|
|
1608
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1609
|
+
|
|
1610
|
+
### Response
|
|
1611
|
+
|
|
1612
|
+
**Promise\<[operations.AdminV1UpdateResourcesResponse](../../models/operations/adminv1updateresourcesresponse.md)\>**
|
|
1613
|
+
|
|
1614
|
+
### Errors
|
|
1615
|
+
|
|
1616
|
+
| Error Type | Status Code | Content Type |
|
|
1617
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
1618
|
+
| errors.ErrorModel | 403, 404, 422, 429 | application/problem+json |
|
|
1619
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
1620
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
1621
|
+
|
|
1622
|
+
## adminV1UpdateRoles
|
|
1623
|
+
|
|
1624
|
+
### Example Usage
|
|
1625
|
+
|
|
1626
|
+
```typescript
|
|
1627
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
1628
|
+
|
|
1629
|
+
const steamSets = new SteamSets({
|
|
1630
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1631
|
+
});
|
|
1632
|
+
|
|
1633
|
+
async function run() {
|
|
1634
|
+
const result = await steamSets.account.adminV1UpdateRoles({
|
|
1635
|
+
roles: [
|
|
1636
|
+
|
|
1637
|
+
],
|
|
1638
|
+
});
|
|
1639
|
+
|
|
1640
|
+
// Handle the result
|
|
1641
|
+
console.log(result);
|
|
1642
|
+
}
|
|
1643
|
+
|
|
1644
|
+
run();
|
|
1645
|
+
```
|
|
1646
|
+
|
|
1647
|
+
### Standalone function
|
|
1648
|
+
|
|
1649
|
+
The standalone function version of this method:
|
|
1650
|
+
|
|
1651
|
+
```typescript
|
|
1652
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
1653
|
+
import { accountAdminV1UpdateRoles } from "@steamsets/client-ts/funcs/accountAdminV1UpdateRoles.js";
|
|
1654
|
+
|
|
1655
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
1656
|
+
// You can create one instance of it to use across an application.
|
|
1657
|
+
const steamSets = new SteamSetsCore({
|
|
1658
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
1659
|
+
});
|
|
1660
|
+
|
|
1661
|
+
async function run() {
|
|
1662
|
+
const res = await accountAdminV1UpdateRoles(steamSets, {
|
|
1663
|
+
roles: [
|
|
1664
|
+
|
|
1665
|
+
],
|
|
1666
|
+
});
|
|
1667
|
+
|
|
1668
|
+
if (!res.ok) {
|
|
1669
|
+
throw res.error;
|
|
1670
|
+
}
|
|
1671
|
+
|
|
1672
|
+
const { value: result } = res;
|
|
1673
|
+
|
|
1674
|
+
// Handle the result
|
|
1675
|
+
console.log(result);
|
|
1676
|
+
}
|
|
1677
|
+
|
|
1678
|
+
run();
|
|
1679
|
+
```
|
|
1680
|
+
|
|
1681
|
+
### Parameters
|
|
1682
|
+
|
|
1683
|
+
| Parameter | Type | Required | Description |
|
|
1684
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
1685
|
+
| `request` | [components.V1AdminUpdateRolessRequestBody](../../models/components/v1adminupdaterolessrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
1686
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
1687
|
+
| `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. |
|
|
1688
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
1689
|
+
|
|
1690
|
+
### Response
|
|
1691
|
+
|
|
1692
|
+
**Promise\<[operations.AdminV1UpdateRolesResponse](../../models/operations/adminv1updaterolesresponse.md)\>**
|
|
1693
|
+
|
|
1694
|
+
### Errors
|
|
1695
|
+
|
|
1696
|
+
| Error Type | Status Code | Content Type |
|
|
1697
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
1698
|
+
| errors.ErrorModel | 403, 404, 422, 429 | application/problem+json |
|
|
1699
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
1216
1700
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|