Skip to content

Commit 044195e

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.3.0, Speakeasy CLI 1.116.0
1 parent 1fd06d0 commit 044195e

32 files changed

+477
-130
lines changed

‎README.md‎

Lines changed: 41 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ if res.classes is not None:
4646

4747
* [validate_api_key](docs/sdks/speakeasy/README.md#validate_api_key) - Validate the current api key.
4848

49-
### [.apis](docs/sdks/apis/README.md)
49+
### [apis](docs/sdks/apis/README.md)
5050

5151
* [delete_api](docs/sdks/apis/README.md#delete_api) - Delete an Api.
5252
* [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:
5555
* [get_apis](docs/sdks/apis/README.md#get_apis) - Get a list of Apis for a given workspace
5656
* [upsert_api](docs/sdks/apis/README.md#upsert_api) - Upsert an Api
5757

58-
### [.api_endpoints](docs/sdks/apiendpoints/README.md)
58+
### [api_endpoints](docs/sdks/apiendpoints/README.md)
5959

6060
* [delete_api_endpoint](docs/sdks/apiendpoints/README.md#delete_api_endpoint) - Delete an ApiEndpoint.
6161
* [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:
6666
* [get_api_endpoint](docs/sdks/apiendpoints/README.md#get_api_endpoint) - Get an ApiEndpoint.
6767
* [upsert_api_endpoint](docs/sdks/apiendpoints/README.md#upsert_api_endpoint) - Upsert an ApiEndpoint.
6868

69-
### [.metadata](docs/sdks/metadata/README.md)
69+
### [metadata](docs/sdks/metadata/README.md)
7070

7171
* [delete_version_metadata](docs/sdks/metadata/README.md#delete_version_metadata) - Delete metadata for a particular apiID and versionID.
7272
* [get_version_metadata](docs/sdks/metadata/README.md#get_version_metadata) - Get all metadata for a particular apiID and versionID.
7373
* [insert_version_metadata](docs/sdks/metadata/README.md#insert_version_metadata) - Insert metadata for a particular apiID and versionID.
7474

75-
### [.schemas](docs/sdks/schemas/README.md)
75+
### [schemas](docs/sdks/schemas/README.md)
7676

7777
* [delete_schema](docs/sdks/schemas/README.md#delete_schema) - Delete a particular schema revision for an Api.
7878
* [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:
8383
* [get_schemas](docs/sdks/schemas/README.md#get_schemas) - Get information about all schemas associated with a particular apiID.
8484
* [register_schema](docs/sdks/schemas/README.md#register_schema) - Register a schema.
8585

86-
### [.requests](docs/sdks/requests/README.md)
86+
### [requests](docs/sdks/requests/README.md)
8787

8888
* [generate_request_postman_collection](docs/sdks/requests/README.md#generate_request_postman_collection) - Generate a Postman collection for a particular request.
8989
* [get_request_from_event_log](docs/sdks/requests/README.md#get_request_from_event_log) - Get information about a particular request.
9090
* [query_event_log](docs/sdks/requests/README.md#query_event_log) - Query the event log to retrieve a list of requests.
9191

92-
### [.plugins](docs/sdks/plugins/README.md)
92+
### [plugins](docs/sdks/plugins/README.md)
9393

9494
* [get_plugins](docs/sdks/plugins/README.md#get_plugins) - Get all plugins for the current workspace.
9595
* [run_plugin](docs/sdks/plugins/README.md#run_plugin) - Run a plugin
9696
* [upsert_plugin](docs/sdks/plugins/README.md#upsert_plugin) - Upsert a plugin
9797

98-
### [.embeds](docs/sdks/embeds/README.md)
98+
### [embeds](docs/sdks/embeds/README.md)
9999

100100
* [get_embed_access_token](docs/sdks/embeds/README.md#get_embed_access_token) - Get an embed access token for the current workspace.
101101
* [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:
125125
<!-- Start Error Handling -->
126126
# Error Handling
127127

128-
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.
128+
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.
129+
130+
| Error Object | Status Code | Content Type |
131+
| --------------- | --------------- | --------------- |
132+
| errors.SDKError | 400-600 | */* |
133+
134+
135+
## Example
136+
137+
```python
138+
import speakeasy
139+
from speakeasy.models import shared
140+
141+
s = speakeasy.Speakeasy(
142+
security=shared.Security(
143+
api_key="",
144+
),
145+
)
146+
147+
148+
res = None
149+
try:
150+
res = s.validate_api_key()
151+
152+
except (errors.SDKError) as e:
153+
print(e) # handle exception
154+
155+
156+
if res.status_code == 200:
157+
# handle response
158+
pass
159+
```
129160
<!-- End Error Handling -->
130161

131162

@@ -195,7 +226,7 @@ if res.status_code == 200:
195226
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.
196227

197228

198-
For example, you could specify a header for every request that your sdk makes as follows:
229+
For example, you could specify a header for every request that this sdk makes as follows:
199230

200231
```python
201232
import speakeasy
@@ -210,12 +241,11 @@ s = speakeasy.Speakeasy(client: http_client)
210241

211242

212243
<!-- Start Authentication -->
213-
214244
# Authentication
215245

216246
## Per-Client Security Schemes
217247

218-
Your SDK supports the following security scheme globally:
248+
This SDK supports the following security scheme globally:
219249

220250
| Name | Type | Scheme |
221251
| --------- | --------- | --------- |

‎RELEASES.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1036,4 +1036,14 @@ Based on:
10361036
### Generated
10371037
- [python v3.0.0] .
10381038
### Releases
1039-
- [PyPI v3.0.0] https://pypi.org/project/speakeasy-client-sdk-python/3.0.0 - .
1039+
- [PyPI v3.0.0] https://pypi.org/project/speakeasy-client-sdk-python/3.0.0 - .
1040+
1041+
## 2023-11-09 00:10:02
1042+
### Changes
1043+
Based on:
1044+
- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
1045+
- Speakeasy CLI 1.116.0 (2.185.0) https://github.com/speakeasy-api/speakeasy
1046+
### Generated
1047+
- [python v3.1.0] .
1048+
### Releases
1049+
- [PyPI v3.1.0] https://pypi.org/project/speakeasy-client-sdk-python/3.1.0 - .

‎docs/sdks/apiendpoints/README.md‎

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# APIEndpoints
2-
(*.api_endpoints*)
2+
(*api_endpoints*)
33

44
## Overview
55

@@ -55,7 +55,11 @@ if res.status_code == 200:
5555
### Response
5656

5757
**[operations.DeleteAPIEndpointResponse](../../models/operations/deleteapiendpointresponse.md)**
58+
### Errors
5859

60+
| Error Object | Status Code | Content Type |
61+
| --------------- | --------------- | --------------- |
62+
| errors.SDKError | 400-600 | */* |
5963

6064
## find_api_endpoint
6165

@@ -97,7 +101,11 @@ if res.api_endpoint is not None:
97101
### Response
98102

99103
**[operations.FindAPIEndpointResponse](../../models/operations/findapiendpointresponse.md)**
104+
### Errors
100105

106+
| Error Object | Status Code | Content Type |
107+
| --------------- | --------------- | --------------- |
108+
| errors.SDKError | 400-600 | */* |
101109

102110
## generate_open_api_spec_for_api_endpoint
103111

@@ -139,7 +147,11 @@ if res.generate_open_api_spec_diff is not None:
139147
### Response
140148

141149
**[operations.GenerateOpenAPISpecForAPIEndpointResponse](../../models/operations/generateopenapispecforapiendpointresponse.md)**
150+
### Errors
142151

152+
| Error Object | Status Code | Content Type |
153+
| --------------- | --------------- | --------------- |
154+
| errors.SDKError | 400-600 | */* |
143155

144156
## generate_postman_collection_for_api_endpoint
145157

@@ -180,7 +192,11 @@ if res.postman_collection is not None:
180192
### Response
181193

182194
**[operations.GeneratePostmanCollectionForAPIEndpointResponse](../../models/operations/generatepostmancollectionforapiendpointresponse.md)**
195+
### Errors
183196

197+
| Error Object | Status Code | Content Type |
198+
| --------------- | --------------- | --------------- |
199+
| errors.SDKError | 400-600 | */* |
184200

185201
## get_all_api_endpoints
186202

@@ -219,7 +235,11 @@ if res.classes is not None:
219235
### Response
220236

221237
**[operations.GetAllAPIEndpointsResponse](../../models/operations/getallapiendpointsresponse.md)**
238+
### Errors
222239

240+
| Error Object | Status Code | Content Type |
241+
| --------------- | --------------- | --------------- |
242+
| errors.SDKError | 400-600 | */* |
223243

224244
## get_all_for_version_api_endpoints
225245

@@ -259,7 +279,11 @@ if res.classes is not None:
259279
### Response
260280

261281
**[operations.GetAllForVersionAPIEndpointsResponse](../../models/operations/getallforversionapiendpointsresponse.md)**
282+
### Errors
262283

284+
| Error Object | Status Code | Content Type |
285+
| --------------- | --------------- | --------------- |
286+
| errors.SDKError | 400-600 | */* |
263287

264288
## get_api_endpoint
265289

@@ -300,7 +324,11 @@ if res.api_endpoint is not None:
300324
### Response
301325

302326
**[operations.GetAPIEndpointResponse](../../models/operations/getapiendpointresponse.md)**
327+
### Errors
303328

329+
| Error Object | Status Code | Content Type |
330+
| --------------- | --------------- | --------------- |
331+
| errors.SDKError | 400-600 | */* |
304332

305333
## upsert_api_endpoint
306334

@@ -349,4 +377,8 @@ if res.api_endpoint is not None:
349377
### Response
350378

351379
**[operations.UpsertAPIEndpointResponse](../../models/operations/upsertapiendpointresponse.md)**
380+
### Errors
352381

382+
| Error Object | Status Code | Content Type |
383+
| --------------- | --------------- | --------------- |
384+
| errors.SDKError | 400-600 | */* |

‎docs/sdks/apis/README.md‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Apis
2-
(*.apis*)
2+
(*apis*)
33

44
## Overview
55

@@ -52,7 +52,11 @@ if res.status_code == 200:
5252
### Response
5353

5454
**[operations.DeleteAPIResponse](../../models/operations/deleteapiresponse.md)**
55+
### Errors
5556

57+
| Error Object | Status Code | Content Type |
58+
| --------------- | --------------- | --------------- |
59+
| errors.SDKError | 400-600 | */* |
5660

5761
## generate_open_api_spec
5862

@@ -93,7 +97,11 @@ if res.generate_open_api_spec_diff is not None:
9397
### Response
9498

9599
**[operations.GenerateOpenAPISpecResponse](../../models/operations/generateopenapispecresponse.md)**
100+
### Errors
96101

102+
| Error Object | Status Code | Content Type |
103+
| --------------- | --------------- | --------------- |
104+
| errors.SDKError | 400-600 | */* |
97105

98106
## generate_postman_collection
99107

@@ -133,7 +141,11 @@ if res.postman_collection is not None:
133141
### Response
134142

135143
**[operations.GeneratePostmanCollectionResponse](../../models/operations/generatepostmancollectionresponse.md)**
144+
### Errors
136145

146+
| Error Object | Status Code | Content Type |
147+
| --------------- | --------------- | --------------- |
148+
| errors.SDKError | 400-600 | */* |
137149

138150
## get_all_api_versions
139151

@@ -181,7 +193,11 @@ if res.classes is not None:
181193
### Response
182194

183195
**[operations.GetAllAPIVersionsResponse](../../models/operations/getallapiversionsresponse.md)**
196+
### Errors
184197

198+
| Error Object | Status Code | Content Type |
199+
| --------------- | --------------- | --------------- |
200+
| errors.SDKError | 400-600 | */* |
185201

186202
## get_apis
187203

@@ -228,7 +244,11 @@ if res.classes is not None:
228244
### Response
229245

230246
**[operations.GetApisResponse](../../models/operations/getapisresponse.md)**
247+
### Errors
231248

249+
| Error Object | Status Code | Content Type |
250+
| --------------- | --------------- | --------------- |
251+
| errors.SDKError | 400-600 | */* |
232252

233253
## upsert_api
234254

@@ -278,4 +298,8 @@ if res.api is not None:
278298
### Response
279299

280300
**[operations.UpsertAPIResponse](../../models/operations/upsertapiresponse.md)**
301+
### Errors
281302

303+
| Error Object | Status Code | Content Type |
304+
| --------------- | --------------- | --------------- |
305+
| errors.SDKError | 400-600 | */* |

‎docs/sdks/embeds/README.md‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Embeds
2-
(*.embeds*)
2+
(*embeds*)
33

44
## Overview
55

@@ -60,7 +60,11 @@ if res.embed_access_token_response is not None:
6060
### Response
6161

6262
**[operations.GetEmbedAccessTokenResponse](../../models/operations/getembedaccesstokenresponse.md)**
63+
### Errors
6364

65+
| Error Object | Status Code | Content Type |
66+
| --------------- | --------------- | --------------- |
67+
| errors.SDKError | 400-600 | */* |
6468

6569
## get_valid_embed_access_tokens
6670

@@ -90,7 +94,11 @@ if res.classes is not None:
9094
### Response
9195

9296
**[operations.GetValidEmbedAccessTokensResponse](../../models/operations/getvalidembedaccesstokensresponse.md)**
97+
### Errors
9398

99+
| Error Object | Status Code | Content Type |
100+
| --------------- | --------------- | --------------- |
101+
| errors.SDKError | 400-600 | */* |
94102

95103
## revoke_embed_access_token
96104

@@ -129,4 +137,8 @@ if res.status_code == 200:
129137
### Response
130138

131139
**[operations.RevokeEmbedAccessTokenResponse](../../models/operations/revokeembedaccesstokenresponse.md)**
140+
### Errors
132141

142+
| Error Object | Status Code | Content Type |
143+
| --------------- | --------------- | --------------- |
144+
| errors.SDKError | 400-600 | */* |

‎docs/sdks/metadata/README.md‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Metadata
2-
(*.metadata*)
2+
(*metadata*)
33

44
## Overview
55

@@ -51,7 +51,11 @@ if res.status_code == 200:
5151
### Response
5252

5353
**[operations.DeleteVersionMetadataResponse](../../models/operations/deleteversionmetadataresponse.md)**
54+
### Errors
5455

56+
| Error Object | Status Code | Content Type |
57+
| --------------- | --------------- | --------------- |
58+
| errors.SDKError | 400-600 | */* |
5559

5660
## get_version_metadata
5761

@@ -91,7 +95,11 @@ if res.classes is not None:
9195
### Response
9296

9397
**[operations.GetVersionMetadataResponse](../../models/operations/getversionmetadataresponse.md)**
98+
### Errors
9499

100+
| Error Object | Status Code | Content Type |
101+
| --------------- | --------------- | --------------- |
102+
| errors.SDKError | 400-600 | */* |
95103

96104
## insert_version_metadata
97105

@@ -135,4 +143,8 @@ if res.version_metadata is not None:
135143
### Response
136144

137145
**[operations.InsertVersionMetadataResponse](../../models/operations/insertversionmetadataresponse.md)**
146+
### Errors
138147

148+
| Error Object | Status Code | Content Type |
149+
| --------------- | --------------- | --------------- |
150+
| errors.SDKError | 400-600 | */* |

0 commit comments

Comments
 (0)