@steamsets/client-ts 0.15.0 → 0.16.0

package/docs/sdks/badges/README.md

@@ -5,8 +5,310 @@
 
 ### Available Operations
 
+* [bookmark](#bookmark)
+* [getBookmarks](#getbookmarks)
+* [getOwned](#getowned)
+* [search](#search)
 * [tag](#tag)
 
+## bookmark
+
+### 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.badges.bookmark({
+    badgeId: "bdg_123",
+    bookmark: true,
+  });
+
+  // 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 { badgesBookmark } from "@steamsets/client-ts/funcs/badgesBookmark.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 badgesBookmark(steamSets, {
+    badgeId: "bdg_123",
+    bookmark: true,
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.V1AccountBadgeBookmarkRequestBody](../../models/components/v1accountbadgebookmarkrequestbody.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.AccountV1BookmarkBadgeResponse](../../models/operations/accountv1bookmarkbadgeresponse.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                 | \*/\*                    |
+
+## getBookmarks
+
+### 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.badges.getBookmarks();
+
+  // 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 { badgesGetBookmarks } from "@steamsets/client-ts/funcs/badgesGetBookmarks.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 badgesGetBookmarks(steamSets);
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+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.AccountV1GetBadgeBookmarksResponse](../../models/operations/accountv1getbadgebookmarksresponse.md)\>**
+
+### Errors
+
+| Error Type               | Status Code              | Content Type             |
+| ------------------------ | ------------------------ | ------------------------ |
+| errors.ErrorModel        | 403, 404                 | application/problem+json |
+| errors.ErrorModel        | 500                      | application/problem+json |
+| errors.SDKError          | 4XX, 5XX                 | \*/\*                    |
+
+## getOwned
+
+### 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.badges.getOwned();
+
+  // 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 { badgesGetOwned } from "@steamsets/client-ts/funcs/badgesGetOwned.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 badgesGetOwned(steamSets);
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+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.AccountV1GetOwnedBadgesResponse](../../models/operations/accountv1getownedbadgesresponse.md)\>**
+
+### Errors
+
+| Error Type               | Status Code              | Content Type             |
+| ------------------------ | ------------------------ | ------------------------ |
+| errors.ErrorModel        | 403, 404                 | application/problem+json |
+| errors.ErrorModel        | 500                      | application/problem+json |
+| errors.SDKError          | 4XX, 5XX                 | \*/\*                    |
+
+## search
+
+### 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.badges.search({
+    filter: "<value>",
+    query: "<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 { badgesSearch } from "@steamsets/client-ts/funcs/badgesSearch.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 badgesSearch(steamSets, {
+    filter: "<value>",
+    query: "<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.V1SearchRequest](../../models/components/v1searchrequest.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 Type               | Status Code              | Content Type             |
+| ------------------------ | ------------------------ | ------------------------ |
+| errors.ErrorModel        | 403, 404, 422            | application/problem+json |
+| errors.ErrorModel        | 500                      | application/problem+json |
+| errors.SDKError          | 4XX, 5XX                 | \*/\*                    |
+
 ## tag
 
 ### Example Usage

package/docs/sdks/connection/README.md

@@ -8,7 +8,7 @@ Operations related to oauth2/custom connections.
 ### Available Operations
 
 * [delete](#delete)
-* [accountV1ConnectionReconnect](#accountv1connectionreconnect)
+* [reconnect](#reconnect)
 * [update](#update)
 * [verify](#verify)
 
@@ -88,7 +88,7 @@ run();
 | errors.ErrorModel        | 500                      | application/problem+json |
 | errors.SDKError          | 4XX, 5XX                 | \*/\*                    |
 
-## accountV1ConnectionReconnect
+## reconnect
 
 ### Example Usage
 
@@ -100,7 +100,7 @@ const steamSets = new SteamSets({
 });
 
 async function run() {
-  const result = await steamSets.connection.accountV1ConnectionReconnect({
+  const result = await steamSets.connection.reconnect({
     code: "123456",
     connectionId: "123456",
   });
@@ -118,7 +118,7 @@ The standalone function version of this method:
 
 ```typescript
 import { SteamSetsCore } from "@steamsets/client-ts/core.js";
-import { connectionAccountV1ConnectionReconnect } from "@steamsets/client-ts/funcs/connectionAccountV1ConnectionReconnect.js";
+import { connectionReconnect } from "@steamsets/client-ts/funcs/connectionReconnect.js";
 
 // Use `SteamSetsCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -127,7 +127,7 @@ const steamSets = new SteamSetsCore({
 });
 
 async function run() {
-  const res = await connectionAccountV1ConnectionReconnect(steamSets, {
+  const res = await connectionReconnect(steamSets, {
     code: "123456",
     connectionId: "123456",
   });

package/docs/sdks/{event → events}/README.md

@@ -1,14 +1,14 @@
-# Event
-(*event*)
+# Events
+(*events*)
 
 ## Overview
 
 ### Available Operations
 
-* [adminV1GetEvents](#adminv1getevents)
-* [adminV1UpdateEvent](#adminv1updateevent)
+* [get](#get)
+* [update](#update)
 
-## adminV1GetEvents
+## get
 
 ### Example Usage
 
@@ -20,7 +20,7 @@ const steamSets = new SteamSets({
 });
 
 async function run() {
-  const result = await steamSets.event.adminV1GetEvents();
+  const result = await steamSets.events.get();
 
   // Handle the result
   console.log(result);
@@ -35,7 +35,7 @@ The standalone function version of this method:
 
 ```typescript
 import { SteamSetsCore } from "@steamsets/client-ts/core.js";
-import { eventAdminV1GetEvents } from "@steamsets/client-ts/funcs/eventAdminV1GetEvents.js";
+import { eventsGet } from "@steamsets/client-ts/funcs/eventsGet.js";
 
 // Use `SteamSetsCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -44,7 +44,7 @@ const steamSets = new SteamSetsCore({
 });
 
 async function run() {
-  const res = await eventAdminV1GetEvents(steamSets);
+  const res = await eventsGet(steamSets);
 
   if (!res.ok) {
     throw res.error;
@@ -79,7 +79,7 @@ run();
 | errors.ErrorModel        | 500                      | application/problem+json |
 | errors.SDKError          | 4XX, 5XX                 | \*/\*                    |
 
-## adminV1UpdateEvent
+## update
 
 ### Example Usage
 
@@ -91,7 +91,7 @@ const steamSets = new SteamSets({
 });
 
 async function run() {
-  const result = await steamSets.event.adminV1UpdateEvent({
+  const result = await steamSets.events.update({
     eventId: "evt_123456",
     mappings: [
       {
@@ -114,7 +114,7 @@ The standalone function version of this method:
 
 ```typescript
 import { SteamSetsCore } from "@steamsets/client-ts/core.js";
-import { eventAdminV1UpdateEvent } from "@steamsets/client-ts/funcs/eventAdminV1UpdateEvent.js";
+import { eventsUpdate } from "@steamsets/client-ts/funcs/eventsUpdate.js";
 
 // Use `SteamSetsCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -123,7 +123,7 @@ const steamSets = new SteamSetsCore({
 });
 
 async function run() {
-  const res = await eventAdminV1UpdateEvent(steamSets, {
+  const res = await eventsUpdate(steamSets, {
     eventId: "evt_123456",
     mappings: [
       {

package/docs/sdks/external/README.md

@@ -13,7 +13,7 @@ Any requests here may be accessed by anyone with an API Key.
 * [getFriends](#getfriends)
 * [getInfo](#getinfo)
 * [getLeaderboardHistory](#getleaderboardhistory)
-* [statsV1StatsGet](#statsv1statsget)
+* [get](#get)
 
 ## getApps
 
@@ -447,7 +447,7 @@ run();
 | errors.ErrorModel        | 500                      | application/problem+json |
 | errors.SDKError          | 4XX, 5XX                 | \*/\*                    |
 
-## statsV1StatsGet
+## get
 
 ### Example Usage
 
@@ -459,7 +459,7 @@ const steamSets = new SteamSets({
 });
 
 async function run() {
-  const result = await steamSets.external.statsV1StatsGet();
+  const result = await steamSets.external.get();
 
   // Handle the result
   console.log(result);
@@ -474,7 +474,7 @@ The standalone function version of this method:
 
 ```typescript
 import { SteamSetsCore } from "@steamsets/client-ts/core.js";
-import { externalStatsV1StatsGet } from "@steamsets/client-ts/funcs/externalStatsV1StatsGet.js";
+import { externalGet } from "@steamsets/client-ts/funcs/externalGet.js";
 
 // Use `SteamSetsCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -483,7 +483,7 @@ const steamSets = new SteamSetsCore({
 });
 
 async function run() {
-  const res = await externalStatsV1StatsGet(steamSets);
+  const res = await externalGet(steamSets);
 
   if (!res.ok) {
     throw res.error;

package/docs/sdks/images/README.md

@@ -6,8 +6,8 @@
 ### Available Operations
 
 * [deleteImages](#deleteimages)
-* [accountV1ImagesGet](#accountv1imagesget)
-* [accountV1ImagesUpdate](#accountv1imagesupdate)
+* [get](#get)
+* [update](#update)
 * [uploadImages](#uploadimages)
 
 ## deleteImages
@@ -92,7 +92,7 @@ run();
 | errors.ErrorModel        | 500                      | application/problem+json |
 | errors.SDKError          | 4XX, 5XX                 | \*/\*                    |
 
-## accountV1ImagesGet
+## get
 
 ### Example Usage
 
@@ -104,7 +104,7 @@ const steamSets = new SteamSets({
 });
 
 async function run() {
-  const result = await steamSets.images.accountV1ImagesGet();
+  const result = await steamSets.images.get();
 
   // Handle the result
   console.log(result);
@@ -119,7 +119,7 @@ The standalone function version of this method:
 
 ```typescript
 import { SteamSetsCore } from "@steamsets/client-ts/core.js";
-import { imagesAccountV1ImagesGet } from "@steamsets/client-ts/funcs/imagesAccountV1ImagesGet.js";
+import { imagesGet } from "@steamsets/client-ts/funcs/imagesGet.js";
 
 // Use `SteamSetsCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -128,7 +128,7 @@ const steamSets = new SteamSetsCore({
 });
 
 async function run() {
-  const res = await imagesAccountV1ImagesGet(steamSets);
+  const res = await imagesGet(steamSets);
 
   if (!res.ok) {
     throw res.error;
@@ -162,7 +162,7 @@ run();
 | errors.ErrorModel        | 500                      | application/problem+json |
 | errors.SDKError          | 4XX, 5XX                 | \*/\*                    |
 
-## accountV1ImagesUpdate
+## update
 
 ### Example Usage
 
@@ -174,7 +174,7 @@ const steamSets = new SteamSets({
 });
 
 async function run() {
-  const result = await steamSets.images.accountV1ImagesUpdate({
+  const result = await steamSets.images.update({
     images: [
 
     ],
@@ -193,7 +193,7 @@ The standalone function version of this method:
 
 ```typescript
 import { SteamSetsCore } from "@steamsets/client-ts/core.js";
-import { imagesAccountV1ImagesUpdate } from "@steamsets/client-ts/funcs/imagesAccountV1ImagesUpdate.js";
+import { imagesUpdate } from "@steamsets/client-ts/funcs/imagesUpdate.js";
 
 // Use `SteamSetsCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -202,7 +202,7 @@ const steamSets = new SteamSetsCore({
 });
 
 async function run() {
-  const res = await imagesAccountV1ImagesUpdate(steamSets, {
+  const res = await imagesUpdate(steamSets, {
     images: [
   
     ],