Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 30 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ pip install airbyte-api
<!-- Start SDK Example Usage -->
```python
import airbyte
from airbyte.models import operations, shared
from airbyte.models import shared

s = airbyte.Airbyte(
security=shared.Security(
Expand Down Expand Up @@ -109,7 +109,7 @@ req = shared.ConnectionCreateRequest(
),
source_id="c5955907-aff1-4a3a-afa9-467739251aa5",
)

res = s.connections.create_connection(req)

if res.connection_response is not None:
Expand All @@ -121,45 +121,45 @@ if res.connection_response is not None:
## Available Resources and Operations


### connections
### [connections](docs/connections/README.md)

* `create_connection` - Create a connection
* `delete_connection` - Delete a Connection
* `get_connection` - Get Connection details
* `list_connections` - List connections
* [create_connection](docs/connections/README.md#create_connection) - Create a connection
* [delete_connection](docs/connections/README.md#delete_connection) - Delete a Connection
* [get_connection](docs/connections/README.md#get_connection) - Get Connection details
* [list_connections](docs/connections/README.md#list_connections) - List connections

### destinations
### [destinations](docs/destinations/README.md)

* `create_destination` - Create a destination
* `delete_destination` - Delete a Destination
* `get_destination` - Get Destination details
* `list_destinations` - List destinations
* [create_destination](docs/destinations/README.md#create_destination) - Create a destination
* [delete_destination](docs/destinations/README.md#delete_destination) - Delete a Destination
* [get_destination](docs/destinations/README.md#get_destination) - Get Destination details
* [list_destinations](docs/destinations/README.md#list_destinations) - List destinations

### jobs
### [jobs](docs/jobs/README.md)

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

### sources
### [sources](docs/sources/README.md)

* `create_source` - Create a source
* `delete_source` - Delete a Source
* `get_source` - Get Source details
* `initiate_o_auth` - Initiate OAuth for a source
* `list_sources` - List sources
* [create_source](docs/sources/README.md#create_source) - Create a source
* [delete_source](docs/sources/README.md#delete_source) - Delete a Source
* [get_source](docs/sources/README.md#get_source) - Get Source details
* [initiate_o_auth](docs/sources/README.md#initiate_o_auth) - Initiate OAuth for a source
* [list_sources](docs/sources/README.md#list_sources) - List sources

### streams
### [streams](docs/streams/README.md)

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

### workspaces
### [workspaces](docs/workspaces/README.md)

* `create_or_update_workspace_o_auth_credentials` - Create OAuth override credentials for a workspace and source type.
* `create_workspace` - Create a workspace
* `get_workspace` - Get Workspace details
* `list_workspaces` - List workspaces
* [create_or_update_workspace_o_auth_credentials](docs/workspaces/README.md#create_or_update_workspace_o_auth_credentials) - Create OAuth override credentials for a workspace and source type.
* [create_workspace](docs/workspaces/README.md#create_workspace) - Create a workspace
* [get_workspace](docs/workspaces/README.md#get_workspace) - Get Workspace details
* [list_workspaces](docs/workspaces/README.md#list_workspaces) - List workspaces
<!-- End SDK Available Operations -->

### Maturity
Expand Down
18 changes: 17 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,20 @@ Based on:
- OpenAPI Doc 1.0.0 https://prod.speakeasyapi.dev/v1/apis/public-api/version/v0.1.0/schema/download
- Speakeasy CLI 1.22.2 (2.20.1) https://github.com/speakeasy-api/speakeasy
### Releases
- [PyPI v0.1.0] https://pypi.org/project/airbyte-api/0.1.0 - .
- [PyPI v0.1.0] https://pypi.org/project/airbyte-api/0.1.0 - .

## 2023-04-26 00:13:09
### Changes
Based on:
- OpenAPI Doc 1.0.0 https://prod.speakeasyapi.dev/v1/apis/public-api/version/v0.1.0/schema/download
- Speakeasy CLI 1.23.1 (2.21.1) https://github.com/speakeasy-api/speakeasy
### Releases
- [PyPI v0.2.0] https://pypi.org/project/airbyte-api/0.2.0 - .

## 2023-04-27 00:14:16
### Changes
Based on:
- OpenAPI Doc 1.0.0 https://prod.speakeasyapi.dev/v1/apis/public-api/version/v0.1.0/schema/download
- Speakeasy CLI 1.25.1 (2.22.0) https://github.com/speakeasy-api/speakeasy
### Releases
- [PyPI v0.3.0] https://pypi.org/project/airbyte-api/0.3.0 - .
4 changes: 2 additions & 2 deletions USAGE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- Start SDK Example Usage -->
```python
import airbyte
from airbyte.models import operations, shared
from airbyte.models import shared

s = airbyte.Airbyte(
security=shared.Security(
Expand Down Expand Up @@ -85,7 +85,7 @@ req = shared.ConnectionCreateRequest(
),
source_id="c5955907-aff1-4a3a-afa9-467739251aa5",
)

res = s.connections.create_connection(req)

if res.connection_response is not None:
Expand Down
4 changes: 4 additions & 0 deletions docs/airbyte/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Airbyte SDK

### Available Operations

161 changes: 161 additions & 0 deletions docs/connections/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
# connections

### Available Operations

* [create_connection](#create_connection) - Create a connection
* [delete_connection](#delete_connection) - Delete a Connection
* [get_connection](#get_connection) - Get Connection details
* [list_connections](#list_connections) - List connections

## create_connection

Create a connection

### Example Usage

```python
import airbyte
from airbyte.models import shared

s = airbyte.Airbyte(
security=shared.Security(
bearer_auth="Bearer YOUR_BEARER_TOKEN_HERE",
),
)


req = shared.ConnectionCreateRequest(
configurations=shared.StreamConfigurations(
streams=[
shared.StreamConfiguration(
cursor_field=[
"sequi",
"tenetur",
"ipsam",
"id",
],
name="Richard Boyer",
primary_key=[
[
"reiciendis",
],
[
"vero",
"nihil",
"praesentium",
"voluptatibus",
],
[
"omnis",
],
],
sync_mode="full_refresh_append",
),
],
),
data_residency="eu",
destination_id="0074f154-71b5-4e6e-93b9-9d488e1e91e4",
name="Elizabeth Orn",
namespace_definition="destination",
namespace_format="${SOURCE_NAMESPACE}",
prefix="distinctio",
schedule=shared.ConnectionScheduleCreate(
cron_expression="quibusdam",
schedule_type="manual",
),
source_id="4269802d-502a-494b-b4f6-3c969e9a3efa",
)

res = s.connections.create_connection(req)

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

## delete_connection

Delete a Connection

### Example Usage

```python
import airbyte
from airbyte.models import operations

s = airbyte.Airbyte(
security=shared.Security(
bearer_auth="Bearer YOUR_BEARER_TOKEN_HERE",
),
)


req = operations.DeleteConnectionRequest(
connection_id="in",
)

res = s.connections.delete_connection(req)

if res.status_code == 200:
# handle response
```

## get_connection

Get Connection details

### Example Usage

```python
import airbyte
from airbyte.models import operations

s = airbyte.Airbyte(
security=shared.Security(
bearer_auth="Bearer YOUR_BEARER_TOKEN_HERE",
),
)


req = operations.GetConnectionRequest(
connection_id="in",
)

res = s.connections.get_connection(req)

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

## list_connections

List connections

### Example Usage

```python
import airbyte
from airbyte.models import operations

s = airbyte.Airbyte(
security=shared.Security(
bearer_auth="Bearer YOUR_BEARER_TOKEN_HERE",
),
)


req = operations.ListConnectionsRequest(
include_deleted=False,
limit=846409,
offset=978571,
workspace_ids=[
"14cd66ae-395e-4fb9-ba88-f3a66997074b",
"a4469b6e-2141-4959-890a-fa563e2516fe",
"4c8b711e-5b7f-4d2e-9028-921cddc69260",
],
)

res = s.connections.list_connections(req)

if res.connections_response is not None:
# handle response
```
Loading