@steamsets/client-ts 0.5.5 → 0.7.0

package/README.md

@@ -7,16 +7,6 @@
     </a>
 </div>
 
-
-## 🏗 **Welcome to your new SDK!** 🏗
-
-It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
-- [ ] 🛠 Make your SDK feel handcrafted by [customizing it](https://www.speakeasy.com/docs/customize-sdks)
-- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
-- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasy.com/docs/advanced-setup/publish-sdks)
-- [ ] ✨ When ready to productionize, delete this section from the README
-
-<!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
 The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
@@ -47,6 +37,7 @@ yarn add @steamsets/client-ts zod
 # Note that Yarn does not install peer dependencies automatically. You will need
 # to install zod as shown above.
 ```
+
 <!-- End SDK Installation [installation] -->
 
 <!-- Start SDK Example Usage [usage] -->
@@ -57,18 +48,16 @@ yarn add @steamsets/client-ts zod
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
-const steamSets = new SteamSets({
-    session: "<YOUR_BEARER_TOKEN_HERE>",
-});
+const steamSets = new SteamSets();
 
 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();
@@ -79,6 +68,9 @@ run();
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
+<details open>
+<summary>Available methods</summary>
+
 ### [account](docs/sdks/account/README.md)
 
 * [accountV1ConnectionConnect](docs/sdks/account/README.md#accountv1connectionconnect) - Connect a new Social Provider
@@ -105,6 +97,11 @@ run();
 * [accountV1ConnectionVerifyConnection](docs/sdks/account/README.md#accountv1connectionverifyconnection) - Verify a domain connection only atm
 * [accountV1SettingsVerfyEmail](docs/sdks/account/README.md#accountv1settingsverfyemail) - Verify the email by passing in the code the user should've gotten
 
+### [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
+
 ### [connection](docs/sdks/connection/README.md)
 
 * [accountV1ConnectionConnect](docs/sdks/connection/README.md#accountv1connectionconnect) - Connect a new Social Provider
@@ -112,24 +109,6 @@ run();
 * [accountV1ConnectionUpdateConnection](docs/sdks/connection/README.md#accountv1connectionupdateconnection) - Make a connection visible/invisible
 * [accountV1ConnectionVerifyConnection](docs/sdks/connection/README.md#accountv1connectionverifyconnection) - Verify a domain connection only atm
 
-### [session](docs/sdks/session/README.md)
-
-* [accountV1SessionCreate](docs/sdks/session/README.md#accountv1sessioncreate) - Create a new session for non logged in users
-* [accountV1SessionDelete](docs/sdks/session/README.md#accountv1sessiondelete) - Deletes a session, can also be used to logout
-* [accountV1SessionGet](docs/sdks/session/README.md#accountv1sessionget) - Gets all session data
-* [accountV1SessionLogin](docs/sdks/session/README.md#accountv1sessionlogin) - Logs a user in and creates a new session
-
-### [settings](docs/sdks/settings/README.md)
-
-* [accountV1SettingsDeleteImages](docs/sdks/settings/README.md#accountv1settingsdeleteimages) - Delete mulitple imagest
-* [accountV1SettingsGenerateApiKey](docs/sdks/settings/README.md#accountv1settingsgenerateapikey) - Generate a new API key for the account
-* [accountV1SettingsGet](docs/sdks/settings/README.md#accountv1settingsget) - Gets all settings for the account
-* [accountV1SettingsSendEmailVerification](docs/sdks/settings/README.md#accountv1settingssendemailverification) - Resend the verification code for an email
-* [accountV1SettingsUpdateImage](docs/sdks/settings/README.md#accountv1settingsupdateimage) - Update one of the uploaded images
-* [accountV1SettingsUpdate](docs/sdks/settings/README.md#accountv1settingsupdate) - Update settings for the logged in account
-* [accountV1SettingsUploadImages](docs/sdks/settings/README.md#accountv1settingsuploadimages) - Multi Upload Endpoint for images
-* [accountV1SettingsVerfyEmail](docs/sdks/settings/README.md#accountv1settingsverfyemail) - Verify the email by passing in the code the user should've gotten
-
 ### [data](docs/sdks/data/README.md)
 
 * [accountV1GetApps](docs/sdks/data/README.md#accountv1getapps) - Get Account Apps
@@ -139,6 +118,15 @@ 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
+
+### [liveness](docs/sdks/liveness/README.md)
+
+* [liveness](docs/sdks/liveness/README.md#liveness) - Liveness check
+
+### [location](docs/sdks/location/README.md)
+
+* [location](docs/sdks/location/README.md#location) - Location List
 
 ### [public](docs/sdks/public/README.md)
 
@@ -148,14 +136,28 @@ 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
 
-### [liveness](docs/sdks/liveness/README.md)
+### [session](docs/sdks/session/README.md)
 
-* [liveness](docs/sdks/liveness/README.md#liveness) - Liveness check
+* [accountV1SessionCreate](docs/sdks/session/README.md#accountv1sessioncreate) - Create a new session for non logged in users
+* [accountV1SessionDelete](docs/sdks/session/README.md#accountv1sessiondelete) - Deletes a session, can also be used to logout
+* [accountV1SessionGet](docs/sdks/session/README.md#accountv1sessionget) - Gets all session data
+* [accountV1SessionLogin](docs/sdks/session/README.md#accountv1sessionlogin) - Logs a user in and creates a new session
 
-### [location](docs/sdks/location/README.md)
+### [settings](docs/sdks/settings/README.md)
 
-* [location](docs/sdks/location/README.md#location) - Location List
+* [accountV1SettingsDeleteImages](docs/sdks/settings/README.md#accountv1settingsdeleteimages) - Delete mulitple imagest
+* [accountV1SettingsGenerateApiKey](docs/sdks/settings/README.md#accountv1settingsgenerateapikey) - Generate a new API key for the account
+* [accountV1SettingsGet](docs/sdks/settings/README.md#accountv1settingsget) - Gets all settings for the account
+* [accountV1SettingsSendEmailVerification](docs/sdks/settings/README.md#accountv1settingssendemailverification) - Resend the verification code for an email
+* [accountV1SettingsUpdateImage](docs/sdks/settings/README.md#accountv1settingsupdateimage) - Update one of the uploaded images
+* [accountV1SettingsUpdate](docs/sdks/settings/README.md#accountv1settingsupdate) - Update settings for the logged in account
+* [accountV1SettingsUploadImages](docs/sdks/settings/README.md#accountv1settingsuploadimages) - Multi Upload Endpoint for images
+* [accountV1SettingsVerfyEmail](docs/sdks/settings/README.md#accountv1settingsverfyemail) - Verify the email by passing in the code the user should've gotten
+
+
+</details>
 <!-- End Available Resources and Operations [operations] -->
 
 <!-- Start Retries [retries] -->
@@ -167,32 +169,27 @@ To change the default retry strategy for a single API call, simply provide a ret
 ```typescript
 import { SteamSets } from "@steamsets/client-ts";
 
-const steamSets = new SteamSets({
-    session: "<YOUR_BEARER_TOKEN_HERE>",
-});
+const steamSets = new SteamSets();
 
 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 +201,26 @@ 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,
+  },
 });
 
 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 +243,42 @@ 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>",
-});
+const steamSets = new SteamSets();
 
 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 +302,17 @@ 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,
 });
 
 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 +328,17 @@ 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",
 });
 
 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 +411,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();
@@ -435,11 +430,44 @@ run();
 <!-- End Authentication [security] -->
 
 <!-- Start Special Types [types] -->
-## Special Types
 
+## Special Types
 
 <!-- End Special Types [types] -->
 
+<!-- Start SDK Installation [installation] -->
+## SDK Installation
+
+The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
+
+### NPM
+
+```bash
+npm add @steamsets/client-ts
+```
+
+### PNPM
+
+```bash
+pnpm add @steamsets/client-ts
+```
+
+### Bun
+
+```bash
+bun add @steamsets/client-ts
+```
+
+### Yarn
+
+```bash
+yarn add @steamsets/client-ts zod
+
+# Note that Yarn does not install peer dependencies automatically. You will need
+# to install zod as shown above.
+```
+<!-- End SDK Installation [installation] -->
+
 <!-- Start Requirements [requirements] -->
 ## Requirements
 
@@ -484,6 +512,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 +525,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 +534,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)
@@ -571,7 +603,7 @@ looking for the latest version.
 
 ## Contributions
 
-While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 
-We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. 
+While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation.
+We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
 
 ### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=<no value>&utm_campaign=go)