@steamsets/client-ts 0.27.9 → 0.28.0

package/docs/sdks/account/README.md

@@ -7,46 +7,47 @@ All Requests related to account(s) are grouped here.
 
 ### Available Operations
 
-* [bookmarkBadge](#bookmarkbadge)
-* [compareBadges](#comparebadges)
-* [createConnection](#createconnection)
-* [createDeveloperApp](#createdeveloperapp)
-* [deleteConnection](#deleteconnection)
-* [deleteDeveloperApp](#deletedeveloperapp)
-* [deleteImages](#deleteimages)
-* [deleteSession](#deletesession)
-* [getBadgeStats](#getbadgestats)
-* [getDataPoints](#getdatapoints)
-* [getInfo](#getinfo)
-* [getMeta](#getmeta)
-* [getSession](#getsession)
-* [getSettings](#getsettings)
-* [listApps](#listapps)
-* [listBadgeBookmarks](#listbadgebookmarks)
-* [listBadges](#listbadges)
-* [listFriends](#listfriends)
-* [listImages](#listimages)
-* [listLeaderboardHistory](#listleaderboardhistory)
-* [listOwnedBadges](#listownedbadges)
-* [login](#login)
-* [logout](#logout)
-* [queueUpdate](#queueupdate)
-* [reconnectConnection](#reconnectconnection)
-* [refreshSession](#refreshsession)
-* [sendEmailVerification](#sendemailverification)
-* [subscribeEmail](#subscribeemail)
-* [updateConnection](#updateconnection)
-* [updateDeveloperApp](#updatedeveloperapp)
-* [updateImages](#updateimages)
-* [updateRole](#updaterole)
-* [updateSettings](#updatesettings)
-* [updateVanity](#updatevanity)
-* [uploadImages](#uploadimages)
-* [verifyConnection](#verifyconnection)
-* [verifyEmail](#verifyemail)
+* [bookmarkBadge](#bookmarkbadge) - Bookmark or unbookmark a badge
+* [createConnection](#createconnection) - Create OAuth or domain connection
+* [createDeveloperApp](#createdeveloperapp) - Create developer application
+* [deleteConnection](#deleteconnection) - Delete OAuth or domain connection
+* [deleteDeveloperApp](#deletedeveloperapp) - Delete developer application
+* [deleteImages](#deleteimages) - Delete uploaded images
+* [deleteSession](#deletesession) - Delete user session
+* [getBadgeStats](#getbadgestats) - Get account badge statistics
+* [getDataPoints](#getdatapoints) - Get account data points for charts
+* [getInfo](#getinfo) - Get account profile information
+* [getMeta](#getmeta) - Get account metadata
+* [getSession](#getsession) - Get user session information
+* [getSettings](#getsettings) - Get account settings
+* [listApps](#listapps) - List account owned apps
+* [listBadgeBookmarks](#listbadgebookmarks) - List bookmarked badges
+* [listBadges](#listbadges) - List account badges
+* [listFriends](#listfriends) - List account friends
+* [listImages](#listimages) - List uploaded images
+* [listLeaderboardHistory](#listleaderboardhistory) - Get leaderboard history
+* [listOwnedBadges](#listownedbadges) - List owned badges
+* [login](#login) - Login with Steam
+* [logout](#logout) - Logout from session
+* [queueUpdate](#queueupdate) - Queue account update
+* [reconnectConnection](#reconnectconnection) - Reconnect OAuth connection
+* [refreshSession](#refreshsession) - Refresh session token
+* [sendEmailVerification](#sendemailverification) - Send email verification
+* [subscribeEmail](#subscribeemail) - Subscribe to email notifications
+* [updateConnection](#updateconnection) - Update OAuth connection
+* [updateDeveloperApp](#updatedeveloperapp) - Update developer application
+* [updateImages](#updateimages) - Update account images
+* [updateRole](#updaterole) - Update account role
+* [updateSettings](#updatesettings) - Update account settings
+* [updateVanity](#updatevanity) - Update account vanity URL
+* [uploadImages](#uploadimages) - Upload images
+* [verifyConnection](#verifyconnection) - Verify OAuth connection
+* [verifyEmail](#verifyemail) - Verify email address
 
 ## bookmarkBadge
 
+Bookmark or unbookmark a badge
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.bookmarkBadge" method="post" path="/v1/account.bookmarkBadge" -->
@@ -120,95 +121,10 @@ run();
 | errors.ErrorModel        | 500                      | application/problem+json |
 | errors.SDKError          | 4XX, 5XX                 | \*/\*                    |
 
-## compareBadges
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="account.compareBadges" method="post" path="/v1/account.compareBadges" -->
-```typescript
-import { SteamSets } from "@steamsets/client-ts";
-
-const steamSets = new SteamSets({
-  token: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await steamSets.account.compareBadges({
-    comparing: [
-      {},
-    ],
-    compare: {
-      against: "<value>",
-    },
-    ignore: [],
-    order: {},
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { SteamSetsCore } from "@steamsets/client-ts/core.js";
-import { accountCompareBadges } from "@steamsets/client-ts/funcs/accountCompareBadges.js";
-
-// Use `SteamSetsCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const steamSets = new SteamSetsCore({
-  token: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const res = await accountCompareBadges(steamSets, {
-    comparing: [
-      {},
-    ],
-    compare: {
-      against: "<value>",
-    },
-    ignore: [],
-    order: {},
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("accountCompareBadges failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V1AccountCompareBadgesRequestBody](../../models/components/v1accountcomparebadgesrequestbody.md)                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `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. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.AccountCompareBadgesResponse](../../models/operations/accountcomparebadgesresponse.md)\>**
-
-### Errors
-
-| Error Type               | Status Code              | Content Type             |
-| ------------------------ | ------------------------ | ------------------------ |
-| errors.ErrorModel        | 400, 401, 404, 412, 422  | application/problem+json |
-| errors.ErrorModel        | 500                      | application/problem+json |
-| errors.SDKError          | 4XX, 5XX                 | \*/\*                    |
-
 ## createConnection
 
+Create OAuth or domain connection
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.createConnection" method="post" path="/v1/account.createConnection" -->
@@ -284,6 +200,8 @@ run();
 
 ## createDeveloperApp
 
+Create developer application
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.createDeveloperApp" method="post" path="/v1/account.createDeveloperApp" -->
@@ -363,6 +281,8 @@ run();
 
 ## deleteConnection
 
+Delete OAuth or domain connection
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.deleteConnection" method="post" path="/v1/account.deleteConnection" -->
@@ -436,6 +356,8 @@ run();
 
 ## deleteDeveloperApp
 
+Delete developer application
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.deleteDeveloperApp" method="post" path="/v1/account.deleteDeveloperApp" -->
@@ -509,6 +431,8 @@ run();
 
 ## deleteImages
 
+Delete uploaded images
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.deleteImages" method="post" path="/v1/account.deleteImages" -->
@@ -590,6 +514,8 @@ run();
 
 ## deleteSession
 
+Delete user session
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.deleteSession" method="post" path="/v1/account.deleteSession" -->
@@ -663,6 +589,8 @@ run();
 
 ## getBadgeStats
 
+Get account badge statistics
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.getBadgeStats" method="post" path="/v1/account.getBadgeStats" -->
@@ -732,6 +660,8 @@ run();
 
 ## getDataPoints
 
+Get account data points for charts
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.getDataPoints" method="post" path="/v1/account.getDataPoints" -->
@@ -801,6 +731,8 @@ run();
 
 ## getInfo
 
+Get account profile information
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.getInfo" method="post" path="/v1/account.getInfo" -->
@@ -870,6 +802,8 @@ run();
 
 ## getMeta
 
+Get account metadata
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.getMeta" method="post" path="/v1/account.getMeta" -->
@@ -939,6 +873,8 @@ run();
 
 ## getSession
 
+Get user session information
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.getSession" method="post" path="/v1/account.getSession" -->
@@ -1007,6 +943,8 @@ run();
 
 ## getSettings
 
+Get account settings
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.getSettings" method="post" path="/v1/account.getSettings" -->
@@ -1075,6 +1013,8 @@ run();
 
 ## listApps
 
+List account owned apps
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.listApps" method="post" path="/v1/account.listApps" -->
@@ -1144,6 +1084,8 @@ run();
 
 ## listBadgeBookmarks
 
+List bookmarked badges
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.listBadgeBookmarks" method="post" path="/v1/account.listBadgeBookmarks" -->
@@ -1212,6 +1154,8 @@ run();
 
 ## listBadges
 
+List account badges
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.listBadges" method="post" path="/v1/account.listBadges" -->
@@ -1281,6 +1225,8 @@ run();
 
 ## listFriends
 
+List account friends
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.listFriends" method="post" path="/v1/account.listFriends" -->
@@ -1350,6 +1296,8 @@ run();
 
 ## listImages
 
+List uploaded images
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.listImages" method="post" path="/v1/account.listImages" -->
@@ -1418,6 +1366,8 @@ run();
 
 ## listLeaderboardHistory
 
+Get leaderboard history
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.listLeaderboardHistory" method="post" path="/v1/account.listLeaderboardHistory" -->
@@ -1487,6 +1437,8 @@ run();
 
 ## listOwnedBadges
 
+List owned badges
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.listOwnedBadges" method="post" path="/v1/account.listOwnedBadges" -->
@@ -1555,6 +1507,8 @@ run();
 
 ## login
 
+Login with Steam
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.login" method="post" path="/v1/account.login" -->
@@ -1650,6 +1604,8 @@ run();
 
 ## logout
 
+Logout from session
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.logout" method="post" path="/v1/account.logout" -->
@@ -1718,6 +1674,8 @@ run();
 
 ## queueUpdate
 
+Queue account update
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.queueUpdate" method="post" path="/v1/account.queueUpdate" -->
@@ -1729,7 +1687,9 @@ const steamSets = new SteamSets({
 });
 
 async function run() {
-  const result = await steamSets.account.queueUpdate({});
+  const result = await steamSets.account.queueUpdate({
+    v1AccountQueueUpdateRequestBody: {},
+  });
 
   console.log(result);
 }
@@ -1752,7 +1712,9 @@ const steamSets = new SteamSetsCore({
 });
 
 async function run() {
-  const res = await accountQueueUpdate(steamSets, {});
+  const res = await accountQueueUpdate(steamSets, {
+    v1AccountQueueUpdateRequestBody: {},
+  });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
@@ -1768,7 +1730,7 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V1AccountQueueUpdateRequestBody](../../models/components/v1accountqueueupdaterequestbody.md)                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.AccountQueueUpdateRequest](../../models/operations/accountqueueupdaterequest.md)                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `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. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
@@ -1787,6 +1749,8 @@ run();
 
 ## reconnectConnection
 
+Reconnect OAuth connection
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.reconnectConnection" method="post" path="/v1/account.reconnectConnection" -->
@@ -1862,6 +1826,8 @@ run();
 
 ## refreshSession
 
+Refresh session token
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.refreshSession" method="post" path="/v1/account.refreshSession" -->
@@ -1939,6 +1905,8 @@ run();
 
 ## sendEmailVerification
 
+Send email verification
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.sendEmailVerification" method="post" path="/v1/account.sendEmailVerification" -->
@@ -2008,6 +1976,8 @@ run();
 
 ## subscribeEmail
 
+Subscribe to email notifications
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.subscribeEmail" method="post" path="/v1/account.subscribeEmail" -->
@@ -2087,6 +2057,8 @@ run();
 
 ## updateConnection
 
+Update OAuth connection
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.updateConnection" method="post" path="/v1/account.updateConnection" -->
@@ -2162,6 +2134,8 @@ run();
 
 ## updateDeveloperApp
 
+Update developer application
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.updateDeveloperApp" method="post" path="/v1/account.updateDeveloperApp" -->
@@ -2241,6 +2215,8 @@ run();
 
 ## updateImages
 
+Update account images
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.updateImages" method="post" path="/v1/account.updateImages" -->
@@ -2314,6 +2290,8 @@ run();
 
 ## updateRole
 
+Update account role
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.updateRole" method="post" path="/v1/account.updateRole" -->
@@ -2383,6 +2361,8 @@ run();
 
 ## updateSettings
 
+Update account settings
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.updateSettings" method="post" path="/v1/account.updateSettings" -->
@@ -2466,6 +2446,8 @@ run();
 
 ## updateVanity
 
+Update account vanity URL
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.updateVanity" method="post" path="/v1/account.updateVanity" -->
@@ -2535,6 +2517,8 @@ run();
 
 ## uploadImages
 
+Upload images
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.uploadImages" method="post" path="/v1/account.uploadImages" -->
@@ -2618,6 +2602,8 @@ run();
 
 ## verifyConnection
 
+Verify OAuth connection
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.verifyConnection" method="post" path="/v1/account.verifyConnection" -->
@@ -2691,6 +2677,8 @@ run();
 
 ## verifyEmail
 
+Verify email address
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="account.verifyEmail" method="post" path="/v1/account.verifyEmail" -->

package/docs/sdks/apps/README.md

@@ -5,10 +5,12 @@
 
 ### Available Operations
 
-* [listBadges](#listbadges)
+* [listBadges](#listbadges) - List app badges
 
 ## listBadges
 
+List app badges
+
 ### Example Usage
 
 <!-- UsageSnippet language="typescript" operationID="app.listBadges" method="post" path="/v1/app.listBadges" -->