@steamsets/client-ts 0.5.5 → 0.6.0

package/README.md

@@ -58,17 +58,17 @@ yarn add @steamsets/client-ts zod
 import { SteamSets } from "@steamsets/client-ts";
 
 const steamSets = new SteamSets({
-    session: "<YOUR_BEARER_TOKEN_HERE>",
+  session: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await steamSets.account.accountV1ConnectionConnect({
-        code: "123456",
-        provider: "discord",
-    });
+  const result = await steamSets.account.accountV1ConnectionConnect({
+    code: "123456",
+    provider: "discord",
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -139,6 +139,7 @@ run();
 * [accountV1GetInfo](docs/sdks/data/README.md#accountv1getinfo) - Get Account Info
 * [accountV1GetLeaderboardHistory](docs/sdks/data/README.md#accountv1getleaderboardhistory) - Get Account Leaderboard History
 * [accountV1GetStaff](docs/sdks/data/README.md#accountv1getstaff) - Get Staff Members and their info
+* [accountV1Queue](docs/sdks/data/README.md#accountv1queue) - Queue a app for processing
 
 ### [public](docs/sdks/public/README.md)
 
@@ -148,6 +149,12 @@ run();
 * [accountV1GetFriends](docs/sdks/public/README.md#accountv1getfriends) - Get Account Friends
 * [accountV1GetInfo](docs/sdks/public/README.md#accountv1getinfo) - Get Account Info
 * [accountV1GetLeaderboardHistory](docs/sdks/public/README.md#accountv1getleaderboardhistory) - Get Account Leaderboard History
+* [accountV1Queue](docs/sdks/public/README.md#accountv1queue) - Queue a app for processing
+
+### [app](docs/sdks/app/README.md)
+
+* [appV1Get](docs/sdks/app/README.md#appv1get) - Get details about an app
+* [accountV1Queue](docs/sdks/app/README.md#accountv1queue) - Queue a app for processing
 
 ### [liveness](docs/sdks/liveness/README.md)
 
@@ -168,31 +175,28 @@ To change the default retry strategy for a single API call, simply provide a ret
 import { SteamSets } from "@steamsets/client-ts";
 
 const steamSets = new SteamSets({
-    session: "<YOUR_BEARER_TOKEN_HERE>",
+  session: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await steamSets.account.accountV1ConnectionConnect(
-        {
-            code: "123456",
-            provider: "discord",
-        },
-        {
-            retries: {
-                strategy: "backoff",
-                backoff: {
-                    initialInterval: 1,
-                    maxInterval: 50,
-                    exponent: 1.1,
-                    maxElapsedTime: 100,
-                },
-                retryConnectionErrors: false,
-            },
-        }
-    );
+  const result = await steamSets.account.accountV1ConnectionConnect({
+    code: "123456",
+    provider: "discord",
+  }, {
+    retries: {
+      strategy: "backoff",
+      backoff: {
+        initialInterval: 1,
+        maxInterval: 50,
+        exponent: 1.1,
+        maxElapsedTime: 100,
+      },
+      retryConnectionErrors: false,
+    },
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -204,27 +208,27 @@ If you'd like to override the default retry strategy for all operations that sup
 import { SteamSets } from "@steamsets/client-ts";
 
 const steamSets = new SteamSets({
-    retryConfig: {
-        strategy: "backoff",
-        backoff: {
-            initialInterval: 1,
-            maxInterval: 50,
-            exponent: 1.1,
-            maxElapsedTime: 100,
-        },
-        retryConnectionErrors: false,
+  retryConfig: {
+    strategy: "backoff",
+    backoff: {
+      initialInterval: 1,
+      maxInterval: 50,
+      exponent: 1.1,
+      maxElapsedTime: 100,
     },
-    session: "<YOUR_BEARER_TOKEN_HERE>",
+    retryConnectionErrors: false,
+  },
+  session: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await steamSets.account.accountV1ConnectionConnect({
-        code: "123456",
-        provider: "discord",
-    });
+  const result = await steamSets.account.accountV1ConnectionConnect({
+    code: "123456",
+    provider: "discord",
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -247,41 +251,44 @@ Validation errors can also occur when either method arguments or data returned f
 
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
-import { ErrorModel, SDKValidationError } from "@steamsets/client-ts/models/errors";
+import {
+  ErrorModel,
+  SDKValidationError,
+} from "@steamsets/client-ts/models/errors";
 
 const steamSets = new SteamSets({
-    session: "<YOUR_BEARER_TOKEN_HERE>",
+  session: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    let result;
-    try {
-        result = await steamSets.account.accountV1ConnectionConnect({
-            code: "123456",
-            provider: "discord",
-        });
-    } catch (err) {
-        switch (true) {
-            case err instanceof SDKValidationError: {
-                // Validation errors can be pretty-printed
-                console.error(err.pretty());
-                // Raw value may also be inspected
-                console.error(err.rawValue);
-                return;
-            }
-            case err instanceof ErrorModel: {
-                // Handle err.data$: ErrorModelData
-                console.error(err);
-                return;
-            }
-            default: {
-                throw err;
-            }
-        }
-    }
+  let result;
+  try {
+    result = await steamSets.account.accountV1ConnectionConnect({
+      code: "123456",
+      provider: "discord",
+    });
 
     // Handle the result
     console.log(result);
+  } catch (err) {
+    switch (true) {
+      case (err instanceof SDKValidationError): {
+        // Validation errors can be pretty-printed
+        console.error(err.pretty());
+        // Raw value may also be inspected
+        console.error(err.rawValue);
+        return;
+      }
+      case (err instanceof ErrorModel): {
+        // Handle err.data$: ErrorModelData
+        console.error(err);
+        return;
+      }
+      default: {
+        throw err;
+      }
+    }
+  }
 }
 
 run();
@@ -305,18 +312,18 @@ You can override the default server globally by passing a server index to the `s
 import { SteamSets } from "@steamsets/client-ts";
 
 const steamSets = new SteamSets({
-    serverIdx: 1,
-    session: "<YOUR_BEARER_TOKEN_HERE>",
+  serverIdx: 1,
+  session: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await steamSets.account.accountV1ConnectionConnect({
-        code: "123456",
-        provider: "discord",
-    });
+  const result = await steamSets.account.accountV1ConnectionConnect({
+    code: "123456",
+    provider: "discord",
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -332,18 +339,18 @@ The default server can also be overridden globally by passing a URL to the `serv
 import { SteamSets } from "@steamsets/client-ts";
 
 const steamSets = new SteamSets({
-    serverURL: "https://api.steamsets.com",
-    session: "<YOUR_BEARER_TOKEN_HERE>",
+  serverURL: "https://api.steamsets.com",
+  session: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await steamSets.account.accountV1ConnectionConnect({
-        code: "123456",
-        provider: "discord",
-    });
+  const result = await steamSets.account.accountV1ConnectionConnect({
+    code: "123456",
+    provider: "discord",
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -416,17 +423,17 @@ To authenticate with the API the `session` parameter must be set when initializi
 import { SteamSets } from "@steamsets/client-ts";
 
 const steamSets = new SteamSets({
-    session: "<YOUR_BEARER_TOKEN_HERE>",
+  session: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await steamSets.account.accountV1ConnectionConnect({
-        code: "123456",
-        provider: "discord",
-    });
+  const result = await steamSets.account.accountV1ConnectionConnect({
+    code: "123456",
+    provider: "discord",
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -484,6 +491,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [accountAccountV1SettingsUpdate](docs/sdks/account/README.md#accountv1settingsupdate)
 - [accountAccountV1SettingsUploadImages](docs/sdks/account/README.md#accountv1settingsuploadimages)
 - [accountAccountV1SettingsVerfyEmail](docs/sdks/account/README.md#accountv1settingsverfyemail)
+- [appAccountV1Queue](docs/sdks/app/README.md#accountv1queue)
+- [appAppV1Get](docs/sdks/app/README.md#appv1get)
 - [connectionAccountV1ConnectionConnect](docs/sdks/connection/README.md#accountv1connectionconnect)
 - [connectionAccountV1ConnectionDeleteConnection](docs/sdks/connection/README.md#accountv1connectiondeleteconnection)
 - [connectionAccountV1ConnectionUpdateConnection](docs/sdks/connection/README.md#accountv1connectionupdateconnection)
@@ -495,6 +504,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [dataAccountV1GetInfo](docs/sdks/data/README.md#accountv1getinfo)
 - [dataAccountV1GetLeaderboardHistory](docs/sdks/data/README.md#accountv1getleaderboardhistory)
 - [dataAccountV1GetStaff](docs/sdks/data/README.md#accountv1getstaff)
+- [dataAccountV1Queue](docs/sdks/data/README.md#accountv1queue)
 - [livenessLiveness](docs/sdks/liveness/README.md#liveness)
 - [locationLocation](docs/sdks/location/README.md#location)
 - [publicAccountV1GetApps](docs/sdks/public/README.md#accountv1getapps)
@@ -503,6 +513,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [publicAccountV1GetFriends](docs/sdks/public/README.md#accountv1getfriends)
 - [publicAccountV1GetInfo](docs/sdks/public/README.md#accountv1getinfo)
 - [publicAccountV1GetLeaderboardHistory](docs/sdks/public/README.md#accountv1getleaderboardhistory)
+- [publicAccountV1Queue](docs/sdks/public/README.md#accountv1queue)
 - [sessionAccountV1SessionCreate](docs/sdks/session/README.md#accountv1sessioncreate)
 - [sessionAccountV1SessionDelete](docs/sdks/session/README.md#accountv1sessiondelete)
 - [sessionAccountV1SessionGet](docs/sdks/session/README.md#accountv1sessionget)

package/docs/sdks/account/README.md

@@ -49,7 +49,7 @@ async function run() {
     code: "123456",
     provider: "discord",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -126,7 +126,7 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.account.accountV1SessionCreate({});
-
+  
   // Handle the result
   console.log(result)
 }
@@ -202,7 +202,7 @@ async function run() {
   const result = await steamSets.account.accountV1ConnectionDeleteConnection({
     connectionId: "123456",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -282,7 +282,7 @@ async function run() {
       "<value>",
     ],
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -362,7 +362,7 @@ async function run() {
   const result = await steamSets.account.accountV1SessionDelete({
     sessionId: "123456",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -438,7 +438,7 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.account.accountV1SettingsGenerateApiKey();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -513,7 +513,7 @@ async function run() {
   const result = await steamSets.account.accountV1GetApps({
     accountSearch: {},
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -591,7 +591,7 @@ async function run() {
   const result = await steamSets.account.accountV1GetBadges({
     accountSearch: {},
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -669,7 +669,7 @@ async function run() {
   const result = await steamSets.account.accountV1GetDataPoints({
     accountSearch: {},
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -747,7 +747,7 @@ async function run() {
   const result = await steamSets.account.accountV1GetFriends({
     accountSearch: {},
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -823,7 +823,7 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.account.accountV1GetInfo({});
-
+  
   // Handle the result
   console.log(result)
 }
@@ -899,7 +899,7 @@ async function run() {
   const result = await steamSets.account.accountV1GetLeaderboardHistory({
     accountSearch: {},
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -975,7 +975,7 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.account.accountV1SessionGet();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -1048,7 +1048,7 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.account.accountV1SettingsGet();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -1121,7 +1121,7 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.account.accountV1GetStaff();
-
+  
   // Handle the result
   console.log(result)
 }
@@ -1207,7 +1207,7 @@ async function run() {
       openidSigned: "123456",
     },
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -1294,7 +1294,7 @@ const steamSets = new SteamSets({
 
 async function run() {
   const result = await steamSets.account.accountV1SettingsSendEmailVerification({});
-
+  
   // Handle the result
   console.log(result)
 }
@@ -1371,7 +1371,7 @@ async function run() {
     connectionId: "123456",
     hidden: true,
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -1451,7 +1451,7 @@ async function run() {
     active: true,
     imageId: "123456",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -1544,7 +1544,7 @@ async function run() {
       vanity: "flo",
     },
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -1641,7 +1641,7 @@ async function run() {
       },
     ],
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -1724,7 +1724,7 @@ async function run() {
   const result = await steamSets.account.accountV1ConnectionVerifyConnection({
     connectionId: "123456",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -1802,7 +1802,7 @@ async function run() {
   const result = await steamSets.account.accountV1SettingsVerfyEmail({
     code: "123456",
   });
-
+  
   // Handle the result
   console.log(result)
 }

package/docs/sdks/app/README.md

@@ -0,0 +1,170 @@
+# App
+(*app*)
+
+## Overview
+
+App related operations
+
+### Available Operations
+
+* [appV1Get](#appv1get) - Get details about an app
+* [accountV1Queue](#accountv1queue) - Queue a app for processing
+
+## appV1Get
+
+Get details about an app
+
+### 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.app.appV1Get({
+    appId: 123456,
+  });
+  
+  // 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 { appAppV1Get } from "@steamsets/client-ts/funcs/appAppV1Get.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 appAppV1Get(steamSets, {
+    appId: 123456,
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result)
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.V1AppRequestBody](../../models/components/v1apprequestbody.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.AppV1GetResponse](../../models/operations/appv1getresponse.md)\>**
+
+### Errors
+
+| Error Object             | Status Code              | Content Type             |
+| ------------------------ | ------------------------ | ------------------------ |
+| errors.ErrorModel        | 404,422,500              | application/problem+json |
+| errors.SDKError          | 4xx-5xx                  | */*                      |
+
+
+## accountV1Queue
+
+Queue a app for processing
+
+### 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.app.accountV1Queue({
+    appSearch: {
+      id: 730,
+    },
+  });
+  
+  // 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 { appAccountV1Queue } from "@steamsets/client-ts/funcs/appAccountV1Queue.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 appAccountV1Queue(steamSets, {
+    appSearch: {
+      id: 730,
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result)
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.AccountV1QueueRequest](../../models/operations/accountv1queuerequest.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.AccountV1QueueResponse](../../models/operations/accountv1queueresponse.md)\>**
+
+### Errors
+
+| Error Object             | Status Code              | Content Type             |
+| ------------------------ | ------------------------ | ------------------------ |
+| errors.ErrorModel        | 400,422,429,500          | application/problem+json |
+| errors.SDKError          | 4xx-5xx                  | */*                      |