@steamsets/client-ts 0.25.14 → 0.26.0

package/docs/sdks/admin/README.md

@@ -26,7 +26,6 @@ const steamSets = new SteamSets({
 async function run() {
   const result = await steamSets.admin.getAccount({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -49,15 +48,12 @@ const steamSets = new SteamSetsCore({
 
 async function run() {
   const res = await adminGetAccount(steamSets, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("adminGetAccount failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -98,7 +94,6 @@ const steamSets = new SteamSets({
 async function run() {
   const result = await steamSets.admin.removeVanity({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -121,15 +116,12 @@ const steamSets = new SteamSetsCore({
 
 async function run() {
   const res = await adminRemoveVanity(steamSets, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("adminRemoveVanity failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -169,10 +161,14 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.admin.updateResources({
-    resources: [],
+    resources: [
+      {
+        resource: "developer_apps",
+        value: "1",
+      },
+    ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -195,17 +191,19 @@ const steamSets = new SteamSetsCore({
 
 async function run() {
   const res = await adminUpdateResources(steamSets, {
-    resources: [],
+    resources: [
+      {
+        resource: "developer_apps",
+        value: "1",
+      },
+    ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("adminUpdateResources failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -245,13 +243,9 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.admin.updateRoles({
-    roles: [
-      "user",
-      "beta",
-    ],
+    roles: null,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -274,20 +268,14 @@ const steamSets = new SteamSetsCore({
 
 async function run() {
   const res = await adminUpdateRoles(steamSets, {
-    roles: [
-      "user",
-      "beta",
-    ],
+    roles: null,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("adminUpdateRoles failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/apps/README.md

@@ -20,10 +20,9 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.apps.listBadges({
-    appId: 194325,
+    appId: 190125,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -46,17 +45,14 @@ const steamSets = new SteamSetsCore({
 
 async function run() {
   const res = await appsListBadges(steamSets, {
-    appId: 194325,
+    appId: 190125,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("appsListBadges failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/badge/README.md

@@ -7,10 +7,79 @@ Any request that is related to steam badges, mostly badge search/tagging related
 
 ### Available Operations
 
+* [badgeListBadgePrices](#badgelistbadgeprices)
 * [search](#search)
 * [suggestSearch](#suggestsearch)
 * [suggestTags](#suggesttags)
 
+## badgeListBadgePrices
+
+### Example Usage
+
+```typescript
+import { SteamSets } from "@steamsets/client-ts";
+
+const steamSets = new SteamSets({
+  token: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await steamSets.badge.badgeListBadgePrices({});
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { SteamSetsCore } from "@steamsets/client-ts/core.js";
+import { badgeBadgeListBadgePrices } from "@steamsets/client-ts/funcs/badgeBadgeListBadgePrices.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 badgeBadgeListBadgePrices(steamSets, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("badgeBadgeListBadgePrices failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.V1BadgeListBadgePricesRequestBody](../../models/components/v1badgelistbadgepricesrequestbody.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.BadgeListBadgePricesResponse](../../models/operations/badgelistbadgepricesresponse.md)\>**
+
+### Errors
+
+| Error Type               | Status Code              | Content Type             |
+| ------------------------ | ------------------------ | ------------------------ |
+| errors.ErrorModel        | 403, 404, 422            | application/problem+json |
+| errors.ErrorModel        | 500                      | application/problem+json |
+| errors.SDKError          | 4XX, 5XX                 | \*/\*                    |
+
 ## search
 
 ### Example Usage
@@ -25,6 +94,7 @@ const steamSets = new SteamSets({
 async function run() {
   const result = await steamSets.badge.search({
     filter: "<value>",
+    image: "base64_encoded_image",
     query: "<value>",
     sort: [
       "price:asc",
@@ -32,7 +102,6 @@ async function run() {
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -56,21 +125,19 @@ const steamSets = new SteamSetsCore({
 async function run() {
   const res = await badgeSearch(steamSets, {
     filter: "<value>",
+    image: "base64_encoded_image",
     query: "<value>",
     sort: [
       "price:asc",
       "author:desc",
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("badgeSearch failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -113,7 +180,6 @@ async function run() {
     query: "<value>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -138,15 +204,12 @@ async function run() {
   const res = await badgeSuggestSearch(steamSets, {
     query: "<value>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("badgeSuggestSearch failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -189,7 +252,6 @@ async function run() {
     badgeId: "<id>",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -214,15 +276,12 @@ async function run() {
   const res = await badgeSuggestTags(steamSets, {
     badgeId: "<id>",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("badgeSuggestTags failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/badges/README.md

@@ -22,7 +22,6 @@ const steamSets = new SteamSets({
 async function run() {
   const result = await steamSets.badges.listTags();
 
-  // Handle the result
   console.log(result);
 }
 
@@ -45,15 +44,12 @@ const steamSets = new SteamSetsCore({
 
 async function run() {
   const res = await badgesListTags(steamSets);
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("badgesListTags failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -105,15 +101,9 @@ async function run() {
         name: "cat",
         remove: true,
       },
-      {
-        id: "bdg_des_2r3yFWjSJzH89FKbYgpkJxF24ZL",
-        name: "cat",
-        remove: true,
-      },
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -149,22 +139,14 @@ async function run() {
         name: "cat",
         remove: true,
       },
-      {
-        id: "bdg_des_2r3yFWjSJzH89FKbYgpkJxF24ZL",
-        name: "cat",
-        remove: true,
-      },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("badgesTag failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/leaderboard/README.md

@@ -30,10 +30,7 @@ async function run() {
     app: {
       appId: 730,
     },
-    badge: {
-      id: 279811,
-      isFoil: true,
-    },
+    badge: null,
     end: 10,
     goToLeaderboardRank: 1,
     leaderboard: "xp",
@@ -44,17 +41,10 @@ async function run() {
         region: "Europe",
         state: "Baden-Wurttemberg",
       },
-      {
-        city: "Bad Krozingen",
-        country: "Germany",
-        region: "Europe",
-        state: "Baden-Wurttemberg",
-      },
     ],
     start: 1,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -80,10 +70,7 @@ async function run() {
     app: {
       appId: 730,
     },
-    badge: {
-      id: 279811,
-      isFoil: true,
-    },
+    badge: null,
     end: 10,
     goToLeaderboardRank: 1,
     leaderboard: "xp",
@@ -94,24 +81,15 @@ async function run() {
         region: "Europe",
         state: "Baden-Wurttemberg",
       },
-      {
-        city: "Bad Krozingen",
-        country: "Germany",
-        region: "Europe",
-        state: "Baden-Wurttemberg",
-      },
     ],
     start: 1,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("leaderboardGetAccount failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -151,11 +129,9 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.leaderboard.getAccountsMeta({
-    app: {
-      appId: 730,
-    },
+    app: null,
     badge: {
-      id: 178474,
+      id: 563969,
       isFoil: true,
     },
     leaderboard: "xp",
@@ -166,16 +142,9 @@ async function run() {
         region: "Europe",
         state: "Baden-Wurttemberg",
       },
-      {
-        city: "Bad Krozingen",
-        country: "Germany",
-        region: "Europe",
-        state: "Baden-Wurttemberg",
-      },
     ],
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -198,11 +167,9 @@ const steamSets = new SteamSetsCore({
 
 async function run() {
   const res = await leaderboardGetAccountsMeta(steamSets, {
-    app: {
-      appId: 730,
-    },
+    app: null,
     badge: {
-      id: 178474,
+      id: 563969,
       isFoil: true,
     },
     leaderboard: "xp",
@@ -213,23 +180,14 @@ async function run() {
         region: "Europe",
         state: "Baden-Wurttemberg",
       },
-      {
-        city: "Bad Krozingen",
-        country: "Germany",
-        region: "Europe",
-        state: "Baden-Wurttemberg",
-      },
     ],
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("leaderboardGetAccountsMeta failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -275,7 +233,6 @@ async function run() {
     start: 1,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -303,15 +260,12 @@ async function run() {
     leaderboard: "most_members",
     start: 1,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("leaderboardGetGroup failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -354,7 +308,6 @@ async function run() {
     leaderboard: "most_members",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -379,15 +332,12 @@ async function run() {
   const res = await leaderboardGetGroupsMeta(steamSets, {
     leaderboard: "most_members",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("leaderboardGetGroupsMeta failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -430,7 +380,6 @@ async function run() {
     leaderboard: "xp",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -455,15 +404,12 @@ async function run() {
   const res = await leaderboardGetLowestRanks(steamSets, {
     leaderboard: "xp",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("leaderboardGetLowestRanks failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -506,7 +452,6 @@ async function run() {
     leaderboard: "xp",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -531,15 +476,12 @@ async function run() {
   const res = await leaderboardPreviewAccountRank(steamSets, {
     leaderboard: "xp",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("leaderboardPreviewAccountRank failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();