@steamsets/client-ts 0.13.7 → 0.14.1
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/FUNCTIONS.md +107 -0
- package/README.md +33 -19
- package/RUNTIMES.md +22 -0
- package/docs/sdks/account/README.md +93 -12
- package/docs/sdks/images/README.md +332 -0
- package/docs/sdks/session/README.md +2 -2
- package/docs/sdks/settings/README.md +0 -256
- package/docs/sdks/steamsets/README.md +3 -1
- package/funcs/accountAccountV1GetBadgeBookmarks.js +3 -3
- package/funcs/accountAccountV1GetBadgeBookmarks.js.map +1 -1
- package/funcs/accountAccountV1ImagesGet.d.ts +10 -0
- package/funcs/accountAccountV1ImagesGet.d.ts.map +1 -0
- package/funcs/accountAccountV1ImagesGet.js +98 -0
- package/funcs/accountAccountV1ImagesGet.js.map +1 -0
- package/funcs/{settingsUploadImages.d.ts → accountAccountV1ImagesUpdate.d.ts} +2 -2
- package/funcs/accountAccountV1ImagesUpdate.d.ts.map +1 -0
- package/funcs/{accountUpdateImage.js → accountAccountV1ImagesUpdate.js} +9 -9
- package/funcs/accountAccountV1ImagesUpdate.js.map +1 -0
- package/funcs/accountDeleteImages.d.ts +1 -1
- package/funcs/accountDeleteImages.d.ts.map +1 -1
- package/funcs/accountDeleteImages.js +7 -5
- package/funcs/accountDeleteImages.js.map +1 -1
- package/funcs/accountGetApps.js +3 -3
- package/funcs/accountGetApps.js.map +1 -1
- package/funcs/accountGetBadges.js +3 -3
- package/funcs/accountGetBadges.js.map +1 -1
- package/funcs/accountGetDataPoints.js +3 -3
- package/funcs/accountGetDataPoints.js.map +1 -1
- package/funcs/accountGetFriends.js +3 -3
- package/funcs/accountGetFriends.js.map +1 -1
- package/funcs/accountGetInfo.js +3 -3
- package/funcs/accountGetInfo.js.map +1 -1
- package/funcs/accountGetLeaderboardHistory.js +3 -3
- package/funcs/accountGetLeaderboardHistory.js.map +1 -1
- package/funcs/accountGetStaff.js +3 -3
- package/funcs/accountGetStaff.js.map +1 -1
- package/funcs/accountSendEmailVerification.js +3 -3
- package/funcs/accountSendEmailVerification.js.map +1 -1
- package/funcs/accountUploadImages.d.ts +1 -1
- package/funcs/accountUploadImages.d.ts.map +1 -1
- package/funcs/accountUploadImages.js +7 -5
- package/funcs/accountUploadImages.js.map +1 -1
- package/funcs/accountVerifyEmail.js +3 -3
- package/funcs/accountVerifyEmail.js.map +1 -1
- package/funcs/accountsQueue.js +3 -3
- package/funcs/accountsQueue.js.map +1 -1
- package/funcs/adminAdminV1GetEvents.js +3 -3
- package/funcs/adminAdminV1GetEvents.js.map +1 -1
- package/funcs/adminAdminV1UpdateEvent.js +3 -3
- package/funcs/adminAdminV1UpdateEvent.js.map +1 -1
- package/funcs/adminAdminV1UpdateResources.js +3 -3
- package/funcs/adminAdminV1UpdateResources.js.map +1 -1
- package/funcs/adminAdminV1UpdateRoles.js +3 -3
- package/funcs/adminAdminV1UpdateRoles.js.map +1 -1
- package/funcs/adminGetAccount.js +3 -3
- package/funcs/adminGetAccount.js.map +1 -1
- package/funcs/badgeAccountV1BookmarkBadge.js +3 -3
- package/funcs/badgeAccountV1BookmarkBadge.js.map +1 -1
- package/funcs/badgeAccountV1GetBadgeBookmarks.js +3 -3
- package/funcs/badgeAccountV1GetBadgeBookmarks.js.map +1 -1
- package/funcs/badgeGetTags.js +3 -3
- package/funcs/badgeGetTags.js.map +1 -1
- package/funcs/badgesTag.js +3 -3
- package/funcs/badgesTag.js.map +1 -1
- package/funcs/connectionDelete.js +3 -3
- package/funcs/connectionDelete.js.map +1 -1
- package/funcs/connectionUpdate.js +3 -3
- package/funcs/connectionUpdate.js.map +1 -1
- package/funcs/connectionVerify.js +3 -3
- package/funcs/connectionVerify.js.map +1 -1
- package/funcs/connectionsConnect.js +3 -3
- package/funcs/connectionsConnect.js.map +1 -1
- package/funcs/dataGetApps.js +3 -3
- package/funcs/dataGetApps.js.map +1 -1
- package/funcs/dataGetBadges.js +3 -3
- package/funcs/dataGetBadges.js.map +1 -1
- package/funcs/dataGetDataPoints.js +3 -3
- package/funcs/dataGetDataPoints.js.map +1 -1
- package/funcs/dataGetFriends.js +3 -3
- package/funcs/dataGetFriends.js.map +1 -1
- package/funcs/dataGetInfo.js +3 -3
- package/funcs/dataGetInfo.js.map +1 -1
- package/funcs/dataGetLeaderboardHistory.js +3 -3
- package/funcs/dataGetLeaderboardHistory.js.map +1 -1
- package/funcs/dataGetStaff.js +3 -3
- package/funcs/dataGetStaff.js.map +1 -1
- package/funcs/developerCreateDeveloperApp.js +3 -3
- package/funcs/developerCreateDeveloperApp.js.map +1 -1
- package/funcs/developerDeleteDeveloperApp.js +3 -3
- package/funcs/developerDeleteDeveloperApp.js.map +1 -1
- package/funcs/developerUpdateApp.js +3 -3
- package/funcs/developerUpdateApp.js.map +1 -1
- package/funcs/imagesAccountV1ImagesGet.d.ts +10 -0
- package/funcs/imagesAccountV1ImagesGet.d.ts.map +1 -0
- package/funcs/imagesAccountV1ImagesGet.js +98 -0
- package/funcs/imagesAccountV1ImagesGet.js.map +1 -0
- package/funcs/{settingsDeleteImages.d.ts → imagesAccountV1ImagesUpdate.d.ts} +2 -2
- package/funcs/imagesAccountV1ImagesUpdate.d.ts.map +1 -0
- package/funcs/{settingsUpdateImage.js → imagesAccountV1ImagesUpdate.js} +9 -9
- package/funcs/imagesAccountV1ImagesUpdate.js.map +1 -0
- package/funcs/{accountUpdateImage.d.ts → imagesDeleteImages.d.ts} +2 -2
- package/funcs/{accountUpdateImage.d.ts.map → imagesDeleteImages.d.ts.map} +1 -1
- package/funcs/{settingsDeleteImages.js → imagesDeleteImages.js} +10 -8
- package/funcs/imagesDeleteImages.js.map +1 -0
- package/funcs/{settingsUpdateImage.d.ts → imagesUploadImages.d.ts} +2 -2
- package/funcs/imagesUploadImages.d.ts.map +1 -0
- package/funcs/{settingsUploadImages.js → imagesUploadImages.js} +10 -8
- package/funcs/imagesUploadImages.js.map +1 -0
- package/funcs/leaderboardGetAccount.js +3 -3
- package/funcs/leaderboardGetAccount.js.map +1 -1
- package/funcs/leaderboardGetBadges.js +3 -3
- package/funcs/leaderboardGetBadges.js.map +1 -1
- package/funcs/leaderboardGetGroup.js +3 -3
- package/funcs/leaderboardGetGroup.js.map +1 -1
- package/funcs/livenessCheck.js +3 -3
- package/funcs/livenessCheck.js.map +1 -1
- package/funcs/locationsGet.js +3 -3
- package/funcs/locationsGet.js.map +1 -1
- package/funcs/metaAccountV1GetEmbed.js +3 -3
- package/funcs/metaAccountV1GetEmbed.js.map +1 -1
- package/funcs/metaAccountV1GetMeta.js +3 -3
- package/funcs/metaAccountV1GetMeta.js.map +1 -1
- package/funcs/publicGetApps.js +3 -3
- package/funcs/publicGetApps.js.map +1 -1
- package/funcs/publicGetBadges.js +3 -3
- package/funcs/publicGetBadges.js.map +1 -1
- package/funcs/publicGetDataPoints.js +3 -3
- package/funcs/publicGetDataPoints.js.map +1 -1
- package/funcs/publicGetFriends.js +3 -3
- package/funcs/publicGetFriends.js.map +1 -1
- package/funcs/publicGetInfo.js +3 -3
- package/funcs/publicGetInfo.js.map +1 -1
- package/funcs/publicGetLeaderboardHistory.js +3 -3
- package/funcs/publicGetLeaderboardHistory.js.map +1 -1
- package/funcs/sessionCreate.js +3 -3
- package/funcs/sessionCreate.js.map +1 -1
- package/funcs/sessionLogin.js +3 -3
- package/funcs/sessionLogin.js.map +1 -1
- package/funcs/sessionsDelete.js +3 -3
- package/funcs/sessionsDelete.js.map +1 -1
- package/funcs/sessionsGet.js +3 -3
- package/funcs/sessionsGet.js.map +1 -1
- package/funcs/settingsGet.js +3 -3
- package/funcs/settingsGet.js.map +1 -1
- package/funcs/settingsSendEmailVerification.js +3 -3
- package/funcs/settingsSendEmailVerification.js.map +1 -1
- package/funcs/settingsUpdate.js +3 -3
- package/funcs/settingsUpdate.js.map +1 -1
- package/funcs/settingsVerifyEmail.js +3 -3
- package/funcs/settingsVerifyEmail.js.map +1 -1
- package/hooks/hooks.d.ts.map +1 -1
- package/hooks/hooks.js +18 -0
- package/hooks/hooks.js.map +1 -1
- package/hooks/types.d.ts +1 -0
- package/hooks/types.d.ts.map +1 -1
- package/lib/config.d.ts +3 -3
- package/lib/config.js +3 -3
- package/lib/primitives.d.ts +2 -0
- package/lib/primitives.d.ts.map +1 -1
- package/lib/primitives.js +53 -0
- package/lib/primitives.js.map +1 -1
- package/models/components/index.d.ts +2 -1
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +2 -1
- package/models/components/index.js.map +1 -1
- package/models/components/v1getimagesresponsebody.d.ts +38 -0
- package/models/components/v1getimagesresponsebody.d.ts.map +1 -0
- package/models/components/v1getimagesresponsebody.js +71 -0
- package/models/components/v1getimagesresponsebody.js.map +1 -0
- package/models/components/v1getsettingsbody.d.ts +2 -6
- package/models/components/v1getsettingsbody.d.ts.map +1 -1
- package/models/components/v1getsettingsbody.js +0 -3
- package/models/components/v1getsettingsbody.js.map +1 -1
- package/models/components/v1updateimage.d.ts +37 -0
- package/models/components/v1updateimage.d.ts.map +1 -0
- package/models/components/v1updateimage.js +61 -0
- package/models/components/v1updateimage.js.map +1 -0
- package/models/components/v1updateimagerequestbody.d.ts +4 -8
- package/models/components/v1updateimagerequestbody.d.ts.map +1 -1
- package/models/components/v1updateimagerequestbody.js +3 -4
- package/models/components/v1updateimagerequestbody.js.map +1 -1
- package/models/components/v1updateimageresponsebody.d.ts +0 -5
- package/models/components/v1updateimageresponsebody.d.ts.map +1 -1
- package/models/components/v1updateimageresponsebody.js +0 -2
- package/models/components/v1updateimageresponsebody.js.map +1 -1
- package/models/components/v1updatesettingsrequestbody.d.ts +0 -6
- package/models/components/v1updatesettingsrequestbody.d.ts.map +1 -1
- package/models/components/v1updatesettingsrequestbody.js +0 -3
- package/models/components/v1updatesettingsrequestbody.js.map +1 -1
- package/models/operations/accountv1imagesdelete.d.ts +35 -0
- package/models/operations/accountv1imagesdelete.d.ts.map +1 -0
- package/models/operations/{accountv1settingsdeleteimages.js → accountv1imagesdelete.js} +17 -17
- package/models/operations/accountv1imagesdelete.js.map +1 -0
- package/models/operations/accountv1imagesget.d.ts +35 -0
- package/models/operations/accountv1imagesget.d.ts.map +1 -0
- package/models/operations/accountv1imagesget.js +75 -0
- package/models/operations/accountv1imagesget.js.map +1 -0
- package/models/operations/accountv1imagesupdate.d.ts +35 -0
- package/models/operations/accountv1imagesupdate.d.ts.map +1 -0
- package/models/operations/{accountv1settingsupdateimage.js → accountv1imagesupdate.js} +17 -17
- package/models/operations/accountv1imagesupdate.js.map +1 -0
- package/models/operations/accountv1imagesupload.d.ts +35 -0
- package/models/operations/accountv1imagesupload.d.ts.map +1 -0
- package/models/operations/{accountv1settingsuploadimages.js → accountv1imagesupload.js} +17 -17
- package/models/operations/accountv1imagesupload.js.map +1 -0
- package/models/operations/index.d.ts +4 -3
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +4 -3
- package/models/operations/index.js.map +1 -1
- package/package.json +1 -1
- package/sdk/account.d.ts +4 -3
- package/sdk/account.d.ts.map +1 -1
- package/sdk/account.js +7 -3
- package/sdk/account.js.map +1 -1
- package/sdk/images.d.ts +10 -0
- package/sdk/images.d.ts.map +1 -0
- package/sdk/images.js +28 -0
- package/sdk/images.js.map +1 -0
- package/sdk/sdk.d.ts +5 -2
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +7 -2
- package/sdk/sdk.js.map +1 -1
- package/sdk/settings.d.ts +0 -3
- package/sdk/settings.d.ts.map +1 -1
- package/sdk/settings.js +0 -12
- package/sdk/settings.js.map +1 -1
- package/src/funcs/accountAccountV1GetBadgeBookmarks.ts +3 -3
- package/src/funcs/accountAccountV1ImagesGet.ts +124 -0
- package/src/funcs/{accountUpdateImage.ts → accountAccountV1ImagesUpdate.ts} +9 -9
- package/src/funcs/accountDeleteImages.ts +9 -11
- package/src/funcs/accountGetApps.ts +3 -3
- package/src/funcs/accountGetBadges.ts +3 -3
- package/src/funcs/accountGetDataPoints.ts +3 -3
- package/src/funcs/accountGetFriends.ts +3 -3
- package/src/funcs/accountGetInfo.ts +3 -3
- package/src/funcs/accountGetLeaderboardHistory.ts +3 -3
- package/src/funcs/accountGetStaff.ts +3 -3
- package/src/funcs/accountSendEmailVerification.ts +3 -3
- package/src/funcs/accountUploadImages.ts +9 -11
- package/src/funcs/accountVerifyEmail.ts +3 -3
- package/src/funcs/accountsQueue.ts +3 -3
- package/src/funcs/adminAdminV1GetEvents.ts +3 -3
- package/src/funcs/adminAdminV1UpdateEvent.ts +3 -3
- package/src/funcs/adminAdminV1UpdateResources.ts +3 -3
- package/src/funcs/adminAdminV1UpdateRoles.ts +3 -3
- package/src/funcs/adminGetAccount.ts +3 -3
- package/src/funcs/badgeAccountV1BookmarkBadge.ts +3 -3
- package/src/funcs/badgeAccountV1GetBadgeBookmarks.ts +3 -3
- package/src/funcs/badgeGetTags.ts +3 -3
- package/src/funcs/badgesTag.ts +3 -3
- package/src/funcs/connectionDelete.ts +3 -3
- package/src/funcs/connectionUpdate.ts +3 -3
- package/src/funcs/connectionVerify.ts +3 -3
- package/src/funcs/connectionsConnect.ts +3 -3
- package/src/funcs/dataGetApps.ts +3 -3
- package/src/funcs/dataGetBadges.ts +3 -3
- package/src/funcs/dataGetDataPoints.ts +3 -3
- package/src/funcs/dataGetFriends.ts +3 -3
- package/src/funcs/dataGetInfo.ts +3 -3
- package/src/funcs/dataGetLeaderboardHistory.ts +3 -3
- package/src/funcs/dataGetStaff.ts +3 -3
- package/src/funcs/developerCreateDeveloperApp.ts +3 -3
- package/src/funcs/developerDeleteDeveloperApp.ts +3 -3
- package/src/funcs/developerUpdateApp.ts +3 -3
- package/src/funcs/imagesAccountV1ImagesGet.ts +124 -0
- package/src/funcs/{settingsUpdateImage.ts → imagesAccountV1ImagesUpdate.ts} +9 -9
- package/src/funcs/{settingsDeleteImages.ts → imagesDeleteImages.ts} +10 -12
- package/src/funcs/{settingsUploadImages.ts → imagesUploadImages.ts} +10 -12
- package/src/funcs/leaderboardGetAccount.ts +3 -3
- package/src/funcs/leaderboardGetBadges.ts +3 -3
- package/src/funcs/leaderboardGetGroup.ts +3 -3
- package/src/funcs/livenessCheck.ts +3 -3
- package/src/funcs/locationsGet.ts +3 -3
- package/src/funcs/metaAccountV1GetEmbed.ts +3 -3
- package/src/funcs/metaAccountV1GetMeta.ts +3 -3
- package/src/funcs/publicGetApps.ts +3 -3
- package/src/funcs/publicGetBadges.ts +3 -3
- package/src/funcs/publicGetDataPoints.ts +3 -3
- package/src/funcs/publicGetFriends.ts +3 -3
- package/src/funcs/publicGetInfo.ts +3 -3
- package/src/funcs/publicGetLeaderboardHistory.ts +3 -3
- package/src/funcs/sessionCreate.ts +3 -3
- package/src/funcs/sessionLogin.ts +3 -3
- package/src/funcs/sessionsDelete.ts +3 -3
- package/src/funcs/sessionsGet.ts +3 -3
- package/src/funcs/settingsGet.ts +3 -3
- package/src/funcs/settingsSendEmailVerification.ts +3 -3
- package/src/funcs/settingsUpdate.ts +3 -3
- package/src/funcs/settingsVerifyEmail.ts +3 -3
- package/src/hooks/hooks.ts +20 -0
- package/src/hooks/types.ts +7 -0
- package/src/lib/config.ts +3 -3
- package/src/lib/primitives.ts +62 -0
- package/src/models/components/index.ts +2 -1
- package/src/models/components/v1getimagesresponsebody.ts +91 -0
- package/src/models/components/v1getsettingsbody.ts +2 -13
- package/src/models/components/v1updateimage.ts +72 -0
- package/src/models/components/v1updateimagerequestbody.ts +11 -12
- package/src/models/components/v1updateimageresponsebody.ts +0 -7
- package/src/models/components/v1updatesettingsrequestbody.ts +0 -13
- package/src/models/operations/{accountv1settingsdeleteimages.ts → accountv1imagesdelete.ts} +22 -25
- package/src/models/operations/accountv1imagesget.ts +89 -0
- package/src/models/operations/{accountv1settingsupdateimage.ts → accountv1imagesupdate.ts} +22 -25
- package/src/models/operations/{accountv1settingsuploadimages.ts → accountv1imagesupload.ts} +22 -25
- package/src/models/operations/index.ts +4 -3
- package/src/sdk/account.ts +16 -6
- package/src/sdk/images.ts +56 -0
- package/src/sdk/sdk.ts +9 -3
- package/src/sdk/settings.ts +0 -36
- package/src/types/operations.ts +11 -5
- package/types/operations.d.ts +5 -3
- package/types/operations.d.ts.map +1 -1
- package/types/operations.js +3 -0
- package/types/operations.js.map +1 -1
- package/funcs/accountUpdateImage.js.map +0 -1
- package/funcs/settingsDeleteImages.d.ts.map +0 -1
- package/funcs/settingsDeleteImages.js.map +0 -1
- package/funcs/settingsUpdateImage.d.ts.map +0 -1
- package/funcs/settingsUpdateImage.js.map +0 -1
- package/funcs/settingsUploadImages.d.ts.map +0 -1
- package/funcs/settingsUploadImages.js.map +0 -1
- package/models/components/emailnotification.d.ts +0 -66
- package/models/components/emailnotification.d.ts.map +0 -1
- package/models/components/emailnotification.js +0 -82
- package/models/components/emailnotification.js.map +0 -1
- package/models/operations/accountv1settingsdeleteimages.d.ts +0 -35
- package/models/operations/accountv1settingsdeleteimages.d.ts.map +0 -1
- package/models/operations/accountv1settingsdeleteimages.js.map +0 -1
- package/models/operations/accountv1settingsupdateimage.d.ts +0 -35
- package/models/operations/accountv1settingsupdateimage.d.ts.map +0 -1
- package/models/operations/accountv1settingsupdateimage.js.map +0 -1
- package/models/operations/accountv1settingsuploadimages.d.ts +0 -35
- package/models/operations/accountv1settingsuploadimages.d.ts.map +0 -1
- package/models/operations/accountv1settingsuploadimages.js.map +0 -1
- package/src/models/components/emailnotification.ts +0 -109
|
@@ -0,0 +1,332 @@
|
|
|
1
|
+
# Images
|
|
2
|
+
(*images*)
|
|
3
|
+
|
|
4
|
+
## Overview
|
|
5
|
+
|
|
6
|
+
### Available Operations
|
|
7
|
+
|
|
8
|
+
* [deleteImages](#deleteimages)
|
|
9
|
+
* [accountV1ImagesGet](#accountv1imagesget)
|
|
10
|
+
* [accountV1ImagesUpdate](#accountv1imagesupdate)
|
|
11
|
+
* [uploadImages](#uploadimages)
|
|
12
|
+
|
|
13
|
+
## deleteImages
|
|
14
|
+
|
|
15
|
+
### Example Usage
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
19
|
+
|
|
20
|
+
const steamSets = new SteamSets({
|
|
21
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
async function run() {
|
|
25
|
+
const result = await steamSets.images.deleteImages({
|
|
26
|
+
imageIds: [
|
|
27
|
+
"<value>",
|
|
28
|
+
"<value>",
|
|
29
|
+
],
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
// Handle the result
|
|
33
|
+
console.log(result);
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
run();
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Standalone function
|
|
40
|
+
|
|
41
|
+
The standalone function version of this method:
|
|
42
|
+
|
|
43
|
+
```typescript
|
|
44
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
45
|
+
import { imagesDeleteImages } from "@steamsets/client-ts/funcs/imagesDeleteImages.js";
|
|
46
|
+
|
|
47
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
48
|
+
// You can create one instance of it to use across an application.
|
|
49
|
+
const steamSets = new SteamSetsCore({
|
|
50
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
async function run() {
|
|
54
|
+
const res = await imagesDeleteImages(steamSets, {
|
|
55
|
+
imageIds: [
|
|
56
|
+
"<value>",
|
|
57
|
+
"<value>",
|
|
58
|
+
],
|
|
59
|
+
});
|
|
60
|
+
|
|
61
|
+
if (!res.ok) {
|
|
62
|
+
throw res.error;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
const { value: result } = res;
|
|
66
|
+
|
|
67
|
+
// Handle the result
|
|
68
|
+
console.log(result);
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
run();
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Parameters
|
|
75
|
+
|
|
76
|
+
| Parameter | Type | Required | Description |
|
|
77
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
78
|
+
| `request` | [components.V1DeleteImagesRequestBody](../../models/components/v1deleteimagesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
79
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
80
|
+
| `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. |
|
|
81
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
82
|
+
|
|
83
|
+
### Response
|
|
84
|
+
|
|
85
|
+
**Promise\<[operations.AccountV1ImagesDeleteResponse](../../models/operations/accountv1imagesdeleteresponse.md)\>**
|
|
86
|
+
|
|
87
|
+
### Errors
|
|
88
|
+
|
|
89
|
+
| Error Type | Status Code | Content Type |
|
|
90
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
91
|
+
| errors.ErrorModel | 404, 422, 500 | application/problem+json |
|
|
92
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
93
|
+
|
|
94
|
+
## accountV1ImagesGet
|
|
95
|
+
|
|
96
|
+
### Example Usage
|
|
97
|
+
|
|
98
|
+
```typescript
|
|
99
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
100
|
+
|
|
101
|
+
const steamSets = new SteamSets({
|
|
102
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
async function run() {
|
|
106
|
+
const result = await steamSets.images.accountV1ImagesGet();
|
|
107
|
+
|
|
108
|
+
// Handle the result
|
|
109
|
+
console.log(result);
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
run();
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Standalone function
|
|
116
|
+
|
|
117
|
+
The standalone function version of this method:
|
|
118
|
+
|
|
119
|
+
```typescript
|
|
120
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
121
|
+
import { imagesAccountV1ImagesGet } from "@steamsets/client-ts/funcs/imagesAccountV1ImagesGet.js";
|
|
122
|
+
|
|
123
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
124
|
+
// You can create one instance of it to use across an application.
|
|
125
|
+
const steamSets = new SteamSetsCore({
|
|
126
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
127
|
+
});
|
|
128
|
+
|
|
129
|
+
async function run() {
|
|
130
|
+
const res = await imagesAccountV1ImagesGet(steamSets);
|
|
131
|
+
|
|
132
|
+
if (!res.ok) {
|
|
133
|
+
throw res.error;
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
const { value: result } = res;
|
|
137
|
+
|
|
138
|
+
// Handle the result
|
|
139
|
+
console.log(result);
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
run();
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
### Parameters
|
|
146
|
+
|
|
147
|
+
| Parameter | Type | Required | Description |
|
|
148
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
149
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
150
|
+
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
|
|
151
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
152
|
+
|
|
153
|
+
### Response
|
|
154
|
+
|
|
155
|
+
**Promise\<[operations.AccountV1ImagesGetResponse](../../models/operations/accountv1imagesgetresponse.md)\>**
|
|
156
|
+
|
|
157
|
+
### Errors
|
|
158
|
+
|
|
159
|
+
| Error Type | Status Code | Content Type |
|
|
160
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
161
|
+
| errors.ErrorModel | 500 | application/problem+json |
|
|
162
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
163
|
+
|
|
164
|
+
## accountV1ImagesUpdate
|
|
165
|
+
|
|
166
|
+
### Example Usage
|
|
167
|
+
|
|
168
|
+
```typescript
|
|
169
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
170
|
+
|
|
171
|
+
const steamSets = new SteamSets({
|
|
172
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
173
|
+
});
|
|
174
|
+
|
|
175
|
+
async function run() {
|
|
176
|
+
const result = await steamSets.images.accountV1ImagesUpdate({
|
|
177
|
+
images: [
|
|
178
|
+
{
|
|
179
|
+
active: true,
|
|
180
|
+
imageId: "123456",
|
|
181
|
+
},
|
|
182
|
+
],
|
|
183
|
+
});
|
|
184
|
+
|
|
185
|
+
// Handle the result
|
|
186
|
+
console.log(result);
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
run();
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### Standalone function
|
|
193
|
+
|
|
194
|
+
The standalone function version of this method:
|
|
195
|
+
|
|
196
|
+
```typescript
|
|
197
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
198
|
+
import { imagesAccountV1ImagesUpdate } from "@steamsets/client-ts/funcs/imagesAccountV1ImagesUpdate.js";
|
|
199
|
+
|
|
200
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
201
|
+
// You can create one instance of it to use across an application.
|
|
202
|
+
const steamSets = new SteamSetsCore({
|
|
203
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
204
|
+
});
|
|
205
|
+
|
|
206
|
+
async function run() {
|
|
207
|
+
const res = await imagesAccountV1ImagesUpdate(steamSets, {
|
|
208
|
+
images: [
|
|
209
|
+
{
|
|
210
|
+
active: true,
|
|
211
|
+
imageId: "123456",
|
|
212
|
+
},
|
|
213
|
+
],
|
|
214
|
+
});
|
|
215
|
+
|
|
216
|
+
if (!res.ok) {
|
|
217
|
+
throw res.error;
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
const { value: result } = res;
|
|
221
|
+
|
|
222
|
+
// Handle the result
|
|
223
|
+
console.log(result);
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
run();
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
### Parameters
|
|
230
|
+
|
|
231
|
+
| Parameter | Type | Required | Description |
|
|
232
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
233
|
+
| `request` | [components.V1UpdateImageRequestBody](../../models/components/v1updateimagerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
234
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
235
|
+
| `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. |
|
|
236
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
237
|
+
|
|
238
|
+
### Response
|
|
239
|
+
|
|
240
|
+
**Promise\<[operations.AccountV1ImagesUpdateResponse](../../models/operations/accountv1imagesupdateresponse.md)\>**
|
|
241
|
+
|
|
242
|
+
### Errors
|
|
243
|
+
|
|
244
|
+
| Error Type | Status Code | Content Type |
|
|
245
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
246
|
+
| errors.ErrorModel | 404, 422, 500 | application/problem+json |
|
|
247
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
248
|
+
|
|
249
|
+
## uploadImages
|
|
250
|
+
|
|
251
|
+
### Example Usage
|
|
252
|
+
|
|
253
|
+
```typescript
|
|
254
|
+
import { SteamSets } from "@steamsets/client-ts";
|
|
255
|
+
|
|
256
|
+
const steamSets = new SteamSets({
|
|
257
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
258
|
+
});
|
|
259
|
+
|
|
260
|
+
async function run() {
|
|
261
|
+
const result = await steamSets.images.uploadImages({
|
|
262
|
+
images: [
|
|
263
|
+
{
|
|
264
|
+
data: "base64_encoded_image",
|
|
265
|
+
type: "avatar",
|
|
266
|
+
},
|
|
267
|
+
],
|
|
268
|
+
});
|
|
269
|
+
|
|
270
|
+
// Handle the result
|
|
271
|
+
console.log(result);
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
run();
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
### Standalone function
|
|
278
|
+
|
|
279
|
+
The standalone function version of this method:
|
|
280
|
+
|
|
281
|
+
```typescript
|
|
282
|
+
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
283
|
+
import { imagesUploadImages } from "@steamsets/client-ts/funcs/imagesUploadImages.js";
|
|
284
|
+
|
|
285
|
+
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
286
|
+
// You can create one instance of it to use across an application.
|
|
287
|
+
const steamSets = new SteamSetsCore({
|
|
288
|
+
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
289
|
+
});
|
|
290
|
+
|
|
291
|
+
async function run() {
|
|
292
|
+
const res = await imagesUploadImages(steamSets, {
|
|
293
|
+
images: [
|
|
294
|
+
{
|
|
295
|
+
data: "base64_encoded_image",
|
|
296
|
+
type: "avatar",
|
|
297
|
+
},
|
|
298
|
+
],
|
|
299
|
+
});
|
|
300
|
+
|
|
301
|
+
if (!res.ok) {
|
|
302
|
+
throw res.error;
|
|
303
|
+
}
|
|
304
|
+
|
|
305
|
+
const { value: result } = res;
|
|
306
|
+
|
|
307
|
+
// Handle the result
|
|
308
|
+
console.log(result);
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
run();
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
### Parameters
|
|
315
|
+
|
|
316
|
+
| Parameter | Type | Required | Description |
|
|
317
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
318
|
+
| `request` | [components.V1UploadImagesRequestBody](../../models/components/v1uploadimagesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
319
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
320
|
+
| `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. |
|
|
321
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
322
|
+
|
|
323
|
+
### Response
|
|
324
|
+
|
|
325
|
+
**Promise\<[operations.AccountV1ImagesUploadResponse](../../models/operations/accountv1imagesuploadresponse.md)\>**
|
|
326
|
+
|
|
327
|
+
### Errors
|
|
328
|
+
|
|
329
|
+
| Error Type | Status Code | Content Type |
|
|
330
|
+
| ------------------------ | ------------------------ | ------------------------ |
|
|
331
|
+
| errors.ErrorModel | 422, 500 | application/problem+json |
|
|
332
|
+
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
@@ -100,7 +100,7 @@ async function run() {
|
|
|
100
100
|
openidNs: "http://specs.openid.net/auth/2.0",
|
|
101
101
|
openidOpEndpoint: "https://steamsets.com/api/v1/openid/login",
|
|
102
102
|
openidResponseNonce: "123456",
|
|
103
|
-
openidReturnTo: "https://
|
|
103
|
+
openidReturnTo: "https://example.com",
|
|
104
104
|
openidSig: "123456",
|
|
105
105
|
openidSigned: "123456",
|
|
106
106
|
},
|
|
@@ -137,7 +137,7 @@ async function run() {
|
|
|
137
137
|
openidNs: "http://specs.openid.net/auth/2.0",
|
|
138
138
|
openidOpEndpoint: "https://steamsets.com/api/v1/openid/login",
|
|
139
139
|
openidResponseNonce: "123456",
|
|
140
|
-
openidReturnTo: "https://
|
|
140
|
+
openidReturnTo: "https://example.com",
|
|
141
141
|
openidSig: "123456",
|
|
142
142
|
openidSigned: "123456",
|
|
143
143
|
},
|
|
@@ -5,93 +5,11 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [deleteImages](#deleteimages)
|
|
9
8
|
* [get](#get)
|
|
10
9
|
* [sendEmailVerification](#sendemailverification)
|
|
11
|
-
* [updateImage](#updateimage)
|
|
12
10
|
* [update](#update)
|
|
13
|
-
* [uploadImages](#uploadimages)
|
|
14
11
|
* [verifyEmail](#verifyemail)
|
|
15
12
|
|
|
16
|
-
## deleteImages
|
|
17
|
-
|
|
18
|
-
### Example Usage
|
|
19
|
-
|
|
20
|
-
```typescript
|
|
21
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
22
|
-
|
|
23
|
-
const steamSets = new SteamSets({
|
|
24
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
25
|
-
});
|
|
26
|
-
|
|
27
|
-
async function run() {
|
|
28
|
-
const result = await steamSets.settings.deleteImages({
|
|
29
|
-
imageIds: [
|
|
30
|
-
"<value>",
|
|
31
|
-
],
|
|
32
|
-
});
|
|
33
|
-
|
|
34
|
-
// Handle the result
|
|
35
|
-
console.log(result);
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
run();
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
### Standalone function
|
|
42
|
-
|
|
43
|
-
The standalone function version of this method:
|
|
44
|
-
|
|
45
|
-
```typescript
|
|
46
|
-
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
47
|
-
import { settingsDeleteImages } from "@steamsets/client-ts/funcs/settingsDeleteImages.js";
|
|
48
|
-
|
|
49
|
-
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
50
|
-
// You can create one instance of it to use across an application.
|
|
51
|
-
const steamSets = new SteamSetsCore({
|
|
52
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
53
|
-
});
|
|
54
|
-
|
|
55
|
-
async function run() {
|
|
56
|
-
const res = await settingsDeleteImages(steamSets, {
|
|
57
|
-
imageIds: [
|
|
58
|
-
"<value>",
|
|
59
|
-
],
|
|
60
|
-
});
|
|
61
|
-
|
|
62
|
-
if (!res.ok) {
|
|
63
|
-
throw res.error;
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
const { value: result } = res;
|
|
67
|
-
|
|
68
|
-
// Handle the result
|
|
69
|
-
console.log(result);
|
|
70
|
-
}
|
|
71
|
-
|
|
72
|
-
run();
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
### Parameters
|
|
76
|
-
|
|
77
|
-
| Parameter | Type | Required | Description |
|
|
78
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
79
|
-
| `request` | [components.V1DeleteImagesRequestBody](../../models/components/v1deleteimagesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
80
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
81
|
-
| `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. |
|
|
82
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
83
|
-
|
|
84
|
-
### Response
|
|
85
|
-
|
|
86
|
-
**Promise\<[operations.AccountV1SettingsDeleteImagesResponse](../../models/operations/accountv1settingsdeleteimagesresponse.md)\>**
|
|
87
|
-
|
|
88
|
-
### Errors
|
|
89
|
-
|
|
90
|
-
| Error Type | Status Code | Content Type |
|
|
91
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
92
|
-
| errors.ErrorModel | 404, 422, 500 | application/problem+json |
|
|
93
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
94
|
-
|
|
95
13
|
## get
|
|
96
14
|
|
|
97
15
|
### Example Usage
|
|
@@ -233,83 +151,6 @@ run();
|
|
|
233
151
|
| errors.ErrorModel | 404, 422, 429, 500 | application/problem+json |
|
|
234
152
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
235
153
|
|
|
236
|
-
## updateImage
|
|
237
|
-
|
|
238
|
-
### Example Usage
|
|
239
|
-
|
|
240
|
-
```typescript
|
|
241
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
242
|
-
|
|
243
|
-
const steamSets = new SteamSets({
|
|
244
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
245
|
-
});
|
|
246
|
-
|
|
247
|
-
async function run() {
|
|
248
|
-
const result = await steamSets.settings.updateImage({
|
|
249
|
-
active: true,
|
|
250
|
-
imageId: "123456",
|
|
251
|
-
});
|
|
252
|
-
|
|
253
|
-
// Handle the result
|
|
254
|
-
console.log(result);
|
|
255
|
-
}
|
|
256
|
-
|
|
257
|
-
run();
|
|
258
|
-
```
|
|
259
|
-
|
|
260
|
-
### Standalone function
|
|
261
|
-
|
|
262
|
-
The standalone function version of this method:
|
|
263
|
-
|
|
264
|
-
```typescript
|
|
265
|
-
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
266
|
-
import { settingsUpdateImage } from "@steamsets/client-ts/funcs/settingsUpdateImage.js";
|
|
267
|
-
|
|
268
|
-
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
269
|
-
// You can create one instance of it to use across an application.
|
|
270
|
-
const steamSets = new SteamSetsCore({
|
|
271
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
272
|
-
});
|
|
273
|
-
|
|
274
|
-
async function run() {
|
|
275
|
-
const res = await settingsUpdateImage(steamSets, {
|
|
276
|
-
active: true,
|
|
277
|
-
imageId: "123456",
|
|
278
|
-
});
|
|
279
|
-
|
|
280
|
-
if (!res.ok) {
|
|
281
|
-
throw res.error;
|
|
282
|
-
}
|
|
283
|
-
|
|
284
|
-
const { value: result } = res;
|
|
285
|
-
|
|
286
|
-
// Handle the result
|
|
287
|
-
console.log(result);
|
|
288
|
-
}
|
|
289
|
-
|
|
290
|
-
run();
|
|
291
|
-
```
|
|
292
|
-
|
|
293
|
-
### Parameters
|
|
294
|
-
|
|
295
|
-
| Parameter | Type | Required | Description |
|
|
296
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
297
|
-
| `request` | [components.V1UpdateImageRequestBody](../../models/components/v1updateimagerequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
298
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
299
|
-
| `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. |
|
|
300
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
301
|
-
|
|
302
|
-
### Response
|
|
303
|
-
|
|
304
|
-
**Promise\<[operations.AccountV1SettingsUpdateImageResponse](../../models/operations/accountv1settingsupdateimageresponse.md)\>**
|
|
305
|
-
|
|
306
|
-
### Errors
|
|
307
|
-
|
|
308
|
-
| Error Type | Status Code | Content Type |
|
|
309
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
310
|
-
| errors.ErrorModel | 404, 422, 500 | application/problem+json |
|
|
311
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
312
|
-
|
|
313
154
|
## update
|
|
314
155
|
|
|
315
156
|
### Example Usage
|
|
@@ -327,12 +168,6 @@ async function run() {
|
|
|
327
168
|
color: "#7652c9",
|
|
328
169
|
colors: "#7652c9",
|
|
329
170
|
email: "steamsets@example.com",
|
|
330
|
-
emailNotifications: [
|
|
331
|
-
{
|
|
332
|
-
enabled: true,
|
|
333
|
-
type: "login",
|
|
334
|
-
},
|
|
335
|
-
],
|
|
336
171
|
hidden: true,
|
|
337
172
|
language: "en",
|
|
338
173
|
role: "emerald",
|
|
@@ -368,12 +203,6 @@ async function run() {
|
|
|
368
203
|
color: "#7652c9",
|
|
369
204
|
colors: "#7652c9",
|
|
370
205
|
email: "steamsets@example.com",
|
|
371
|
-
emailNotifications: [
|
|
372
|
-
{
|
|
373
|
-
enabled: true,
|
|
374
|
-
type: "login",
|
|
375
|
-
},
|
|
376
|
-
],
|
|
377
206
|
hidden: true,
|
|
378
207
|
language: "en",
|
|
379
208
|
role: "emerald",
|
|
@@ -415,91 +244,6 @@ run();
|
|
|
415
244
|
| errors.ErrorModel | 422, 429, 500 | application/problem+json |
|
|
416
245
|
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
417
246
|
|
|
418
|
-
## uploadImages
|
|
419
|
-
|
|
420
|
-
### Example Usage
|
|
421
|
-
|
|
422
|
-
```typescript
|
|
423
|
-
import { SteamSets } from "@steamsets/client-ts";
|
|
424
|
-
|
|
425
|
-
const steamSets = new SteamSets({
|
|
426
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
427
|
-
});
|
|
428
|
-
|
|
429
|
-
async function run() {
|
|
430
|
-
const result = await steamSets.settings.uploadImages({
|
|
431
|
-
images: [
|
|
432
|
-
{
|
|
433
|
-
data: "base64_encoded_image",
|
|
434
|
-
type: "avatar",
|
|
435
|
-
},
|
|
436
|
-
],
|
|
437
|
-
});
|
|
438
|
-
|
|
439
|
-
// Handle the result
|
|
440
|
-
console.log(result);
|
|
441
|
-
}
|
|
442
|
-
|
|
443
|
-
run();
|
|
444
|
-
```
|
|
445
|
-
|
|
446
|
-
### Standalone function
|
|
447
|
-
|
|
448
|
-
The standalone function version of this method:
|
|
449
|
-
|
|
450
|
-
```typescript
|
|
451
|
-
import { SteamSetsCore } from "@steamsets/client-ts/core.js";
|
|
452
|
-
import { settingsUploadImages } from "@steamsets/client-ts/funcs/settingsUploadImages.js";
|
|
453
|
-
|
|
454
|
-
// Use `SteamSetsCore` for best tree-shaking performance.
|
|
455
|
-
// You can create one instance of it to use across an application.
|
|
456
|
-
const steamSets = new SteamSetsCore({
|
|
457
|
-
token: "<YOUR_BEARER_TOKEN_HERE>",
|
|
458
|
-
});
|
|
459
|
-
|
|
460
|
-
async function run() {
|
|
461
|
-
const res = await settingsUploadImages(steamSets, {
|
|
462
|
-
images: [
|
|
463
|
-
{
|
|
464
|
-
data: "base64_encoded_image",
|
|
465
|
-
type: "avatar",
|
|
466
|
-
},
|
|
467
|
-
],
|
|
468
|
-
});
|
|
469
|
-
|
|
470
|
-
if (!res.ok) {
|
|
471
|
-
throw res.error;
|
|
472
|
-
}
|
|
473
|
-
|
|
474
|
-
const { value: result } = res;
|
|
475
|
-
|
|
476
|
-
// Handle the result
|
|
477
|
-
console.log(result);
|
|
478
|
-
}
|
|
479
|
-
|
|
480
|
-
run();
|
|
481
|
-
```
|
|
482
|
-
|
|
483
|
-
### Parameters
|
|
484
|
-
|
|
485
|
-
| Parameter | Type | Required | Description |
|
|
486
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
487
|
-
| `request` | [components.V1UploadImagesRequestBody](../../models/components/v1uploadimagesrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
488
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
489
|
-
| `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. |
|
|
490
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
491
|
-
|
|
492
|
-
### Response
|
|
493
|
-
|
|
494
|
-
**Promise\<[operations.AccountV1SettingsUploadImagesResponse](../../models/operations/accountv1settingsuploadimagesresponse.md)\>**
|
|
495
|
-
|
|
496
|
-
### Errors
|
|
497
|
-
|
|
498
|
-
| Error Type | Status Code | Content Type |
|
|
499
|
-
| ------------------------ | ------------------------ | ------------------------ |
|
|
500
|
-
| errors.ErrorModel | 422, 500 | application/problem+json |
|
|
501
|
-
| errors.SDKError | 4XX, 5XX | \*/\* |
|
|
502
|
-
|
|
503
247
|
## verifyEmail
|
|
504
248
|
|
|
505
249
|
### Example Usage
|