You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
*[deleteApiEndpoint](docs/sdks/apiendpoints/README.md#deleteapiendpoint) - Delete an ApiEndpoint.
58
-
*[findApiEndpoint](docs/sdks/apiendpoints/README.md#findapiendpoint) - Find an ApiEndpoint via its displayName.
59
-
*[generateOpenApiSpecForApiEndpoint](docs/sdks/apiendpoints/README.md#generateopenapispecforapiendpoint) - Generate an OpenAPI specification for a particular ApiEndpoint.
60
-
*[generatePostmanCollectionForApiEndpoint](docs/sdks/apiendpoints/README.md#generatepostmancollectionforapiendpoint) - Generate a Postman collection for a particular ApiEndpoint.
61
-
*[getAllApiEndpoints](docs/sdks/apiendpoints/README.md#getallapiendpoints) - Get all Api endpoints for a particular apiID.
62
-
*[getAllForVersionApiEndpoints](docs/sdks/apiendpoints/README.md#getallforversionapiendpoints) - Get all ApiEndpoints for a particular apiID and versionID.
63
-
*[getApiEndpoint](docs/sdks/apiendpoints/README.md#getapiendpoint) - Get an ApiEndpoint.
64
-
*[upsertApiEndpoint](docs/sdks/apiendpoints/README.md#upsertapiendpoint) - Upsert an ApiEndpoint.
65
-
66
-
### [apis](docs/sdks/apis/README.md)
55
+
### [.apis](docs/sdks/apis/README.md)
67
56
68
57
*[deleteApi](docs/sdks/apis/README.md#deleteapi) - Delete an Api.
69
58
*[generateOpenApiSpec](docs/sdks/apis/README.md#generateopenapispec) - Generate an OpenAPI specification for a particular Api.
@@ -72,31 +61,24 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
72
61
*[getApis](docs/sdks/apis/README.md#getapis) - Get a list of Apis for a given workspace
73
62
*[upsertApi](docs/sdks/apis/README.md#upsertapi) - Upsert an Api
*[getEmbedAccessToken](docs/sdks/embeds/README.md#getembedaccesstoken) - Get an embed access token for the current workspace.
78
-
*[getValidEmbedAccessTokens](docs/sdks/embeds/README.md#getvalidembedaccesstokens) - Get all valid embed access tokens for the current workspace.
79
-
*[revokeEmbedAccessToken](docs/sdks/embeds/README.md#revokeembedaccesstoken) - Revoke an embed access EmbedToken.
66
+
*[deleteApiEndpoint](docs/sdks/apiendpoints/README.md#deleteapiendpoint) - Delete an ApiEndpoint.
67
+
*[findApiEndpoint](docs/sdks/apiendpoints/README.md#findapiendpoint) - Find an ApiEndpoint via its displayName.
68
+
*[generateOpenApiSpecForApiEndpoint](docs/sdks/apiendpoints/README.md#generateopenapispecforapiendpoint) - Generate an OpenAPI specification for a particular ApiEndpoint.
69
+
*[generatePostmanCollectionForApiEndpoint](docs/sdks/apiendpoints/README.md#generatepostmancollectionforapiendpoint) - Generate a Postman collection for a particular ApiEndpoint.
70
+
*[getAllApiEndpoints](docs/sdks/apiendpoints/README.md#getallapiendpoints) - Get all Api endpoints for a particular apiID.
71
+
*[getAllForVersionApiEndpoints](docs/sdks/apiendpoints/README.md#getallforversionapiendpoints) - Get all ApiEndpoints for a particular apiID and versionID.
72
+
*[getApiEndpoint](docs/sdks/apiendpoints/README.md#getapiendpoint) - Get an ApiEndpoint.
73
+
*[upsertApiEndpoint](docs/sdks/apiendpoints/README.md#upsertapiendpoint) - Upsert an ApiEndpoint.
80
74
81
-
### [metadata](docs/sdks/metadata/README.md)
75
+
### [.metadata](docs/sdks/metadata/README.md)
82
76
83
77
*[deleteVersionMetadata](docs/sdks/metadata/README.md#deleteversionmetadata) - Delete metadata for a particular apiID and versionID.
84
78
*[getVersionMetadata](docs/sdks/metadata/README.md#getversionmetadata) - Get all metadata for a particular apiID and versionID.
85
79
*[insertVersionMetadata](docs/sdks/metadata/README.md#insertversionmetadata) - Insert metadata for a particular apiID and versionID.
86
80
87
-
### [plugins](docs/sdks/plugins/README.md)
88
-
89
-
*[getPlugins](docs/sdks/plugins/README.md#getplugins) - Get all plugins for the current workspace.
90
-
*[runPlugin](docs/sdks/plugins/README.md#runplugin) - Run a plugin
91
-
*[upsertPlugin](docs/sdks/plugins/README.md#upsertplugin) - Upsert a plugin
92
-
93
-
### [requests](docs/sdks/requests/README.md)
94
-
95
-
*[generateRequestPostmanCollection](docs/sdks/requests/README.md#generaterequestpostmancollection) - Generate a Postman collection for a particular request.
96
-
*[getRequestFromEventLog](docs/sdks/requests/README.md#getrequestfromeventlog) - Get information about a particular request.
97
-
*[queryEventLog](docs/sdks/requests/README.md#queryeventlog) - Query the event log to retrieve a list of requests.
98
-
99
-
### [schemas](docs/sdks/schemas/README.md)
81
+
### [.schemas](docs/sdks/schemas/README.md)
100
82
101
83
*[deleteSchema](docs/sdks/schemas/README.md#deleteschema) - Delete a particular schema revision for an Api.
102
84
*[downloadSchema](docs/sdks/schemas/README.md#downloadschema) - Download the latest schema for a particular apiID.
@@ -106,6 +88,24 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
106
88
*[getSchemaRevision](docs/sdks/schemas/README.md#getschemarevision) - Get information about a particular schema revision for an Api.
107
89
*[getSchemas](docs/sdks/schemas/README.md#getschemas) - Get information about all schemas associated with a particular apiID.
108
90
*[registerSchema](docs/sdks/schemas/README.md#registerschema) - Register a schema.
91
+
92
+
### [.requests](docs/sdks/requests/README.md)
93
+
94
+
*[generateRequestPostmanCollection](docs/sdks/requests/README.md#generaterequestpostmancollection) - Generate a Postman collection for a particular request.
95
+
*[getRequestFromEventLog](docs/sdks/requests/README.md#getrequestfromeventlog) - Get information about a particular request.
96
+
*[queryEventLog](docs/sdks/requests/README.md#queryeventlog) - Query the event log to retrieve a list of requests.
97
+
98
+
### [.plugins](docs/sdks/plugins/README.md)
99
+
100
+
*[getPlugins](docs/sdks/plugins/README.md#getplugins) - Get all plugins for the current workspace.
101
+
*[runPlugin](docs/sdks/plugins/README.md#runplugin) - Run a plugin
102
+
*[upsertPlugin](docs/sdks/plugins/README.md#upsertplugin) - Upsert a plugin
103
+
104
+
### [.embeds](docs/sdks/embeds/README.md)
105
+
106
+
*[getEmbedAccessToken](docs/sdks/embeds/README.md#getembedaccesstoken) - Get an embed access token for the current workspace.
107
+
*[getValidEmbedAccessTokens](docs/sdks/embeds/README.md#getvalidembedaccesstokens) - Get all valid embed access tokens for the current workspace.
108
+
*[revokeEmbedAccessToken](docs/sdks/embeds/README.md#revokeembedaccesstoken) - Revoke an embed access EmbedToken.
109
109
<!-- End SDK Available Operations -->
110
110
111
111
@@ -132,8 +132,6 @@ Here's an example of one such pagination call:
132
132
# Error Handling
133
133
134
134
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.
135
-
136
-
137
135
<!-- End Error Handling -->
138
136
139
137
@@ -151,19 +149,18 @@ You can override the default server globally by passing a server name to the `se
@@ -177,19 +174,18 @@ import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
177
174
178
175
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:
0 commit comments