Skip to content

Commit a66e19e

Browse files
committed
ci: regenerated with OpenAPI Doc 1.0.0, Speakeasy CLI 1.116.0
1 parent 5baaf9a commit a66e19e

File tree

98 files changed

+379
-615
lines changed

Some content is hidden

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

98 files changed

+379
-615
lines changed

README.md

Lines changed: 66 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -72,15 +72,15 @@ if res.connection_response is not None:
7272
## Available Resources and Operations
7373

7474

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

7777
* [create_connection](docs/sdks/connections/README.md#create_connection) - Create a connection
7878
* [delete_connection](docs/sdks/connections/README.md#delete_connection) - Delete a Connection
7979
* [get_connection](docs/sdks/connections/README.md#get_connection) - Get Connection details
8080
* [list_connections](docs/sdks/connections/README.md#list_connections) - List connections
8181
* [patch_connection](docs/sdks/connections/README.md#patch_connection) - Update Connection details
8282

83-
### [.destinations](docs/sdks/destinations/README.md)
83+
### [destinations](docs/sdks/destinations/README.md)
8484

8585
* [create_destination](docs/sdks/destinations/README.md#create_destination) - Create a destination
8686
* [delete_destination](docs/sdks/destinations/README.md#delete_destination) - Delete a Destination
@@ -89,14 +89,14 @@ if res.connection_response is not None:
8989
* [patch_destination](docs/sdks/destinations/README.md#patch_destination) - Update a Destination
9090
* [put_destination](docs/sdks/destinations/README.md#put_destination) - Update a Destination and fully overwrite it
9191

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

9494
* [cancel_job](docs/sdks/jobs/README.md#cancel_job) - Cancel a running Job
9595
* [create_job](docs/sdks/jobs/README.md#create_job) - Trigger a sync or reset job of a connection
9696
* [get_job](docs/sdks/jobs/README.md#get_job) - Get Job status and details
9797
* [list_jobs](docs/sdks/jobs/README.md#list_jobs) - List Jobs by sync type
9898

99-
### [.sources](docs/sdks/sources/README.md)
99+
### [sources](docs/sdks/sources/README.md)
100100

101101
* [create_source](docs/sdks/sources/README.md#create_source) - Create a source
102102
* [delete_source](docs/sdks/sources/README.md#delete_source) - Delete a Source
@@ -106,11 +106,11 @@ if res.connection_response is not None:
106106
* [patch_source](docs/sdks/sources/README.md#patch_source) - Update a Source
107107
* [put_source](docs/sdks/sources/README.md#put_source) - Update a Source and fully overwrite it
108108

109-
### [.streams](docs/sdks/streams/README.md)
109+
### [streams](docs/sdks/streams/README.md)
110110

111111
* [get_stream_properties](docs/sdks/streams/README.md#get_stream_properties) - Get stream properties
112112

113-
### [.workspaces](docs/sdks/workspaces/README.md)
113+
### [workspaces](docs/sdks/workspaces/README.md)
114114

115115
* [create_or_update_workspace_o_auth_credentials](docs/sdks/workspaces/README.md#create_or_update_workspace_o_auth_credentials) - Create OAuth override credentials for a workspace and source type.
116116
* [create_workspace](docs/sdks/workspaces/README.md#create_workspace) - Create a workspace
@@ -143,7 +143,64 @@ Here's an example of one such pagination call:
143143
<!-- Start Error Handling -->
144144
# Error Handling
145145

146-
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.
146+
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.
147+
148+
| Error Object | Status Code | Content Type |
149+
| --------------- | --------------- | --------------- |
150+
| errors.SDKError | 400-600 | */* |
151+
152+
153+
## Example
154+
155+
```python
156+
import airbyte
157+
from airbyte.models import shared
158+
159+
s = airbyte.Airbyte(
160+
security=shared.Security(
161+
basic_auth=shared.SchemeBasicAuth(
162+
password="",
163+
username="",
164+
),
165+
),
166+
)
167+
168+
req = shared.ConnectionCreateRequest(
169+
configurations=shared.StreamConfigurations(
170+
streams=[
171+
shared.StreamConfiguration(
172+
cursor_field=[
173+
'string',
174+
],
175+
name='string',
176+
primary_key=[
177+
[
178+
'string',
179+
],
180+
],
181+
),
182+
],
183+
),
184+
destination_id='c669dd1e-3620-483e-afc8-55914e0a570f',
185+
namespace_format='${SOURCE_NAMESPACE}',
186+
schedule=shared.ConnectionSchedule(
187+
schedule_type=shared.ScheduleTypeEnum.MANUAL,
188+
),
189+
source_id='dd427d83-a555-4847-8358-42325b6c7b3f',
190+
)
191+
192+
res = None
193+
try:
194+
res = s.connections.create_connection(req)
195+
196+
except (errors.SDKError) as e:
197+
print(e) # handle exception
198+
199+
200+
if res.connection_response is not None:
201+
# handle response
202+
pass
203+
```
147204
<!-- End Error Handling -->
148205

149206

@@ -265,7 +322,7 @@ if res.connection_response is not None:
265322
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.
266323

267324

268-
For example, you could specify a header for every request that your sdk makes as follows:
325+
For example, you could specify a header for every request that this sdk makes as follows:
269326

270327
```python
271328
import airbyte
@@ -280,12 +337,11 @@ s = airbyte.Airbyte(client: http_client)
280337

281338

282339
<!-- Start Authentication -->
283-
284340
# Authentication
285341

286342
## Per-Client Security Schemes
287343

288-
Your SDK supports the following security schemes globally:
344+
This SDK supports the following security schemes globally:
289345

290346
| Name | Type | Scheme |
291347
| ------------- | ------------- | ------------- |

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -678,4 +678,14 @@ Based on:
678678
### Generated
679679
- [python v0.42.0] .
680680
### Releases
681-
- [PyPI v0.42.0] https://pypi.org/project/airbyte-api/0.42.0 - .
681+
- [PyPI v0.42.0] https://pypi.org/project/airbyte-api/0.42.0 - .
682+
683+
## 2023-11-09 00:13:16
684+
### Changes
685+
Based on:
686+
- OpenAPI Doc 1.0.0
687+
- Speakeasy CLI 1.116.0 (2.185.0) https://github.com/speakeasy-api/speakeasy
688+
### Generated
689+
- [python v0.43.0] .
690+
### Releases
691+
- [PyPI v0.43.0] https://pypi.org/project/airbyte-api/0.43.0 - .

docs/sdks/connections/README.md

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

44
### Available Operations
55

@@ -69,7 +69,11 @@ if res.connection_response is not None:
6969
### Response
7070

7171
**[operations.CreateConnectionResponse](../../models/operations/createconnectionresponse.md)**
72+
### Errors
7273

74+
| Error Object | Status Code | Content Type |
75+
| --------------- | --------------- | --------------- |
76+
| errors.SDKError | 400-600 | */* |
7377

7478
## delete_connection
7579

@@ -111,7 +115,11 @@ if res.status_code == 200:
111115
### Response
112116

113117
**[operations.DeleteConnectionResponse](../../models/operations/deleteconnectionresponse.md)**
118+
### Errors
114119

120+
| Error Object | Status Code | Content Type |
121+
| --------------- | --------------- | --------------- |
122+
| errors.SDKError | 400-600 | */* |
115123

116124
## get_connection
117125

@@ -153,7 +161,11 @@ if res.connection_response is not None:
153161
### Response
154162

155163
**[operations.GetConnectionResponse](../../models/operations/getconnectionresponse.md)**
164+
### Errors
156165

166+
| Error Object | Status Code | Content Type |
167+
| --------------- | --------------- | --------------- |
168+
| errors.SDKError | 400-600 | */* |
157169

158170
## list_connections
159171

@@ -197,7 +209,11 @@ if res.connections_response is not None:
197209
### Response
198210

199211
**[operations.ListConnectionsResponse](../../models/operations/listconnectionsresponse.md)**
212+
### Errors
200213

214+
| Error Object | Status Code | Content Type |
215+
| --------------- | --------------- | --------------- |
216+
| errors.SDKError | 400-600 | */* |
201217

202218
## patch_connection
203219

@@ -260,4 +276,8 @@ if res.connection_response is not None:
260276
### Response
261277

262278
**[operations.PatchConnectionResponse](../../models/operations/patchconnectionresponse.md)**
279+
### Errors
263280

281+
| Error Object | Status Code | Content Type |
282+
| --------------- | --------------- | --------------- |
283+
| errors.SDKError | 400-600 | */* |

docs/sdks/destinations/README.md

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

44
### Available Operations
55

@@ -64,7 +64,11 @@ if res.destination_response is not None:
6464
### Response
6565

6666
**[operations.CreateDestinationResponse](../../models/operations/createdestinationresponse.md)**
67+
### Errors
6768

69+
| Error Object | Status Code | Content Type |
70+
| --------------- | --------------- | --------------- |
71+
| errors.SDKError | 400-600 | */* |
6872

6973
## delete_destination
7074

@@ -106,7 +110,11 @@ if res.status_code == 200:
106110
### Response
107111

108112
**[operations.DeleteDestinationResponse](../../models/operations/deletedestinationresponse.md)**
113+
### Errors
109114

115+
| Error Object | Status Code | Content Type |
116+
| --------------- | --------------- | --------------- |
117+
| errors.SDKError | 400-600 | */* |
110118

111119
## get_destination
112120

@@ -148,7 +156,11 @@ if res.destination_response is not None:
148156
### Response
149157

150158
**[operations.GetDestinationResponse](../../models/operations/getdestinationresponse.md)**
159+
### Errors
151160

161+
| Error Object | Status Code | Content Type |
162+
| --------------- | --------------- | --------------- |
163+
| errors.SDKError | 400-600 | */* |
152164

153165
## list_destinations
154166

@@ -192,7 +204,11 @@ if res.destinations_response is not None:
192204
### Response
193205

194206
**[operations.ListDestinationsResponse](../../models/operations/listdestinationsresponse.md)**
207+
### Errors
195208

209+
| Error Object | Status Code | Content Type |
210+
| --------------- | --------------- | --------------- |
211+
| errors.SDKError | 400-600 | */* |
196212

197213
## patch_destination
198214

@@ -248,7 +264,11 @@ if res.destination_response is not None:
248264
### Response
249265

250266
**[operations.PatchDestinationResponse](../../models/operations/patchdestinationresponse.md)**
267+
### Errors
251268

269+
| Error Object | Status Code | Content Type |
270+
| --------------- | --------------- | --------------- |
271+
| errors.SDKError | 400-600 | */* |
252272

253273
## put_destination
254274

@@ -305,4 +325,8 @@ if res.destination_response is not None:
305325
### Response
306326

307327
**[operations.PutDestinationResponse](../../models/operations/putdestinationresponse.md)**
328+
### Errors
308329

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

docs/sdks/jobs/README.md

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

44
### Available Operations
55

@@ -48,7 +48,11 @@ if res.job_response is not None:
4848
### Response
4949

5050
**[operations.CancelJobResponse](../../models/operations/canceljobresponse.md)**
51+
### Errors
5152

53+
| Error Object | Status Code | Content Type |
54+
| --------------- | --------------- | --------------- |
55+
| errors.SDKError | 400-600 | */* |
5256

5357
## create_job
5458

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

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

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

96104
## get_job
97105

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

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

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

138150
## list_jobs
139151

@@ -178,4 +190,8 @@ if res.jobs_response is not None:
178190
### Response
179191

180192
**[operations.ListJobsResponse](../../models/operations/listjobsresponse.md)**
193+
### Errors
181194

195+
| Error Object | Status Code | Content Type |
196+
| --------------- | --------------- | --------------- |
197+
| errors.SDKError | 400-600 | */* |

0 commit comments

Comments
 (0)