ci: regenerated with OpenAPI Doc 0.3.0, Speakeay CLI 1.13.0

Author: speakeasybot

RELEASES.md

@@ -230,4 +230,12 @@ Based on:
 - OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
 - Speakeasy CLI 1.12.4 https://github.com/speakeasy-api/speakeasy
 ### Releases
-- [PyPI v1.11.2] https://pypi.org/project/speakeasy-client-sdk-python/1.11.2 - .
+- [PyPI v1.11.2] https://pypi.org/project/speakeasy-client-sdk-python/1.11.2 - .
+
+## 2023-03-22 00:08:40
+### Changes
+Based on:
+- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
+- Speakeasy CLI 1.13.0 https://github.com/speakeasy-api/speakeasy
+### Releases
+- [PyPI v1.12.0] https://pypi.org/project/speakeasy-client-sdk-python/1.12.0 - .

gen.yaml

@@ -2,13 +2,13 @@ configVersion: 1.0.0
 management:
   docChecksum: 2bba3b8f9d211b02569b3f9aff0d34b4
   docVersion: 0.3.0
-  speakeasyVersion: 1.12.4
+  speakeasyVersion: 1.13.0
 generation:
   telemetryEnabled: true
   sdkClassName: speakeasy
   sdkFlattening: true
 python:
-  version: 1.11.2
+  version: 1.12.0
   author: Speakeasy
   description: Speakeasy API Client SDK for Python
   packageName: speakeasy-client-sdk-python

setup.py

@@ -1,3 +1,5 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+
 import setuptools
 
 try:
@@ -8,7 +10,7 @@
 
 setuptools.setup(
     name="speakeasy-client-sdk-python",
-    version="1.11.2",
+    version="1.12.0",
     author="Speakeasy",
     description="Speakeasy API Client SDK for Python",
     long_description=long_description,

src/speakeasy/__init__.py

@@ -1 +1,3 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+
 from .sdk import *

src/speakeasy/apiendpoints.py

@@ -1,9 +1,12 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+
 import requests as requests_http
 from . import utils
 from speakeasy.models import operations, shared
 from typing import Optional
 
 class APIEndpoints:
+    r"""REST APIs for managing ApiEndpoint entities"""
     _client: requests_http.Session
     _security_client: requests_http.Session
     _server_url: str
@@ -23,7 +26,6 @@ def delete_api_endpoint(self, request: operations.DeleteAPIEndpointRequest) -> o
         r"""Delete an ApiEndpoint.
         Delete an ApiEndpoint. This will also delete all associated Request Logs (if using a Postgres datastore).
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.DeleteAPIEndpointRequest, base_url, '/v1/apis/{apiID}/version/{versionID}/api_endpoints/{apiEndpointID}', request)
@@ -52,7 +54,6 @@ def find_api_endpoint(self, request: operations.FindAPIEndpointRequest) -> opera
         Find an ApiEndpoint via its displayName (set by operationId from a registered OpenAPI schema).
         This is useful for finding the ID of an ApiEndpoint to use in the /v1/apis/{apiID}/version/{versionID}/api_endpoints/{apiEndpointID} endpoints.
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.FindAPIEndpointRequest, base_url, '/v1/apis/{apiID}/version/{versionID}/api_endpoints/find/{displayName}', request)
@@ -83,7 +84,6 @@ def generate_open_api_spec_for_api_endpoint(self, request: operations.GenerateOp
         This endpoint will generate a new operation in any registered OpenAPI document if the operation does not already exist in the document.
         Returns the original document and the newly generated document allowing a diff to be performed to see what has changed.
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.GenerateOpenAPISpecForAPIEndpointRequest, base_url, '/v1/apis/{apiID}/version/{versionID}/api_endpoints/{apiEndpointID}/generate/openapi', request)
@@ -113,7 +113,6 @@ def generate_postman_collection_for_api_endpoint(self, request: operations.Gener
         r"""Generate a Postman collection for a particular ApiEndpoint.
         Generates a postman collection that allows the endpoint to be called from postman variables produced for any path/query/header parameters included in the OpenAPI document.
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.GeneratePostmanCollectionForAPIEndpointRequest, base_url, '/v1/apis/{apiID}/version/{versionID}/api_endpoints/{apiEndpointID}/generate/postman', request)
@@ -139,9 +138,7 @@ def generate_postman_collection_for_api_endpoint(self, request: operations.Gener
         return res
 
     def get_all_api_endpoints(self, request: operations.GetAllAPIEndpointsRequest) -> operations.GetAllAPIEndpointsResponse:
-        r"""Get all Api endpoints for a particular apiID.
-        """
-        
+        r"""Get all Api endpoints for a particular apiID."""
         base_url = self._server_url
 
         url = utils.generate_url(operations.GetAllAPIEndpointsRequest, base_url, '/v1/apis/{apiID}/api_endpoints', request)
@@ -168,9 +165,7 @@ def get_all_api_endpoints(self, request: operations.GetAllAPIEndpointsRequest) -
         return res
 
     def get_all_for_version_api_endpoints(self, request: operations.GetAllForVersionAPIEndpointsRequest) -> operations.GetAllForVersionAPIEndpointsResponse:
-        r"""Get all ApiEndpoints for a particular apiID and versionID.
-        """
-        
+        r"""Get all ApiEndpoints for a particular apiID and versionID."""
         base_url = self._server_url
 
         url = utils.generate_url(operations.GetAllForVersionAPIEndpointsRequest, base_url, '/v1/apis/{apiID}/version/{versionID}/api_endpoints', request)
@@ -197,9 +192,7 @@ def get_all_for_version_api_endpoints(self, request: operations.GetAllForVersion
         return res
 
     def get_api_endpoint(self, request: operations.GetAPIEndpointRequest) -> operations.GetAPIEndpointResponse:
-        r"""Get an ApiEndpoint.
-        """
-        
+        r"""Get an ApiEndpoint."""
         base_url = self._server_url
 
         url = utils.generate_url(operations.GetAPIEndpointRequest, base_url, '/v1/apis/{apiID}/version/{versionID}/api_endpoints/{apiEndpointID}', request)
@@ -229,7 +222,6 @@ def upsert_api_endpoint(self, request: operations.UpsertAPIEndpointRequest) -> o
         r"""Upsert an ApiEndpoint.
         Upsert an ApiEndpoint. If the ApiEndpoint does not exist it will be created, otherwise it will be updated.
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.UpsertAPIEndpointRequest, base_url, '/v1/apis/{apiID}/version/{versionID}/api_endpoints/{apiEndpointID}', request)

src/speakeasy/apis.py

@@ -1,9 +1,12 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+
 import requests as requests_http
 from . import utils
 from speakeasy.models import operations, shared
 from typing import Optional
 
 class Apis:
+    r"""REST APIs for managing Api entities"""
     _client: requests_http.Session
     _security_client: requests_http.Session
     _server_url: str
@@ -23,7 +26,6 @@ def delete_api(self, request: operations.DeleteAPIRequest) -> operations.DeleteA
         r"""Delete an Api.
         Delete a particular version of an Api. The will also delete all associated ApiEndpoints, Metadata, Schemas & Request Logs (if using a Postgres datastore).
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.DeleteAPIRequest, base_url, '/v1/apis/{apiID}/version/{versionID}', request)
@@ -52,7 +54,6 @@ def generate_open_api_spec(self, request: operations.GenerateOpenAPISpecRequest)
         This endpoint will generate any missing operations in any registered OpenAPI document if the operation does not already exist in the document.
         Returns the original document and the newly generated document allowing a diff to be performed to see what has changed.
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.GenerateOpenAPISpecRequest, base_url, '/v1/apis/{apiID}/version/{versionID}/generate/openapi', request)
@@ -82,7 +83,6 @@ def generate_postman_collection(self, request: operations.GeneratePostmanCollect
         r"""Generate a Postman collection for a particular Api.
         Generates a postman collection containing all endpoints for a particular API. Includes variables produced for any path/query/header parameters included in the OpenAPI document.
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.GeneratePostmanCollectionRequest, base_url, '/v1/apis/{apiID}/version/{versionID}/generate/postman', request)
@@ -112,7 +112,6 @@ def get_all_api_versions(self, request: operations.GetAllAPIVersionsRequest) ->
         Get all Api versions for a particular ApiEndpoint.
         Supports filtering the versions based on metadata attributes.
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.GetAllAPIVersionsRequest, base_url, '/v1/apis/{apiID}', request)
@@ -144,7 +143,6 @@ def get_apis(self, request: operations.GetApisRequest) -> operations.GetApisResp
         Get a list of all Apis and their versions for a given workspace.
         Supports filtering the APIs based on metadata attributes.
         """
-        
         base_url = self._server_url
 
         url = base_url.removesuffix('/') + '/v1/apis'
@@ -176,7 +174,6 @@ def upsert_api(self, request: operations.UpsertAPIRequest) -> operations.UpsertA
         Upsert an Api. If the Api does not exist, it will be created.
         If the Api exists, it will be updated.
         """
-        
         base_url = self._server_url
 
         url = utils.generate_url(operations.UpsertAPIRequest, base_url, '/v1/apis/{apiID}', request)

src/speakeasy/embeds.py

@@ -1,9 +1,12 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+
 import requests as requests_http
 from . import utils
 from speakeasy.models import operations, shared
 from typing import Optional
 
 class Embeds:
+    r"""REST APIs for managing embeds"""
     _client: requests_http.Session
     _security_client: requests_http.Session
     _server_url: str
@@ -24,7 +27,6 @@ def get_embed_access_token(self, request: operations.GetEmbedAccessTokenRequest)
         Returns an embed access token for the current workspace. This can be used to authenticate access to externally embedded content.
         Filters can be applied allowing views to be filtered to things like particular customerIds.
         """
-        
         base_url = self._server_url
 
         url = base_url.removesuffix('/') + '/v1/workspace/embed-access-token'
@@ -52,9 +54,7 @@ def get_embed_access_token(self, request: operations.GetEmbedAccessTokenRequest)
         return res
 
     def get_valid_embed_access_tokens(self) -> operations.GetValidEmbedAccessTokensResponse:
-        r"""Get all valid embed access tokens for the current workspace.
-        """
-        
+        r"""Get all valid embed access tokens for the current workspace."""
         base_url = self._server_url
 
         url = base_url.removesuffix('/') + '/v1/workspace/embed-access-tokens/valid'
@@ -81,9 +81,7 @@ def get_valid_embed_access_tokens(self) -> operations.GetValidEmbedAccessTokensR
         return res
 
     def revoke_embed_access_token(self, request: operations.RevokeEmbedAccessTokenRequest) -> operations.RevokeEmbedAccessTokenResponse:
-        r"""Revoke an embed access EmbedToken.
-        """
-        
+        r"""Revoke an embed access EmbedToken."""
         base_url = self._server_url
 
         url = utils.generate_url(operations.RevokeEmbedAccessTokenRequest, base_url, '/v1/workspace/embed-access-tokens/{tokenID}', request)

src/speakeasy/metadata.py

@@ -1,9 +1,12 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+
 import requests as requests_http
 from . import utils
 from speakeasy.models import operations, shared
 from typing import Optional
 
 class Metadata:
+    r"""REST APIs for managing Version Metadata entities"""
     _client: requests_http.Session
     _security_client: requests_http.Session
     _server_url: str
@@ -20,9 +23,7 @@ def __init__(self, client: requests_http.Session, security_client: requests_http
         self._gen_version = gen_version
 
     def delete_version_metadata(self, request: operations.DeleteVersionMetadataRequest) -> operations.DeleteVersionMetadataResponse:
-        r"""Delete metadata for a particular apiID and versionID.
-        """
-        
+        r"""Delete metadata for a particular apiID and versionID."""
         base_url = self._server_url
 
         url = utils.generate_url(operations.DeleteVersionMetadataRequest, base_url, '/v1/apis/{apiID}/version/{versionID}/metadata/{metaKey}/{metaValue}', request)
@@ -47,9 +48,7 @@ def delete_version_metadata(self, request: operations.DeleteVersionMetadataReque
         return res
 
     def get_version_metadata(self, request: operations.GetVersionMetadataRequest) -> operations.GetVersionMetadataResponse:
-        r"""Get all metadata for a particular apiID and versionID.
-        """
-        
+        r"""Get all metadata for a particular apiID and versionID."""
         base_url = self._server_url
 
         url = utils.generate_url(operations.GetVersionMetadataRequest, base_url, '/v1/apis/{apiID}/version/{versionID}/metadata', request)
@@ -76,9 +75,7 @@ def get_version_metadata(self, request: operations.GetVersionMetadataRequest) ->
         return res
 
     def insert_version_metadata(self, request: operations.InsertVersionMetadataRequest) -> operations.InsertVersionMetadataResponse:
-        r"""Insert metadata for a particular apiID and versionID.
-        """
-        
+        r"""Insert metadata for a particular apiID and versionID."""
         base_url = self._server_url
 
         url = utils.generate_url(operations.InsertVersionMetadataRequest, base_url, '/v1/apis/{apiID}/version/{versionID}/metadata', request)

src/speakeasy/models/__init__.py

@@ -0,0 +1,2 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+

src/speakeasy/models/operations/__init__.py

@@ -1,3 +1,5 @@
+"""Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT."""
+
 from .deleteapi import *
 from .deleteapiendpoint import *
 from .deleteschema import *