airbyte-api 0.53.0
Python Client SDK for Airbyte API
Requires Python: >=3.8

<div align="center">
        <img src="https://user-images.githubusercontent.com/68016351/222853569-b35cc448-6481-4cf2-a237-bd5da47e94fd.png" width="500">
   <p>Programatically control Airbyte Cloud through an API.</p>
   <a href="https://reference.airbyte.com/reference/start"><img src="https://img.shields.io/static/v1?label=Docs&message=API Ref&color=000000&style=for-the-badge" /></a>
   <a href="https://github.com/airbytehq/airbyte-api-python-sdk/actions"><img src="https://img.shields.io/github/actions/workflow/status/airbytehq/airbyte-api-python-sdk/speakeasy_sdk_generation.yml?style=for-the-badge" /></a>
  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge" /></a>
  <a href="https://github.com/airbytehq/airbyte-api-python-sdk/releases"><img src="https://img.shields.io/github/v/release/airbytehq/airbyte-api-python-sdk?sort=semver&style=for-the-badge" /></a>
</div>

## Authentication

Developers will need to create an API Key within your [Developer Portal](https://portal.airbyte.com/) to make API requests. You can use your existing Airbyte account to log in to the Developer Portal. Once you are in the Developer Portal, use the API Keys tab to create or remove API Keys. You can see a [walkthrough demo here](https://www.loom.com/share/7997a7c67cd642cc8d1c72ef0dfcc4bc)🎦

The Developer Portal UI can also be used to help build your integration by showing information about network requests in the Requests tab. API usage information is also available to you in the Usage tab.

<!-- Start Summary [summary] -->
## Summary

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

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

<!-- End Table of Contents [toc] -->

<!-- Start SDK Installation [installation] -->
## SDK Installation

The SDK can be installed using the *pip* package manager, with dependencies and metadata stored in the `setup.py` file.

```bash
pip install airbyte-api
```
<!-- End SDK Installation [installation] -->

<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage

### Example

```python
import airbyte_api
from airbyte_api import models

s = airbyte_api.AirbyteAPI(
    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',
))

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

```
<!-- End SDK Example Usage [usage] -->

<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations

<details open>
<summary>Available methods</summary>


### [connections](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/connections/README.md)

* [create_connection](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/connections/README.md#create_connection) - Create a connection
* [delete_connection](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/connections/README.md#delete_connection) - Delete a Connection
* [get_connection](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/connections/README.md#get_connection) - Get Connection details
* [list_connections](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/connections/README.md#list_connections) - List connections
* [patch_connection](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/connections/README.md#patch_connection) - Update Connection details

### [declarative_source_definitions](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/declarativesourcedefinitions/README.md)

* [create_declarative_source_definition](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/declarativesourcedefinitions/README.md#create_declarative_source_definition) - Create a declarative source definition.
* [delete_declarative_source_definition](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/declarativesourcedefinitions/README.md#delete_declarative_source_definition) - Delete a declarative source definition.
* [get_declarative_source_definition](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/declarativesourcedefinitions/README.md#get_declarative_source_definition) - Get declarative source definition details.
* [list_declarative_source_definitions](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/declarativesourcedefinitions/README.md#list_declarative_source_definitions) - List declarative source definitions.
* [update_declarative_source_definition](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/declarativesourcedefinitions/README.md#update_declarative_source_definition) - Update declarative source definition details.

### [destination_definitions](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/destinationdefinitions/README.md)

* [create_destination_definition](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/destinationdefinitions/README.md#create_destination_definition) - Create a destination definition.
* [delete_destination_definition](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/destinationdefinitions/README.md#delete_destination_definition) - Delete a destination definition.
* [get_destination_definition](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/destinationdefinitions/README.md#get_destination_definition) - Get destination definition details.
* [list_destination_definitions](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/destinationdefinitions/README.md#list_destination_definitions) - List destination definitions.
* [update_destination_definition](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/destinationdefinitions/README.md#update_destination_definition) - Update destination definition details.

### [destinations](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/destinations/README.md)

* [create_destination](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/destinations/README.md#create_destination) - Create a destination
* [delete_destination](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/destinations/README.md#delete_destination) - Delete a Destination
* [get_destination](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/destinations/README.md#get_destination) - Get Destination details
* [list_destinations](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/destinations/README.md#list_destinations) - List destinations
* [patch_destination](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/destinations/README.md#patch_destination) - Update a Destination
* [put_destination](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/destinations/README.md#put_destination) - Update a Destination and fully overwrite it

### [health](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/health/README.md)

* [get_health_check](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/health/README.md#get_health_check) - Health Check

### [jobs](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/jobs/README.md)

* [cancel_job](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/jobs/README.md#cancel_job) - Cancel a running Job
* [create_job](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/jobs/README.md#create_job) - Trigger a sync or reset job of a connection
* [get_job](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/jobs/README.md#get_job) - Get Job status and details
* [list_jobs](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/jobs/README.md#list_jobs) - List Jobs by sync type

### [organizations](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/organizations/README.md)

* [create_or_update_organization_o_auth_credentials](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/organizations/README.md#create_or_update_organization_o_auth_credentials) - Create OAuth override credentials for an organization and source type.
* [list_organizations_for_user](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/organizations/README.md#list_organizations_for_user) - List all organizations for a user

### [permissions](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/permissions/README.md)

* [create_permission](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/permissions/README.md#create_permission) - Create a permission
* [delete_permission](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/permissions/README.md#delete_permission) - Delete a Permission
* [get_permission](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/permissions/README.md#get_permission) - Get Permission details
* [list_permissions](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/permissions/README.md#list_permissions) - List Permissions by user id
* [update_permission](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/permissions/README.md#update_permission) - Update a permission

### [source_definitions](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/sourcedefinitions/README.md)

* [create_source_definition](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/sourcedefinitions/README.md#create_source_definition) - Create a source definition.
* [delete_source_definition](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/sourcedefinitions/README.md#delete_source_definition) - Delete a source definition.
* [get_source_definition](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/sourcedefinitions/README.md#get_source_definition) - Get source definition details.
* [list_source_definitions](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/sourcedefinitions/README.md#list_source_definitions) - List source definitions.
* [update_source_definition](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/sourcedefinitions/README.md#update_source_definition) - Update source definition details.

### [sources](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/sources/README.md)

* [create_source](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/sources/README.md#create_source) - Create a source
* [delete_source](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/sources/README.md#delete_source) - Delete a Source
* [get_source](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/sources/README.md#get_source) - Get Source details
* [initiate_o_auth](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/sources/README.md#initiate_o_auth) - Initiate OAuth for a source
* [list_sources](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/sources/README.md#list_sources) - List sources
* [patch_source](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/sources/README.md#patch_source) - Update a Source
* [put_source](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/sources/README.md#put_source) - Update a Source and fully overwrite it

### [streams](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/streams/README.md)

* [get_stream_properties](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/streams/README.md#get_stream_properties) - Get stream properties

### [tags](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/tags/README.md)

* [create_tag](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/tags/README.md#create_tag) - Create a tag
* [delete_tag](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/tags/README.md#delete_tag) - Delete a tag
* [get_tag](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/tags/README.md#get_tag) - Get a tag
* [list_tags](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/tags/README.md#list_tags) - List all tags
* [update_tag](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/tags/README.md#update_tag) - Update a tag

### [users](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/users/README.md)

* [list_users_within_an_organization](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/users/README.md#list_users_within_an_organization) - List all users within an organization

### [workspaces](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/workspaces/README.md)

* [create_or_update_workspace_o_auth_credentials](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/workspaces/README.md#create_or_update_workspace_o_auth_credentials) - Create OAuth override credentials for a workspace and source type.
* [create_workspace](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/workspaces/README.md#create_workspace) - Create a workspace
* [delete_workspace](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/workspaces/README.md#delete_workspace) - Delete a Workspace
* [get_workspace](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/workspaces/README.md#get_workspace) - Get Workspace details
* [list_workspaces](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/workspaces/README.md#list_workspaces) - List workspaces
* [update_workspace](https://github.com/airbytehq/airbyte-api-python-sdk/blob/master/docs/sdks/workspaces/README.md#update_workspace) - Update a workspace

</details>
<!-- End Available Resources and Operations [operations] -->







<!-- 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 exception.

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

```python
import airbyte_api
from airbyte_api import errors, models

s = airbyte_api.AirbyteAPI(
    security=models.Security(
        basic_auth=models.SchemeBasicAuth(
            password='',
            username='',
        ),
    ),
)

res = None
try:
    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',
))

except errors.SDKError as e:
    # handle exception
    raise(e)

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

```
<!-- End Error Handling [errors] -->



<!-- Start Server Selection [server] -->
## Server Selection

### Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the `server_url: str` optional parameter when initializing the SDK client instance. For example:
```python
import airbyte_api
from airbyte_api import models

s = airbyte_api.AirbyteAPI(
    server_url='https://api.airbyte.com/v1',
    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',
))

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

```
<!-- End Server Selection [server] -->



<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client

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.

For example, you could specify a header for every request that this sdk makes as follows:
```python
import airbyte_api
import requests

http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = airbyte_api.AirbyteAPI(client=http_client)
```
<!-- End Custom HTTP Client [http-client] -->



<!-- Start Authentication [security] -->
## Authentication

### Per-Client Security Schemes

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 |

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
import airbyte_api
from airbyte_api import models

s = airbyte_api.AirbyteAPI(
    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',
))

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

```
<!-- End Authentication [security] -->

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



### Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
looking for the latest version.

### Contributions

While we value open-source contributions to this SDK, this library is generated programmatically.
Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release !

### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)