ci: regenerated with OpenAPI Doc 0.3.0, Speakeasy CLI 1.116.0

Author: speakeasybot

README.md

@@ -46,7 +46,7 @@ if res.classes is not None:
 
 * [validate_api_key](docs/sdks/speakeasy/README.md#validate_api_key) - Validate the current api key.
 
-### [.apis](docs/sdks/apis/README.md)
+### [apis](docs/sdks/apis/README.md)
 
 * [delete_api](docs/sdks/apis/README.md#delete_api) - Delete an Api.
 * [generate_open_api_spec](docs/sdks/apis/README.md#generate_open_api_spec) - Generate an OpenAPI specification for a particular Api.
@@ -55,7 +55,7 @@ if res.classes is not None:
 * [get_apis](docs/sdks/apis/README.md#get_apis) - Get a list of Apis for a given workspace
 * [upsert_api](docs/sdks/apis/README.md#upsert_api) - Upsert an Api
 
-### [.api_endpoints](docs/sdks/apiendpoints/README.md)
+### [api_endpoints](docs/sdks/apiendpoints/README.md)
 
 * [delete_api_endpoint](docs/sdks/apiendpoints/README.md#delete_api_endpoint) - Delete an ApiEndpoint.
 * [find_api_endpoint](docs/sdks/apiendpoints/README.md#find_api_endpoint) - Find an ApiEndpoint via its displayName.
@@ -66,13 +66,13 @@ if res.classes is not None:
 * [get_api_endpoint](docs/sdks/apiendpoints/README.md#get_api_endpoint) - Get an ApiEndpoint.
 * [upsert_api_endpoint](docs/sdks/apiendpoints/README.md#upsert_api_endpoint) - Upsert an ApiEndpoint.
 
-### [.metadata](docs/sdks/metadata/README.md)
+### [metadata](docs/sdks/metadata/README.md)
 
 * [delete_version_metadata](docs/sdks/metadata/README.md#delete_version_metadata) - Delete metadata for a particular apiID and versionID.
 * [get_version_metadata](docs/sdks/metadata/README.md#get_version_metadata) - Get all metadata for a particular apiID and versionID.
 * [insert_version_metadata](docs/sdks/metadata/README.md#insert_version_metadata) - Insert metadata for a particular apiID and versionID.
 
-### [.schemas](docs/sdks/schemas/README.md)
+### [schemas](docs/sdks/schemas/README.md)
 
 * [delete_schema](docs/sdks/schemas/README.md#delete_schema) - Delete a particular schema revision for an Api.
 * [download_schema](docs/sdks/schemas/README.md#download_schema) - Download the latest schema for a particular apiID.
@@ -83,19 +83,19 @@ if res.classes is not None:
 * [get_schemas](docs/sdks/schemas/README.md#get_schemas) - Get information about all schemas associated with a particular apiID.
 * [register_schema](docs/sdks/schemas/README.md#register_schema) - Register a schema.
 
-### [.requests](docs/sdks/requests/README.md)
+### [requests](docs/sdks/requests/README.md)
 
 * [generate_request_postman_collection](docs/sdks/requests/README.md#generate_request_postman_collection) - Generate a Postman collection for a particular request.
 * [get_request_from_event_log](docs/sdks/requests/README.md#get_request_from_event_log) - Get information about a particular request.
 * [query_event_log](docs/sdks/requests/README.md#query_event_log) - Query the event log to retrieve a list of requests.
 
-### [.plugins](docs/sdks/plugins/README.md)
+### [plugins](docs/sdks/plugins/README.md)
 
 * [get_plugins](docs/sdks/plugins/README.md#get_plugins) - Get all plugins for the current workspace.
 * [run_plugin](docs/sdks/plugins/README.md#run_plugin) - Run a plugin
 * [upsert_plugin](docs/sdks/plugins/README.md#upsert_plugin) - Upsert a plugin
 
-### [.embeds](docs/sdks/embeds/README.md)
+### [embeds](docs/sdks/embeds/README.md)
 
 * [get_embed_access_token](docs/sdks/embeds/README.md#get_embed_access_token) - Get an embed access token for the current workspace.
 * [get_valid_embed_access_tokens](docs/sdks/embeds/README.md#get_valid_embed_access_tokens) - Get all valid embed access tokens for the current workspace.
@@ -125,7 +125,38 @@ Here's an example of one such pagination call:
 <!-- Start Error Handling -->
 # Error Handling
 
-Handling errors in your SDK should largely match your expectations.  All operations return a response object or raise an error.  If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
+Handling errors in this SDK should largely match your expectations.  All operations return a response object or raise an error.  If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
+
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |
+
+
+## Example
+
+```python
+import speakeasy
+from speakeasy.models import shared
+
+s = speakeasy.Speakeasy(
+    security=shared.Security(
+        api_key="",
+    ),
+)
+
+
+res = None
+try:
+    res = s.validate_api_key()
+
+except (errors.SDKError) as e:
+    print(e) # handle exception
+
+
+if res.status_code == 200:
+    # handle response
+    pass
+```
 <!-- End Error Handling -->
 
 
@@ -195,7 +226,7 @@ if res.status_code == 200:
 The Python SDK makes API calls using the (requests)[https://pypi.org/project/requests/] 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 `requests.Session` object.
 
 
-For example, you could specify a header for every request that your sdk makes as follows:
+For example, you could specify a header for every request that this sdk makes as follows:
 
 ```python
 import speakeasy
@@ -210,12 +241,11 @@ s = speakeasy.Speakeasy(client: http_client)
 
 
 <!-- Start Authentication -->
-
 # Authentication
 
 ## Per-Client Security Schemes
 
-Your SDK supports the following security scheme globally:
+This SDK supports the following security scheme globally:
 
 | Name      | Type      | Scheme    |
 | --------- | --------- | --------- |

RELEASES.md

@@ -1036,4 +1036,14 @@ Based on:
 ### Generated
 - [python v3.0.0] .
 ### Releases
-- [PyPI v3.0.0] https://pypi.org/project/speakeasy-client-sdk-python/3.0.0 - .
+- [PyPI v3.0.0] https://pypi.org/project/speakeasy-client-sdk-python/3.0.0 - .
+
+## 2023-11-09 00:10:02
+### Changes
+Based on:
+- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
+- Speakeasy CLI 1.116.0 (2.185.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [python v3.1.0] .
+### Releases
+- [PyPI v3.1.0] https://pypi.org/project/speakeasy-client-sdk-python/3.1.0 - .

docs/sdks/apiendpoints/README.md

@@ -1,5 +1,5 @@
 # APIEndpoints
-(*.api_endpoints*)
+(*api_endpoints*)
 
 ## Overview
 
@@ -55,7 +55,11 @@ if res.status_code == 200:
 ### Response
 
 **[operations.DeleteAPIEndpointResponse](../../models/operations/deleteapiendpointresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |
 
 ## find_api_endpoint
 
@@ -97,7 +101,11 @@ if res.api_endpoint is not None:
 ### Response
 
 **[operations.FindAPIEndpointResponse](../../models/operations/findapiendpointresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |
 
 ## generate_open_api_spec_for_api_endpoint
 
@@ -139,7 +147,11 @@ if res.generate_open_api_spec_diff is not None:
 ### Response
 
 **[operations.GenerateOpenAPISpecForAPIEndpointResponse](../../models/operations/generateopenapispecforapiendpointresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |
 
 ## generate_postman_collection_for_api_endpoint
 
@@ -180,7 +192,11 @@ if res.postman_collection is not None:
 ### Response
 
 **[operations.GeneratePostmanCollectionForAPIEndpointResponse](../../models/operations/generatepostmancollectionforapiendpointresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |
 
 ## get_all_api_endpoints
 
@@ -219,7 +235,11 @@ if res.classes is not None:
 ### Response
 
 **[operations.GetAllAPIEndpointsResponse](../../models/operations/getallapiendpointsresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |
 
 ## get_all_for_version_api_endpoints
 
@@ -259,7 +279,11 @@ if res.classes is not None:
 ### Response
 
 **[operations.GetAllForVersionAPIEndpointsResponse](../../models/operations/getallforversionapiendpointsresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |
 
 ## get_api_endpoint
 
@@ -300,7 +324,11 @@ if res.api_endpoint is not None:
 ### Response
 
 **[operations.GetAPIEndpointResponse](../../models/operations/getapiendpointresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |
 
 ## upsert_api_endpoint
 
@@ -349,4 +377,8 @@ if res.api_endpoint is not None:
 ### Response
 
 **[operations.UpsertAPIEndpointResponse](../../models/operations/upsertapiendpointresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |

docs/sdks/apis/README.md

@@ -1,5 +1,5 @@
 # Apis
-(*.apis*)
+(*apis*)
 
 ## Overview
 
@@ -52,7 +52,11 @@ if res.status_code == 200:
 ### Response
 
 **[operations.DeleteAPIResponse](../../models/operations/deleteapiresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |
 
 ## generate_open_api_spec
 
@@ -93,7 +97,11 @@ if res.generate_open_api_spec_diff is not None:
 ### Response
 
 **[operations.GenerateOpenAPISpecResponse](../../models/operations/generateopenapispecresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |
 
 ## generate_postman_collection
 
@@ -133,7 +141,11 @@ if res.postman_collection is not None:
 ### Response
 
 **[operations.GeneratePostmanCollectionResponse](../../models/operations/generatepostmancollectionresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |
 
 ## get_all_api_versions
 
@@ -181,7 +193,11 @@ if res.classes is not None:
 ### Response
 
 **[operations.GetAllAPIVersionsResponse](../../models/operations/getallapiversionsresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |
 
 ## get_apis
 
@@ -228,7 +244,11 @@ if res.classes is not None:
 ### Response
 
 **[operations.GetApisResponse](../../models/operations/getapisresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |
 
 ## upsert_api
 
@@ -278,4 +298,8 @@ if res.api is not None:
 ### Response
 
 **[operations.UpsertAPIResponse](../../models/operations/upsertapiresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |

docs/sdks/embeds/README.md

@@ -1,5 +1,5 @@
 # Embeds
-(*.embeds*)
+(*embeds*)
 
 ## Overview
 
@@ -60,7 +60,11 @@ if res.embed_access_token_response is not None:
 ### Response
 
 **[operations.GetEmbedAccessTokenResponse](../../models/operations/getembedaccesstokenresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |
 
 ## get_valid_embed_access_tokens
 
@@ -90,7 +94,11 @@ if res.classes is not None:
 ### Response
 
 **[operations.GetValidEmbedAccessTokensResponse](../../models/operations/getvalidembedaccesstokensresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |
 
 ## revoke_embed_access_token
 
@@ -129,4 +137,8 @@ if res.status_code == 200:
 ### Response
 
 **[operations.RevokeEmbedAccessTokenResponse](../../models/operations/revokeembedaccesstokenresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |

docs/sdks/metadata/README.md

@@ -1,5 +1,5 @@
 # Metadata
-(*.metadata*)
+(*metadata*)
 
 ## Overview
 
@@ -51,7 +51,11 @@ if res.status_code == 200:
 ### Response
 
 **[operations.DeleteVersionMetadataResponse](../../models/operations/deleteversionmetadataresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |
 
 ## get_version_metadata
 
@@ -91,7 +95,11 @@ if res.classes is not None:
 ### Response
 
 **[operations.GetVersionMetadataResponse](../../models/operations/getversionmetadataresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |
 
 ## insert_version_metadata
 
@@ -135,4 +143,8 @@ if res.version_metadata is not None:
 ### Response
 
 **[operations.InsertVersionMetadataResponse](../../models/operations/insertversionmetadataresponse.md)**
+### Errors
 
+| Error Object    | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.SDKError | 400-600         | */*             |