Speakeasy API Client SDK for Python
Project description
speakeasy-client-sdk-python
SDK Installation
pip install speakeasy-client-sdk-python
SDK Example Usage
import speakeasy
from speakeasy.models import operations, shared
s = speakeasy.Speakeasy(
security=shared.Security(
api_key="",
),
)
req = operations.GetApisRequest(
metadata={
"South": [
'Southwest',
],
},
op=operations.GetApisOp(
and_=False,
),
)
res = s.apis.get_apis(req)
if res.apis is not None:
# handle response
pass
Available Resources and Operations
Speakeasy SDK
- validate_api_key - Validate the current api key.
api_endpoints
- 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 workspace
- upsert_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.
plugins
- get_plugins - Get all plugins for the current workspace.
- run_plugin - Run a plugin
- upsert_plugin - Upsert a plugin
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.
Pagination
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
returned response object will have a Next
method that can be called to pull down the next group of results. If the
return value of Next
is None
, then there are no more pages to be fetched.
Here's an example of one such pagination call:
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-2.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c7da535cc7fd96fdc70c5cae229221be2157e48fa013e4c1745e0f340222ac2 |
|
MD5 | 6e75a74d6944d201c0139d2c6a0c2d10 |
|
BLAKE2b-256 | 53e43185f5f10a941f3399fe589713b6dc8579a3eea6b8bd359d135d2c56594f |
Close
Hashes for speakeasy_client_sdk_python-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9708d5e33fa6adfcc1c995652b88e82fbc4b9a0fa39220d18eeee50d850ab5f8 |
|
MD5 | f3aef8f3a4e84b7bf04e9c78ec313119 |
|
BLAKE2b-256 | 73d8234fa9b63d2f21f85a56bc5839be00170e4fb46ff0c949b9248b0af93615 |