Skip to content

Commit 9e96045

Browse files
speakeasybotspeakeasybot
committed
ci: regenerated with OpenAPI Doc 0.3.0, Speakeasy CLI 1.125.2
1 parent da107d8 commit 9e96045

File tree

13 files changed

+56
-59
lines changed

13 files changed

+56
-59
lines changed

‎README.md‎

Lines changed: 20 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# speakeasy-client-sdk-python
22

3-
<!-- Start SDK Installation -->
3+
<!-- Start SDK Installation [installation] -->
44
## SDK Installation
55

66
```bash
77
pip install speakeasy-client-sdk-python
88
```
9-
<!-- End SDK Installation -->
9+
<!-- End SDK Installation [installation] -->
1010

11+
<!-- Start SDK Example Usage [usage] -->
1112
## SDK Example Usage
12-
<!-- Start SDK Example Usage -->
13+
1314
### Example
1415

1516
```python
@@ -24,7 +25,7 @@ s = speakeasy.Speakeasy(
2425

2526
req = operations.GetApisRequest(
2627
metadata={
27-
"key": [
28+
'key': [
2829
'string',
2930
],
3031
},
@@ -39,9 +40,9 @@ if res.classes is not None:
3940
# handle response
4041
pass
4142
```
42-
<!-- End SDK Example Usage -->
43+
<!-- End SDK Example Usage [usage] -->
4344

44-
<!-- Start SDK Available Operations -->
45+
<!-- Start Available Resources and Operations [operations] -->
4546
## Available Resources and Operations
4647

4748
### [Speakeasy SDK](docs/sdks/speakeasy/README.md)
@@ -102,29 +103,15 @@ if res.classes is not None:
102103
* [get_embed_access_token](docs/sdks/embeds/README.md#get_embed_access_token) - Get an embed access token for the current workspace.
103104
* [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.
104105
* [revoke_embed_access_token](docs/sdks/embeds/README.md#revoke_embed_access_token) - Revoke an embed access EmbedToken.
105-
<!-- End SDK Available Operations -->
106-
107-
108-
109-
<!-- Start Dev Containers -->
110-
111-
<!-- End Dev Containers -->
106+
<!-- End Available Resources and Operations [operations] -->
112107

113108

114109

115-
<!-- Start Pagination -->
116-
# Pagination
117110

118-
Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the
119-
returned response object will have a `Next` method that can be called to pull down the next group of results. If the
120-
return value of `Next` is `None`, then there are no more pages to be fetched.
121111

122-
Here's an example of one such pagination call:
123-
<!-- End Pagination -->
124112

125113

126-
127-
<!-- Start Error Handling -->
114+
<!-- Start Error Handling [errors] -->
128115
## Error Handling
129116

130117
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.
@@ -149,20 +136,19 @@ s = speakeasy.Speakeasy(
149136
res = None
150137
try:
151138
res = s.validate_api_key()
152-
153-
except (errors.SDKError) as e:
154-
print(e) # handle exception
155-
139+
except errors.SDKError as e:
140+
print(e) # handle exception
141+
raise(e)
156142

157143
if res.status_code == 200:
158144
# handle response
159145
pass
160146
```
161-
<!-- End Error Handling -->
147+
<!-- End Error Handling [errors] -->
162148

163149

164150

165-
<!-- Start Server Selection -->
151+
<!-- Start Server Selection [server] -->
166152
## Server Selection
167153

168154
### Select Server by Name
@@ -172,6 +158,7 @@ You can override the default server globally by passing a server name to the `se
172158
| Name | Server | Variables |
173159
| ----- | ------ | --------- |
174160
| `prod` | `https://api.prod.speakeasyapi.dev` | None |
161+
175162
#### Example
176163

177164
```python
@@ -215,11 +202,11 @@ if res.status_code == 200:
215202
# handle response
216203
pass
217204
```
218-
<!-- End Server Selection -->
205+
<!-- End Server Selection [server] -->
219206

220207

221208

222-
<!-- Start Custom HTTP Client -->
209+
<!-- Start Custom HTTP Client [http-client] -->
223210
## Custom HTTP Client
224211

225212
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.
@@ -233,11 +220,11 @@ http_client = requests.Session()
233220
http_client.headers.update({'x-custom-header': 'someValue'})
234221
s = speakeasy.Speakeasy(client: http_client)
235222
```
236-
<!-- End Custom HTTP Client -->
223+
<!-- End Custom HTTP Client [http-client] -->
237224

238225

239226

240-
<!-- Start Authentication -->
227+
<!-- Start Authentication [security] -->
241228
## Authentication
242229

243230
### Per-Client Security Schemes
@@ -266,7 +253,7 @@ if res.status_code == 200:
266253
# handle response
267254
pass
268255
```
269-
<!-- End Authentication -->
256+
<!-- End Authentication [security] -->
270257

271258
<!-- Placeholder for Future Speakeasy SDK Sections -->
272259

‎RELEASES.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1076,4 +1076,14 @@ Based on:
10761076
### Generated
10771077
- [python v3.1.3] .
10781078
### Releases
1079-
- [PyPI v3.1.3] https://pypi.org/project/speakeasy-client-sdk-python/3.1.3 - .
1079+
- [PyPI v3.1.3] https://pypi.org/project/speakeasy-client-sdk-python/3.1.3 - .
1080+
1081+
## 2023-12-06 00:10:34
1082+
### Changes
1083+
Based on:
1084+
- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
1085+
- Speakeasy CLI 1.125.2 (2.210.6) https://github.com/speakeasy-api/speakeasy
1086+
### Generated
1087+
- [python v3.1.4] .
1088+
### Releases
1089+
- [PyPI v3.1.4] https://pypi.org/project/speakeasy-client-sdk-python/3.1.4 - .

‎USAGE.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- Start SDK Example Usage -->
1+
<!-- Start SDK Example Usage [usage] -->
22
```python
33
import speakeasy
44
from speakeasy.models import operations, shared
@@ -11,7 +11,7 @@ s = speakeasy.Speakeasy(
1111

1212
req = operations.GetApisRequest(
1313
metadata={
14-
"key": [
14+
'key': [
1515
'string',
1616
],
1717
},
@@ -26,4 +26,4 @@ if res.classes is not None:
2626
# handle response
2727
pass
2828
```
29-
<!-- End SDK Example Usage -->
29+
<!-- End SDK Example Usage [usage] -->

‎docs/models/shared/filter.md‎ renamed to ‎docs/models/shared/filter_.md‎

File renamed without changes.

‎docs/models/shared/filters.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ Filters are used to query requests.
55

66
## Fields
77

8-
| Field | Type | Required | Description |
9-
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
10-
| `filters` | List[[shared.Filter](../../models/shared/filter.md)] | :heavy_check_mark: | A list of filters to apply to the query. |
11-
| `limit` | *int* | :heavy_check_mark: | The maximum number of results to return. |
12-
| `offset` | *int* | :heavy_check_mark: | The offset to start the query from. |
13-
| `operator` | *str* | :heavy_check_mark: | The operator to use when combining filters. |
8+
| Field | Type | Required | Description |
9+
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
10+
| `filters` | List[[shared.Filter](../../models/shared/filter_.md)] | :heavy_check_mark: | A list of filters to apply to the query. |
11+
| `limit` | *int* | :heavy_check_mark: | The maximum number of results to return. |
12+
| `offset` | *int* | :heavy_check_mark: | The offset to start the query from. |
13+
| `operator` | *str* | :heavy_check_mark: | The operator to use when combining filters. |

‎docs/sdks/apis/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ s = speakeasy.Speakeasy(
167167
req = operations.GetAllAPIVersionsRequest(
168168
api_id='string',
169169
metadata={
170-
"key": [
170+
'key': [
171171
'string',
172172
],
173173
},
@@ -218,7 +218,7 @@ s = speakeasy.Speakeasy(
218218

219219
req = operations.GetApisRequest(
220220
metadata={
221-
"key": [
221+
'key': [
222222
'string',
223223
],
224224
},
@@ -272,7 +272,7 @@ req = operations.UpsertAPIRequest(
272272
api_id='string',
273273
description='Synchronised 5th generation knowledge user',
274274
meta_data={
275-
"key": [
275+
'key': [
276276
'string',
277277
],
278278
},

‎files.gen‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ src/speakeasy/models/shared/unboundedrequest.py
6464
src/speakeasy/models/shared/boundedrequest.py
6565
src/speakeasy/models/shared/requestmetadata.py
6666
src/speakeasy/models/shared/filters.py
67-
src/speakeasy/models/shared/filter.py
67+
src/speakeasy/models/shared/filter_.py
6868
src/speakeasy/models/shared/plugin.py
6969
src/speakeasy/models/shared/embedaccesstokenresponse.py
7070
src/speakeasy/models/shared/embedtoken.py
@@ -73,7 +73,6 @@ src/speakeasy/models/__init__.py
7373
src/speakeasy/models/errors/__init__.py
7474
src/speakeasy/models/operations/__init__.py
7575
src/speakeasy/models/shared/__init__.py
76-
USAGE.md
7776
docs/models/operations/validateapikeyresponse.md
7877
docs/models/operations/deleteapirequest.md
7978
docs/models/operations/deleteapiresponse.md
@@ -159,7 +158,7 @@ docs/models/shared/unboundedrequest.md
159158
docs/models/shared/boundedrequest.md
160159
docs/models/shared/requestmetadata.md
161160
docs/models/shared/filters.md
162-
docs/models/shared/filter.md
161+
docs/models/shared/filter_.md
163162
docs/models/shared/plugin.md
164163
docs/models/shared/embedaccesstokenresponse.md
165164
docs/models/shared/embedtoken.md
@@ -172,4 +171,5 @@ docs/sdks/schemas/README.md
172171
docs/sdks/requests/README.md
173172
docs/sdks/plugins/README.md
174173
docs/sdks/embeds/README.md
174+
USAGE.md
175175
.gitattributes

‎gen.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ configVersion: 1.0.0
22
management:
33
docChecksum: ba638b2ad28966c596e28321a2003686
44
docVersion: 0.3.0
5-
speakeasyVersion: 1.121.3
6-
generationVersion: 2.195.2
5+
speakeasyVersion: 1.125.2
6+
generationVersion: 2.210.6
77
generation:
88
comments: {}
99
sdkClassName: speakeasy
@@ -12,15 +12,15 @@ generation:
1212
optionalPropertyRendering: withExample
1313
features:
1414
python:
15-
core: 4.1.5
15+
core: 4.1.6
1616
downloadStreams: 0.0.2
1717
examples: 2.81.3
1818
globalSecurity: 2.83.0
1919
globalServerURLs: 2.82.1
2020
inputOutputModels: 2.82.0
2121
serverIDs: 2.81.1
2222
python:
23-
version: 3.1.3
23+
version: 3.1.4
2424
author: Speakeasy
2525
clientServerStatusCodesAsErrors: true
2626
description: Speakeasy API Client SDK for Python

‎setup.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
setuptools.setup(
1212
name="speakeasy-client-sdk-python",
13-
version="3.1.3",
13+
version="3.1.4",
1414
author="Speakeasy",
1515
description="Speakeasy API Client SDK for Python",
1616
long_description=long_description,

‎src/speakeasy/models/shared/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
from .embedaccesstokenresponse import *
99
from .embedtoken import *
1010
from .error import *
11-
from .filter import *
11+
from .filter_ import *
1212
from .filters import *
1313
from .generateopenapispecdiff import *
1414
from .plugin import *

0 commit comments

Comments
 (0)