ci: regenerated with OpenAPI Doc 0.3.0, Speakeay CLI 1.108.1

Author: speakeasybot

README.md

@@ -126,6 +126,104 @@ return value of `next` is `null`, then there are no more pages to be fetched.
 Here's an example of one such pagination call:
 <!-- End Pagination -->
 
+
+
+<!-- Start Error Handling -->
+# Error Handling
+
+Handling errors in your SDK should largely match your expectations.  All operations return a response object or throw an error.  If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
+
+
+<!-- End Error Handling -->
+
+
+
+<!-- Start Server Selection -->
+# Server Selection
+
+## Select Server by Name
+
+You can override the default server globally by passing a server name to the `server: string` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
+
+| Name | Server | Variables |
+| ----- | ------ | --------- |
+| `prod` | `https://api.prod.speakeasyapi.dev` | None |
+
+For example:
+
+
+```typescript
+import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
+
+(async () => {
+    const sdk = new Speakeasy({
+        security: {
+            apiKey: "",
+        },
+        server: "prod",
+    });
+
+    const res = await sdk.speakeasy.validateApiKey();
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+})();
+
+```
+
+
+## Override Server URL Per-Client
+
+The default server can also be overridden globally by passing a URL to the `serverURL: str` optional parameter when initializing the SDK client instance. For example:
+
+
+```typescript
+import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
+
+(async () => {
+    const sdk = new Speakeasy({
+        security: {
+            apiKey: "",
+        },
+        serverURL: "https://api.prod.speakeasyapi.dev",
+    });
+
+    const res = await sdk.speakeasy.validateApiKey();
+
+    if (res.statusCode == 200) {
+        // handle response
+    }
+})();
+
+```
+<!-- End Server Selection -->
+
+
+
+<!-- Start Custom HTTP Client -->
+# Custom HTTP Client
+
+The Typescript SDK makes API calls using the (axios)[https://axios-http.com/docs/intro] HTTP library.  In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `AxiosInstance` object.
+
+
+For example, you could specify a header for every request that your sdk makes as follows:
+
+```typescript
+from @speakeasy-api/speakeasy-client-sdk-typescript import Speakeasy;
+import axios;
+
+const httpClient = axios.create({
+    headers: {'x-custom-header': 'someValue'}
+})
+
+
+const sdk = new Speakeasy({defaultClient: httpClient});
+```
+
+
+<!-- End Custom HTTP Client -->
+
 <!-- Placeholder for Future Speakeasy SDK Sections -->
 
 

RELEASES.md

@@ -1006,4 +1006,14 @@ Based on:
 ### Generated
 - [typescript v1.62.0] .
 ### Releases
-- [NPM v1.62.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/1.62.0 - .
+- [NPM v1.62.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/1.62.0 - .
+
+## 2023-10-27 00:10:48
+### Changes
+Based on:
+- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
+- Speakeasy CLI 1.108.1 (2.172.4) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v1.62.1] .
+### Releases
+- [NPM v1.62.1] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/1.62.1 - .

docs/sdks/apiendpoints/README.md

@@ -38,6 +38,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -80,6 +81,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -122,6 +124,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -163,6 +166,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -202,6 +206,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     apiID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -242,6 +247,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -283,6 +289,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -332,6 +339,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }

docs/sdks/apis/README.md

@@ -35,6 +35,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -76,6 +77,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -116,6 +118,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -164,6 +167,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     },
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -211,6 +215,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     },
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -261,6 +266,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     apiID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }

docs/sdks/embeds/README.md

@@ -43,6 +43,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     },
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -80,6 +81,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
   const res = await sdk.embeds.getValidEmbedAccessTokens();
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -118,6 +120,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     tokenID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }

docs/sdks/metadata/README.md

@@ -34,6 +34,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -74,6 +75,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -118,6 +120,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }

docs/sdks/plugins/README.md

@@ -29,6 +29,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
 
   const res = await sdk.plugins.getPlugins();
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -79,6 +80,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     pluginID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -121,6 +123,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     workspaceId: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }

docs/sdks/requests/README.md

@@ -32,6 +32,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     requestID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -71,6 +72,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     requestID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -122,6 +124,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     },
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }

docs/sdks/schemas/README.md

@@ -38,6 +38,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -78,6 +79,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -119,6 +121,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -160,6 +163,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -202,6 +206,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -244,6 +249,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -285,6 +291,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }
@@ -332,6 +339,7 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
     versionID: "string",
   });
 
+
   if (res.statusCode == 200) {
     // handle response
   }