npm - @steamsets/client-ts - Versions diffs - 0.28.2 → 0.29.0 - Mend

@steamsets/client-ts 0.28.2 → 0.29.0

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.

Files changed (1206) hide show

package/docs/sdks/apps/README.md DELETED Viewed

@@ -1,83 +0,0 @@
-# Apps
-(*apps*)
-## Overview
-### Available Operations
-* [listBadges](#listbadges) - List app badges
-## listBadges
-List app badges
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="app.listBadges" method="post" path="/v1/app.listBadges" -->
-```typescript
-import { SteamSets } from "@steamsets/client-ts";
-const steamSets = new SteamSets({
-  token: "<YOUR_BEARER_TOKEN_HERE>",
-});
-async function run() {
-  const result = await steamSets.apps.listBadges({
-    appId: 190125,
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { SteamSetsCore } from "@steamsets/client-ts/core.js";
-import { appsListBadges } from "@steamsets/client-ts/funcs/appsListBadges.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 appsListBadges(steamSets, {
-    appId: 190125,
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("appsListBadges failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V1AppListBadgesRequestBody](../../models/components/v1applistbadgesrequestbody.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.AppListBadgesResponse](../../models/operations/applistbadgesresponse.md)\>**
-### Errors
-| Error Type               | Status Code              | Content Type             |
-| ------------------------ | ------------------------ | ------------------------ |
-| errors.ErrorModel        | 400, 401, 404, 422       | application/problem+json |
-| errors.ErrorModel        | 500                      | application/problem+json |
-| errors.SDKError          | 4XX, 5XX                 | \*/\*                    |

package/docs/sdks/badge/README.md DELETED Viewed

@@ -1,177 +0,0 @@
-# Badge
-(*badge*)
-## Overview
-Any request that is related to steam badges, mostly badge search/tagging related.
-### Available Operations
-* [search](#search) - Search badges
-* [suggestTags](#suggesttags) - Suggest badge tag
-## search
-Search badges
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="badge.searchBadges" method="post" path="/v1/badge.searchBadges" -->
-```typescript
-import { SteamSets } from "@steamsets/client-ts";
-const steamSets = new SteamSets({
-  token: "<YOUR_BEARER_TOKEN_HERE>",
-});
-async function run() {
-  const result = await steamSets.badge.search({
-    v1SearchRequest: {
-      filter: "<value>",
-      image: "base64_encoded_image",
-      query: "<value>",
-      sort: [
-        "price:asc",
-        "author:desc",
-      ],
-    },
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { SteamSetsCore } from "@steamsets/client-ts/core.js";
-import { badgeSearch } from "@steamsets/client-ts/funcs/badgeSearch.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 badgeSearch(steamSets, {
-    v1SearchRequest: {
-      filter: "<value>",
-      image: "base64_encoded_image",
-      query: "<value>",
-      sort: [
-        "price:asc",
-        "author:desc",
-      ],
-    },
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("badgeSearch failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.BadgeSearchBadgesRequest](../../models/operations/badgesearchbadgesrequest.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.BadgeSearchBadgesResponse](../../models/operations/badgesearchbadgesresponse.md)\>**
-### Errors
-| Error Type               | Status Code              | Content Type             |
-| ------------------------ | ------------------------ | ------------------------ |
-| errors.ErrorModel        | 400, 401, 422            | application/problem+json |
-| errors.ErrorModel        | 500                      | application/problem+json |
-| errors.SDKError          | 4XX, 5XX                 | \*/\*                    |
-## suggestTags
-Suggest badge tag
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="badge.suggestTags" method="post" path="/v1/badge.suggestTags" -->
-```typescript
-import { SteamSets } from "@steamsets/client-ts";
-const steamSets = new SteamSets({
-  token: "<YOUR_BEARER_TOKEN_HERE>",
-});
-async function run() {
-  const result = await steamSets.badge.suggestTags({
-    badgeId: "<id>",
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { SteamSetsCore } from "@steamsets/client-ts/core.js";
-import { badgeSuggestTags } from "@steamsets/client-ts/funcs/badgeSuggestTags.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 badgeSuggestTags(steamSets, {
-    badgeId: "<id>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("badgeSuggestTags failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V1BadgeSuggestTagsRequestBody](../../models/components/v1badgesuggesttagsrequestbody.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.BadgeSuggestTagsResponse](../../models/operations/badgesuggesttagsresponse.md)\>**
-### Errors
-| Error Type                   | Status Code                  | Content Type                 |
-| ---------------------------- | ---------------------------- | ---------------------------- |
-| errors.ErrorModel            | 400, 401, 403, 404, 422, 429 | application/problem+json     |
-| errors.ErrorModel            | 500                          | application/problem+json     |
-| errors.SDKError              | 4XX, 5XX                     | \*/\*                        |

package/docs/sdks/badges/README.md DELETED Viewed

@@ -1,250 +0,0 @@
-# Badges
-(*badges*)
-## Overview
-### Available Operations
-* [listPrices](#listprices) - List badge prices
-* [listTags](#listtags) - List badge tags
-* [tag](#tag) - Tag a badge
-## listPrices
-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";
-const steamSets = new SteamSets({
-  token: "<YOUR_BEARER_TOKEN_HERE>",
-});
-async function run() {
-  const result = await steamSets.badges.listPrices({});
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { SteamSetsCore } from "@steamsets/client-ts/core.js";
-import { badgesListPrices } from "@steamsets/client-ts/funcs/badgesListPrices.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 badgesListPrices(steamSets, {});
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("badgesListPrices 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.SDKError | 4XX, 5XX        | \*/\*           |
-## listTags
-List badge tags
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="badge.listTags" method="post" path="/v1/badge.listTags" -->
-```typescript
-import { SteamSets } from "@steamsets/client-ts";
-const steamSets = new SteamSets({
-  token: "<YOUR_BEARER_TOKEN_HERE>",
-});
-async function run() {
-  const result = await steamSets.badges.listTags();
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { SteamSetsCore } from "@steamsets/client-ts/core.js";
-import { badgesListTags } from "@steamsets/client-ts/funcs/badgesListTags.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 badgesListTags(steamSets);
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("badgesListTags failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `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.BadgeListTagsResponse](../../models/operations/badgelisttagsresponse.md)\>**
-### Errors
-| Error Type               | Status Code              | Content Type             |
-| ------------------------ | ------------------------ | ------------------------ |
-| errors.ErrorModel        | 400, 401                 | application/problem+json |
-| errors.ErrorModel        | 500                      | application/problem+json |
-| errors.SDKError          | 4XX, 5XX                 | \*/\*                    |
-## tag
-Tag a badge
-### Example Usage
-<!-- UsageSnippet language="typescript" operationID="badge.tagBadge" method="post" path="/v1/badge.tagBadge" -->
-```typescript
-import { SteamSets } from "@steamsets/client-ts";
-const steamSets = new SteamSets({
-  token: "<YOUR_BEARER_TOKEN_HERE>",
-});
-async function run() {
-  const result = await steamSets.badges.tag({
-    badgeId: "bdg_123",
-    colors: [
-      {
-        id: "bdg_col_2r2pqaIpB1zllfZIvUE3OWadIOS",
-        remove: true,
-      },
-    ],
-    designs: [
-      {
-        id: "bdg_des_2r3yFWjSJzH89FKbYgpkJxF24ZL",
-        name: "cat",
-        remove: true,
-      },
-    ],
-  });
-  console.log(result);
-}
-run();
-```
-### Standalone function
-The standalone function version of this method:
-```typescript
-import { SteamSetsCore } from "@steamsets/client-ts/core.js";
-import { badgesTag } from "@steamsets/client-ts/funcs/badgesTag.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 badgesTag(steamSets, {
-    badgeId: "bdg_123",
-    colors: [
-      {
-        id: "bdg_col_2r2pqaIpB1zllfZIvUE3OWadIOS",
-        remove: true,
-      },
-    ],
-    designs: [
-      {
-        id: "bdg_des_2r3yFWjSJzH89FKbYgpkJxF24ZL",
-        name: "cat",
-        remove: true,
-      },
-    ],
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("badgesTag failed:", res.error);
-  }
-}
-run();
-```
-### Parameters
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.V1BadgeTagBadgeRequestBody](../../models/components/v1badgetagbadgerequestbody.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.BadgeTagBadgeResponse](../../models/operations/badgetagbadgeresponse.md)\>**
-### Errors
-| Error Type               | Status Code              | Content Type             |
-| ------------------------ | ------------------------ | ------------------------ |
-| errors.ErrorModel        | 400, 401, 403, 404, 422  | application/problem+json |
-| errors.ErrorModel        | 500                      | application/problem+json |
-| errors.SDKError          | 4XX, 5XX                 | \*/\*                    |