Speakeasy API Client SDK for Python
Project description
speakeasy-client-sdk-python
This is the Speakeasy API Client SDK for Python. It is generated from our OpenAPI spec found at https://docs.speakeasyapi.dev/openapi.yaml and used for interacting with the Speakeasy API.
This SDK was generated using Speakeasy's SDK Generator. For more information on how to use the generator to generate your own SDKs, please see the Speakeasy Client SDK Generator Docs.
SDK Installation
pip install speakeasy-client-sdk-python
Example usage
import sdk
from sdk.models import operations, shared
s = sdk.SDK()
s.config_security(
security=shared.Security(
api_key=shared.SchemeAPIKey(
api_key="YOUR_API_KEY" # Replace with your API key from your Speakeasy Workspace
)
)
)
req = operations.GetApisRequest(
query_params=operations.GetApisQueryParams(
metadata={'label': ['1']},
op=operations.GetApisOp(and_=True)
)
)
res = s.apis.get_apis(req)
if res.status_code == 200:
print(res.apis)
else:
print(res.error)
SDK Available Operations
SDK SDK
validate_api_key
- Validate the current api key.
ApiEndpoints
delete_api_endpoint
- Delete an ApiEndpoint.find_api_endpoint
- Find an ApiEndpoint via its displayName.generate_open_api_spec_for_api_endpoint
- Generate an OpenAPI specification for a particular ApiEndpoint.generate_postman_collection_for_api_endpoint
- Generate a Postman collection for a particular ApiEndpoint.get_all_api_endpoints
- Get all Api endpoints for a particular apiID.get_all_for_version_api_endpoints
- Get all ApiEndpoints for a particular apiID and versionID.get_api_endpoint
- Get an ApiEndpoint.upsert_api_endpoint
- Upsert an ApiEndpoint.
Apis
delete_api
- Delete an Api.generate_open_api_spec
- Generate an OpenAPI specification for a particular Api.generate_postman_collection
- Generate a Postman collection for a particular Api.get_all_api_versions
- Get all Api versions for a particular ApiEndpoint.get_apis
- Get a list of Apis for a given workspaceupsert_api
- Upsert an Api
Embeds
get_embed_access_token
- Get an embed access token for the current workspace.get_valid_embed_access_tokens
- Get all valid embed access tokens for the current workspace.revoke_embed_access_token
- Revoke an embed access EmbedToken.
Metadata
delete_version_metadata
- Delete metadata for a particular apiID and versionID.get_version_metadata
- Get all metadata for a particular apiID and versionID.insert_version_metadata
- Insert metadata for a particular apiID and versionID.
Requests
generate_request_postman_collection
- Generate a Postman collection for a particular request.get_request_from_event_log
- Get information about a particular request.query_event_log
- Query the event log to retrieve a list of requests.
Schemas
delete_schema
- Delete a particular schema revision for an Api.download_schema
- Download the latest schema for a particular apiID.download_schema_revision
- Download a particular schema revision for an Api.get_schema
- Get information about the latest schema.get_schema_diff
- Get a diff of two schema revisions for an Api.get_schema_revision
- Get information about a particular schema revision for an Api.get_schemas
- Get information about all schemas associated with a particular apiID.register_schema
- Register a schema.
SDK Generated by Speakeasy
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for speakeasy-client-sdk-python-0.12.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2774265bdbd164f7d155e33f0c3a3f6c8b5c9ef1f231916bae293e4c962fd73a |
|
MD5 | 09c807d16afc7b9a93540a90c627ba30 |
|
BLAKE2b-256 | 76b5670b71fd4bb49322e9016671274343cd29a61607ad95bd194ea441ee09ff |
Close
Hashes for speakeasy_client_sdk_python-0.12.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 714f0ed01a80184449a66a9e2006369a940fd9d94771d5a94e17b94a269f69b4 |
|
MD5 | 2645246aaa850c58592bc8e3d28243bf |
|
BLAKE2b-256 | 93152c0a50e584f36b0d770e8423a0538ac02922591cbcfa8d1a4a795821c2c6 |