Skip to content

Commit

Permalink
chore: 🐝 Update SDK - Generate 0.52.2 (#109)
Browse files Browse the repository at this point in the history
Co-authored-by: speakeasybot <[email protected]>
  • Loading branch information
github-actions[bot] and speakeasybot authored Dec 11, 2024
1 parent 048c847 commit 7884557
Show file tree
Hide file tree
Showing 888 changed files with 15,661 additions and 1,585 deletions.
1,492 changes: 883 additions & 609 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

22 changes: 14 additions & 8 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@
speakeasyVersion: 1.291.0
speakeasyVersion: 1.453.10
sources:
my-source:
sourceNamespace: my-source
sourceRevisionDigest: sha256:4cbacce549695d61a4b6fcd07742e8eb25c528061ad1db3e002239fcea2956fa
sourceBlobDigest: sha256:8745bd06d95a1f1a7073a8a702c4bd4db2c5967d58f562d11de4f89ac7f872f5
sourceRevisionDigest: sha256:3712f551c1bc9d55089a54598938b61b271ddcc1a81583646d883bae9f085825
sourceBlobDigest: sha256:fa5143179ee978611fb032f3948584f4cbf071857ff2ff6611fbac17e1b67eb9
tags:
- latest
- main
- speakeasy-sdk-regen-1730420397
- 1.0.0
targets:
python-api:
source: my-source
sourceNamespace: my-source
sourceRevisionDigest: sha256:4cbacce549695d61a4b6fcd07742e8eb25c528061ad1db3e002239fcea2956fa
sourceBlobDigest: sha256:8745bd06d95a1f1a7073a8a702c4bd4db2c5967d58f562d11de4f89ac7f872f5
outLocation: /github/workspace/repo
sourceRevisionDigest: sha256:3712f551c1bc9d55089a54598938b61b271ddcc1a81583646d883bae9f085825
sourceBlobDigest: sha256:fa5143179ee978611fb032f3948584f4cbf071857ff2ff6611fbac17e1b67eb9
codeSamplesNamespace: my-source-python-code-samples
codeSamplesRevisionDigest: sha256:06fc180ad0f496ce01459cc965e47d9c73051b3339c4ffa34dd99997da5e2bf9
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
sources:
my-source:
inputs:
- location: ./airbyte-api.openapi.yaml
- location: https://raw.githubusercontent.com/airbytehq/airbyte-platform/refs/heads/main/airbyte-api/server-api/src/main/openapi/api_sdk.yaml
registry:
location: registry.speakeasyapi.dev/airbyte/airbyte-prod/my-source
targets:
Expand All @@ -30,3 +32,7 @@ workflow:
publish:
pypi:
token: $PYPI_TOKEN
codeSamples:
registry:
location: registry.speakeasyapi.dev/airbyte/airbyte-prod/my-source-python-code-samples
blocking: false
4 changes: 4 additions & 0 deletions .speakeasy/workflow.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,7 @@ targets:
publish:
pypi:
token: $PYPI_TOKEN
codeSamples:
registry:
location: registry.speakeasyapi.dev/airbyte/airbyte-prod/my-source-python-code-samples
blocking: false
104 changes: 39 additions & 65 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,21 @@ The Developer Portal UI can also be used to help build your integration by showi
<!-- Start Summary [summary] -->
## Summary

airbyte-api: Programatically control Airbyte Cloud, OSS & Enterprise.
airbyte-api: Programmatically control Airbyte Cloud, OSS & Enterprise.
<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [Authentication](#authentication)
* [SDK Installation](#sdk-installation)
* [SDK Example Usage](#sdk-example-usage)
* [Available Resources and Operations](#available-resources-and-operations)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Custom HTTP Client](#custom-http-client)
* [Authentication](#authentication-1)

* [SDK Installation](#sdk-installation)
* [SDK Example Usage](#sdk-example-usage)
* [Available Resources and Operations](#available-resources-and-operations)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Custom HTTP Client](#custom-http-client)
* [Authentication](#authentication)
<!-- End Table of Contents [toc] -->

<!-- Start SDK Installation [installation] -->
Expand All @@ -53,8 +55,8 @@ from airbyte_api import models
s = airbyte_api.AirbyteAPI(
security=models.Security(
basic_auth=models.SchemeBasicAuth(
password="",
username="",
password='',
username='',
),
),
)
Expand Down Expand Up @@ -160,11 +162,22 @@ if res.connection_response is not None:
<!-- Start Error Handling [errors] -->
## Error Handling

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.
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.

| Error Object | Status Code | Content Type |
| --------------- | --------------- | --------------- |
| errors.SDKError | 4xx-5xx | */* |
By default, an API error will raise a errors.SDKError exception, which has the following properties:

| Property | Type | Description |
|-----------------|------------------|-----------------------|
| `.status_code` | *int* | The HTTP status code |
| `.message` | *str* | The error message |
| `.raw_response` | *httpx.Response* | The raw HTTP response |
| `.body` | *str* | The response content |

When custom error responses are specified for an operation, the SDK may also raise their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `create_connection` method may raise the following exceptions:

| Error Type | Status Code | Content Type |
| --------------- | ----------- | ------------ |
| errors.SDKError | 4XX, 5XX | \*/\* |

### Example

Expand All @@ -175,8 +188,8 @@ from airbyte_api import errors, models
s = airbyte_api.AirbyteAPI(
security=models.Security(
basic_auth=models.SchemeBasicAuth(
password="",
username="",
password='',
username='',
),
),
)
Expand Down Expand Up @@ -206,45 +219,6 @@ if res.connection_response is not None:
<!-- Start Server Selection [server] -->
## Server Selection

### Select Server by Index

You can override the default server globally by passing a server index to the `server_idx: int` 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 indexes associated with the available servers:

| # | Server | Variables |
| - | ------ | --------- |
| 0 | `https://api.airbyte.com/v1` | None |

#### Example

```python
import airbyte_api
from airbyte_api import models

s = airbyte_api.AirbyteAPI(
server_idx=0,
security=models.Security(
basic_auth=models.SchemeBasicAuth(
password="",
username="",
),
),
)


res = s.connections.create_connection(request=models.ConnectionCreateRequest(
destination_id='e478de0d-a3a0-475c-b019-25f7dd29e281',
source_id='95e66a59-8045-4307-9678-63bc3c9b8c93',
name='Postgres-to-Bigquery',
namespace_format='${SOURCE_NAMESPACE}',
))

if res.connection_response is not None:
# handle response
pass

```


### Override Server URL Per-Client

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:
Expand All @@ -253,11 +227,11 @@ import airbyte_api
from airbyte_api import models

s = airbyte_api.AirbyteAPI(
server_url="https://api.airbyte.com/v1",
server_url='https://api.airbyte.com/v1',
security=models.Security(
basic_auth=models.SchemeBasicAuth(
password="",
username="",
password='',
username='',
),
),
)
Expand Down Expand Up @@ -304,11 +278,11 @@ s = airbyte_api.AirbyteAPI(client=http_client)

This SDK supports the following security schemes globally:

| Name | Type | Scheme |
| -------------------- | -------------------- | -------------------- |
| `basic_auth` | http | HTTP Basic |
| `bearer_auth` | http | HTTP Bearer |
| `client_credentials` | oauth2 | OAuth2 token |
| Name | Type | Scheme |
| -------------------- | ------ | ------------ |
| `basic_auth` | http | HTTP Basic |
| `bearer_auth` | http | HTTP Bearer |
| `client_credentials` | oauth2 | OAuth2 token |

You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
```python
Expand All @@ -318,8 +292,8 @@ from airbyte_api import models
s = airbyte_api.AirbyteAPI(
security=models.Security(
basic_auth=models.SchemeBasicAuth(
password="",
username="",
password='',
username='',
),
),
)
Expand Down
12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -958,4 +958,14 @@ Based on:
### Generated
- [python v0.52.1] .
### Releases
- [PyPI v0.52.1] https://pypi.org/project/airbyte-api/0.52.1 - .
- [PyPI v0.52.1] https://pypi.org/project/airbyte-api/0.52.1 - .

## 2024-12-11 00:19:25
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.453.10 (2.474.15) https://github.com/speakeasy-api/speakeasy
### Generated
- [python v0.52.2] .
### Releases
- [PyPI v0.52.2] https://pypi.org/project/airbyte-api/0.52.2 - .
4 changes: 2 additions & 2 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ from airbyte_api import models
s = airbyte_api.AirbyteAPI(
security=models.Security(
basic_auth=models.SchemeBasicAuth(
password="",
username="",
password='',
username='',
),
),
)
Expand Down
Loading

0 comments on commit 7884557

Please sign in to comment.