@steamsets/client-ts 0.27.3 → 0.27.5

package/README.md

@@ -293,7 +293,7 @@ run();
 ### Error Classes
 **Primary errors:**
 * [`SteamSetsError`](./src/models/errors/steamsetserror.ts): The base class for HTTP error responses.
-  * [`ErrorModel`](docs/models/errors/errormodel.md): *
+  * [`ErrorModel`](./src/models/errors/errormodel.ts): *
 
 <details><summary>Less common errors (6)</summary>
 

package/docs/sdks/account/README.md

@@ -49,6 +49,7 @@ All Requests related to account(s) are grouped here.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.bookmarkBadge" method="post" path="/v1/account.bookmarkBadge" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -123,6 +124,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.compareBadges" method="post" path="/v1/account.compareBadges" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -209,6 +211,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.createConnection" method="post" path="/v1/account.createConnection" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -283,6 +286,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.createDeveloperApp" method="post" path="/v1/account.createDeveloperApp" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -361,6 +365,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.deleteConnection" method="post" path="/v1/account.deleteConnection" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -433,6 +438,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.deleteDeveloperApp" method="post" path="/v1/account.deleteDeveloperApp" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -505,6 +511,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.deleteImages" method="post" path="/v1/account.deleteImages" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -585,6 +592,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.deleteSession" method="post" path="/v1/account.deleteSession" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -657,6 +665,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.getBadgeStats" method="post" path="/v1/account.getBadgeStats" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -725,6 +734,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.getDataPoints" method="post" path="/v1/account.getDataPoints" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -793,6 +803,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.getInfo" method="post" path="/v1/account.getInfo" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -861,6 +872,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.getMeta" method="post" path="/v1/account.getMeta" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -929,6 +941,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.getSession" method="post" path="/v1/account.getSession" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -995,6 +1008,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.getSettings" method="post" path="/v1/account.getSettings" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -1061,6 +1075,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.listApps" method="post" path="/v1/account.listApps" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -1129,6 +1144,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.listBadgeBookmarks" method="post" path="/v1/account.listBadgeBookmarks" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -1196,6 +1212,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.listBadges" method="post" path="/v1/account.listBadges" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -1264,6 +1281,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.listFriends" method="post" path="/v1/account.listFriends" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -1332,6 +1350,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.listImages" method="post" path="/v1/account.listImages" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -1398,6 +1417,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.listLeaderboardHistory" method="post" path="/v1/account.listLeaderboardHistory" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -1466,6 +1486,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.listOwnedBadges" method="post" path="/v1/account.listOwnedBadges" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -1533,6 +1554,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.login" method="post" path="/v1/account.login" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -1627,6 +1649,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.logout" method="post" path="/v1/account.logout" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -1694,6 +1717,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.queueUpdate" method="post" path="/v1/account.queueUpdate" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -1762,6 +1786,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.reconnectConnection" method="post" path="/v1/account.reconnectConnection" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -1836,6 +1861,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.refreshSession" method="post" path="/v1/account.refreshSession" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -1912,6 +1938,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.sendEmailVerification" method="post" path="/v1/account.sendEmailVerification" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -1980,6 +2007,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.subscribeEmail" method="post" path="/v1/account.subscribeEmail" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -2058,6 +2086,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.updateConnection" method="post" path="/v1/account.updateConnection" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -2132,6 +2161,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.updateDeveloperApp" method="post" path="/v1/account.updateDeveloperApp" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -2210,6 +2240,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.updateImages" method="post" path="/v1/account.updateImages" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -2282,6 +2313,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.updateRole" method="post" path="/v1/account.updateRole" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -2350,6 +2382,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.updateSettings" method="post" path="/v1/account.updateSettings" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -2432,6 +2465,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.updateVanity" method="post" path="/v1/account.updateVanity" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -2500,6 +2534,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.uploadImages" method="post" path="/v1/account.uploadImages" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -2582,6 +2617,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.verifyConnection" method="post" path="/v1/account.verifyConnection" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -2654,6 +2690,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="account.verifyEmail" method="post" path="/v1/account.verifyEmail" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 

package/docs/sdks/admin/README.md

@@ -16,6 +16,7 @@ Admin related operations, stay away from these.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="admin.getAccount" method="post" path="/v1/admin.getAccount" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -84,6 +85,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="admin.removeVanity" method="post" path="/v1/admin.removeVanity" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -152,6 +154,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="admin.updateResources" method="post" path="/v1/admin.updateResources" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -234,6 +237,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="admin.updateRoles" method="post" path="/v1/admin.updateRoles" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 

package/docs/sdks/apps/README.md

@@ -11,6 +11,7 @@
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="app.listBadges" method="post" path="/v1/app.listBadges" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 

package/docs/sdks/badge/README.md

@@ -15,6 +15,7 @@ Any request that is related to steam badges, mostly badge search/tagging related
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="badge.listAccounts" method="post" path="/v1/badge.listAccounts" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -83,6 +84,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="badge.searchBadges" method="post" path="/v1/badge.searchBadges" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -167,6 +169,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="badge.suggestTags" method="post" path="/v1/badge.suggestTags" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 

package/docs/sdks/badges/README.md

@@ -15,6 +15,7 @@ Get a list of all badge pricing information
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="badge.listBadgePrices" method="post" path="/v1/badge.listBadgePrices" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -81,6 +82,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="badge.listTags" method="post" path="/v1/badge.listTags" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -148,6 +150,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="badge.tagBadge" method="post" path="/v1/badge.tagBadge" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 

package/docs/sdks/leaderboard/README.md

@@ -18,6 +18,7 @@ Any requests that is somehow used for getting leaderboard data.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="leaderboard.getAccountLeaderboard" method="post" path="/v1/leaderboard.getAccountLeaderboard" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -120,6 +121,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="leaderboard.getAccountsMeta" method="post" path="/v1/leaderboard.getAccountsMeta" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -218,6 +220,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="leaderboard.getGroupLeaderboard" method="post" path="/v1/leaderboard.getGroupLeaderboard" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -296,6 +299,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="leaderboard.getGroupsMeta" method="post" path="/v1/leaderboard.getGroupsMeta" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -368,6 +372,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="leaderboard.getLowestRanks" method="post" path="/v1/leaderboard.getLowestRanks" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
@@ -440,6 +445,7 @@ run();
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="leaderboard.previewAccountRank" method="post" path="/v1/leaderboard.previewAccountRank" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 

package/docs/sdks/leaderboards/README.md

@@ -11,6 +11,7 @@
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="leaderboard.listBadges" method="post" path="/v1/leaderboard.listBadges" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 

package/docs/sdks/liveness/README.md

@@ -15,6 +15,7 @@ This endpoint checks if the service is alive.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="liveness" method="get" path="/v1/liveness" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 

package/docs/sdks/location/README.md

@@ -13,6 +13,7 @@ Any location that gives location data.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="location.getLocations" method="get" path="/v1/location.getLocations" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 

package/docs/sdks/staff/README.md

@@ -11,6 +11,7 @@
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="staff.listStaff" method="post" path="/v1/staff.listStaff" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 

package/docs/sdks/stats/README.md

@@ -13,6 +13,7 @@ Any endpoint that return some sort of statistical data.
 
 ### Example Usage
 
+<!-- UsageSnippet language="typescript" operationID="stats.getStats" method="post" path="/v1/stats.getStats" -->
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 

package/examples/README.md

@@ -0,0 +1,31 @@
+# @steamsets/client-ts Examples
+
+This directory contains example scripts demonstrating how to use the @steamsets/client-ts SDK.
+
+## Prerequisites
+
+- Node.js (v18 or higher)
+- npm
+
+## Setup
+
+1. Copy `.env.template` to `.env`:
+   ```bash
+   cp .env.template .env
+   ```
+
+2. Edit `.env` and add your actual credentials
+
+## Running the Examples
+
+To run an example file from the examples directory:
+
+```bash
+npm run build && npx tsx example.ts
+```
+
+## Creating new examples
+
+Duplicate an existing example file, they won't be overwritten by the generation process.
+
+

package/examples/accountBookmarkBadge.example.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import dotenv from "dotenv";
+dotenv.config();
+/**
+ * Example usage of the @steamsets/client-ts SDK
+ *
+ * To run this example from the examples directory:
+ * npm run build && npx tsx accountBookmarkBadge.ts
+ */
+
+import { SteamSets } from "@steamsets/client-ts";
+
+const steamSets = new SteamSets({
+  token: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function main() {
+  const result = await steamSets.bookmarkBadge({
+    badgeId: "bdg_123",
+    bookmark: true,
+  });
+
+  console.log(result);
+}
+
+main().catch(console.error);