@steamsets/client-ts 0.10.4 → 0.11.1

package/docs/sdks/badge/README.md

@@ -0,0 +1,371 @@
+# Badge
+(*badge*)
+
+## Overview
+
+### Available Operations
+
+* [badgeV1Tags](#badgev1tags) - Get all availiable badge tags
+* [badgeV1Search](#badgev1search) - Search for badges
+* [badgeV1Tag](#badgev1tag) - Tag a badge
+
+## badgeV1Tags
+
+Get all availiable badge tags
+
+### Example Usage
+
+```typescript
+import { SteamSets } from "@steamsets/client-ts";
+
+const steamSets = new SteamSets({
+  session: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await steamSets.badge.badgeV1Tags({});
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { SteamSetsCore } from "@steamsets/client-ts/core.js";
+import { badgeBadgeV1Tags } from "@steamsets/client-ts/funcs/badgeBadgeV1Tags.js";
+
+// Use `SteamSetsCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const steamSets = new SteamSetsCore({
+  session: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const res = await badgeBadgeV1Tags(steamSets, {});
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.V1BadgeTagsRequestBody](../../models/components/v1badgetagsrequestbody.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.BadgeV1TagsResponse](../../models/operations/badgev1tagsresponse.md)\>**
+
+### Errors
+
+| Error Object             | Status Code              | Content Type             |
+| ------------------------ | ------------------------ | ------------------------ |
+| errors.ErrorModel        | 403,404,422,500          | application/problem+json |
+| errors.SDKError          | 4xx-5xx                  | */*                      |
+
+
+## badgeV1Search
+
+Search for badges
+
+### Example Usage
+
+```typescript
+import { SteamSets } from "@steamsets/client-ts";
+
+const steamSets = new SteamSets({
+  session: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await steamSets.badge.badgeV1Search({
+    appId: 123456,
+    appIds: [
+      444,
+      730,
+    ],
+    badgeId: "bdg_123",
+    badgeIds: [
+      "bdg_123",
+      "bdg_456",
+    ],
+    colorSearch: [
+      {
+        "key": [
+          "<value>",
+          "<value>",
+          "<value>",
+        ],
+      },
+    ],
+    isEvent: true,
+    isFoil: true,
+    isSale: true,
+    limit: 10,
+    offset: 0,
+    typeSearch: [
+      {
+        "key": [
+          "<value>",
+        ],
+        "key1": [
+          "<value>",
+        ],
+        "key2": [
+          "<value>",
+          "<value>",
+          "<value>",
+        ],
+      },
+      {
+        "key": [
+          "<value>",
+        ],
+        "key1": [
+          "<value>",
+          "<value>",
+          "<value>",
+        ],
+      },
+    ],
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { SteamSetsCore } from "@steamsets/client-ts/core.js";
+import { badgeBadgeV1Search } from "@steamsets/client-ts/funcs/badgeBadgeV1Search.js";
+
+// Use `SteamSetsCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const steamSets = new SteamSetsCore({
+  session: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const res = await badgeBadgeV1Search(steamSets, {
+    appId: 123456,
+    appIds: [
+      444,
+      730,
+    ],
+    badgeId: "bdg_123",
+    badgeIds: [
+      "bdg_123",
+      "bdg_456",
+    ],
+    colorSearch: [
+      {
+        "key": [
+          "<value>",
+          "<value>",
+          "<value>",
+        ],
+      },
+    ],
+    isEvent: true,
+    isFoil: true,
+    isSale: true,
+    limit: 10,
+    offset: 0,
+    typeSearch: [
+      {
+        "key": [
+          "<value>",
+        ],
+        "key1": [
+          "<value>",
+        ],
+        "key2": [
+          "<value>",
+          "<value>",
+          "<value>",
+        ],
+      },
+      {
+        "key": [
+          "<value>",
+        ],
+        "key1": [
+          "<value>",
+          "<value>",
+          "<value>",
+        ],
+      },
+    ],
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.BadgeSearch](../../models/components/badgesearch.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.BadgeV1SearchResponse](../../models/operations/badgev1searchresponse.md)\>**
+
+### Errors
+
+| Error Object             | Status Code              | Content Type             |
+| ------------------------ | ------------------------ | ------------------------ |
+| errors.ErrorModel        | 403,404,422,500          | application/problem+json |
+| errors.SDKError          | 4xx-5xx                  | */*                      |
+
+
+## badgeV1Tag
+
+Tag a badge
+
+### Example Usage
+
+```typescript
+import { SteamSets } from "@steamsets/client-ts";
+
+const steamSets = new SteamSets({
+  session: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await steamSets.badge.badgeV1Tag({
+    badgeId: "bdg_123",
+    colors: [
+      922516,
+      416016,
+    ],
+    designs: [
+      {
+        id: 1,
+        name: "cat",
+      },
+      {
+        id: 1,
+        name: "cat",
+      },
+      {
+        id: 1,
+        name: "cat",
+      },
+    ],
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { SteamSetsCore } from "@steamsets/client-ts/core.js";
+import { badgeBadgeV1Tag } from "@steamsets/client-ts/funcs/badgeBadgeV1Tag.js";
+
+// Use `SteamSetsCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const steamSets = new SteamSetsCore({
+  session: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const res = await badgeBadgeV1Tag(steamSets, {
+    badgeId: "bdg_123",
+    colors: [
+      922516,
+      416016,
+    ],
+    designs: [
+      {
+        id: 1,
+        name: "cat",
+      },
+      {
+        id: 1,
+        name: "cat",
+      },
+      {
+        id: 1,
+        name: "cat",
+      },
+    ],
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.V1BadgeTagRequestBody](../../models/components/v1badgetagrequestbody.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.BadgeV1TagResponse](../../models/operations/badgev1tagresponse.md)\>**
+
+### Errors
+
+| Error Object             | Status Code              | Content Type             |
+| ------------------------ | ------------------------ | ------------------------ |
+| errors.ErrorModel        | 403,404,422,500          | application/problem+json |
+| errors.SDKError          | 4xx-5xx                  | */*                      |

package/docs/sdks/connection/README.md

@@ -30,9 +30,9 @@ async function run() {
     code: "123456",
     provider: "discord",
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -65,7 +65,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -109,9 +109,9 @@ async function run() {
   const result = await steamSets.connection.accountV1ConnectionDeleteConnection({
     connectionId: "123456",
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -143,7 +143,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -188,9 +188,9 @@ async function run() {
     connectionId: "123456",
     hidden: true,
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -223,7 +223,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -267,9 +267,9 @@ async function run() {
   const result = await steamSets.connection.accountV1ConnectionVerifyConnection({
     connectionId: "123456",
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -301,7 +301,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();

package/docs/sdks/data/README.md

@@ -31,9 +31,9 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.data.accountV1GetApps({});
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -63,7 +63,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -105,9 +105,9 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.data.accountV1GetBadges({});
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -137,7 +137,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -179,9 +179,9 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.data.accountV1GetDataPoints({});
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -211,7 +211,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -253,9 +253,9 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.data.accountV1GetFriends({});
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -285,7 +285,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -327,9 +327,9 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.data.accountV1GetInfo({});
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -359,7 +359,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -401,9 +401,9 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.data.accountV1GetLeaderboardHistory({});
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -433,7 +433,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -475,9 +475,9 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.data.accountV1GetStaff();
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -507,7 +507,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -550,9 +550,9 @@ async function run() {
   const result = await steamSets.data.accountV1Queue({
     id: 730,
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -584,7 +584,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();

package/docs/sdks/leaderboard/README.md

@@ -35,9 +35,9 @@ async function run() {
     },
     start: 1,
   });
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -80,7 +80,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();

package/docs/sdks/liveness/README.md

@@ -24,9 +24,9 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.liveness.liveness();
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -56,7 +56,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();

package/docs/sdks/location/README.md

@@ -22,9 +22,9 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.location.location();
-  
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -54,7 +54,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();