Skip to content

Commit f705202

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

File tree

177 files changed

+172
-166
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

177 files changed

+172
-166
lines changed

‎.gitattributes

100755100644
File mode changed.

‎README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ pip install speakeasy-client-sdk-python
1010

1111
## SDK Example Usage
1212
<!-- Start SDK Example Usage -->
13+
### Example
14+
1315
```python
1416
import speakeasy
1517
from speakeasy.models import operations, shared
@@ -123,16 +125,15 @@ Here's an example of one such pagination call:
123125

124126

125127
<!-- Start Error Handling -->
126-
# Error Handling
128+
## Error Handling
127129

128130
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.
129131

130132
| Error Object | Status Code | Content Type |
131133
| --------------- | --------------- | --------------- |
132134
| errors.SDKError | 400-600 | */* |
133135

134-
135-
## Example
136+
### Example
136137

137138
```python
138139
import speakeasy
@@ -162,17 +163,16 @@ if res.status_code == 200:
162163

163164

164165
<!-- Start Server Selection -->
165-
# Server Selection
166+
## Server Selection
166167

167-
## Select Server by Name
168+
### Select Server by Name
168169

169170
You can override the default server globally by passing a server name to the `server: str` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
170171

171172
| Name | Server | Variables |
172173
| ----- | ------ | --------- |
173174
| `prod` | `https://api.prod.speakeasyapi.dev` | None |
174-
175-
For example:
175+
#### Example
176176

177177
```python
178178
import speakeasy
@@ -194,10 +194,9 @@ if res.status_code == 200:
194194
```
195195

196196

197-
## Override Server URL Per-Client
197+
### Override Server URL Per-Client
198198

199199
The default server can also be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
200-
201200
```python
202201
import speakeasy
203202
from speakeasy.models import shared
@@ -221,13 +220,11 @@ if res.status_code == 200:
221220

222221

223222
<!-- Start Custom HTTP Client -->
224-
# Custom HTTP Client
223+
## Custom HTTP Client
225224

226225
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.
227226

228-
229227
For example, you could specify a header for every request that this sdk makes as follows:
230-
231228
```python
232229
import speakeasy
233230
import requests
@@ -241,9 +238,9 @@ s = speakeasy.Speakeasy(client: http_client)
241238

242239

243240
<!-- Start Authentication -->
244-
# Authentication
241+
## Authentication
245242

246-
## Per-Client Security Schemes
243+
### Per-Client Security Schemes
247244

248245
This SDK supports the following security scheme globally:
249246

@@ -252,7 +249,6 @@ This SDK supports the following security scheme globally:
252249
| `api_key` | apiKey | API key |
253250

254251
You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:
255-
256252
```python
257253
import speakeasy
258254
from speakeasy.models import shared

‎RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1046,4 +1046,14 @@ Based on:
10461046
### Generated
10471047
- [python v3.1.0] .
10481048
### Releases
1049-
- [PyPI v3.1.0] https://pypi.org/project/speakeasy-client-sdk-python/3.1.0 - .
1049+
- [PyPI v3.1.0] https://pypi.org/project/speakeasy-client-sdk-python/3.1.0 - .
1050+
1051+
## 2023-11-16 00:10:31
1052+
### Changes
1053+
Based on:
1054+
- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
1055+
- Speakeasy CLI 1.120.3 (2.192.1) https://github.com/speakeasy-api/speakeasy
1056+
### Generated
1057+
- [python v3.1.1] .
1058+
### Releases
1059+
- [PyPI v3.1.1] https://pypi.org/project/speakeasy-client-sdk-python/3.1.1 - .

‎USAGE.md

100755100644
Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
<!-- Start SDK Example Usage -->
2-
3-
42
```python
53
import speakeasy
64
from speakeasy.models import operations, shared

‎docs/models/operations/deleteapiendpointrequest.md

100755100644
File mode changed.

‎docs/models/operations/deleteapiendpointresponse.md

100755100644
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@
88
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
99
| `error` | [Optional[shared.Error]](../../models/shared/error.md) | :heavy_minus_sign: | Default error response |
1010
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
11-
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
11+
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

‎docs/models/operations/deleteapirequest.md

100755100644
File mode changed.

‎docs/models/operations/deleteapiresponse.md

100755100644
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@
88
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
99
| `error` | [Optional[shared.Error]](../../models/shared/error.md) | :heavy_minus_sign: | Default error response |
1010
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
11-
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
11+
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

‎docs/models/operations/deleteschemarequest.md

100755100644
File mode changed.

‎docs/models/operations/deleteschemaresponse.md

100755100644
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@
88
| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation |
99
| `error` | [Optional[shared.Error]](../../models/shared/error.md) | :heavy_minus_sign: | Default error response |
1010
| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation |
11-
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_minus_sign: | Raw HTTP response; suitable for custom response parsing |
11+
| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing |

0 commit comments

Comments
 (0)