README.md

Workspaces

Overview

Available Operations

• create_or_update_workspace_o_auth_credentials - Create OAuth override credentials for a workspace and source type.
• create_workspace - Create a workspace
• delete_workspace - Delete a Workspace
• delete_workspace_o_auth_credentials - Delete OAuth override credentials for a workspace and source/destination type.
• get_workspace - Get Workspace details
• list_workspaces - List workspaces
• update_workspace - Update a workspace

create_or_update_workspace_o_auth_credentials

Create/update a set of OAuth credentials to override the Airbyte-provided OAuth credentials used for source/destination OAuth. In order to determine what the credential configuration needs to be, please see the connector specification of the relevant source/destination.

Example Usage

from airbyte_api import AirbyteAPI, models


with AirbyteAPI(
    security=models.Security(
        basic_auth=models.SchemeBasicAuth(
            password="",
            username="",
        ),
    ),
) as aa_client:

    res = aa_client.workspaces.create_or_update_workspace_o_auth_credentials(request={
        "workspace_o_auth_credentials_request": {
            "actor_type": models.ActorTypeEnum.DESTINATION,
            "configuration": {

            },
            "name": models.OAuthActorNames.TRELLO,
        },
        "workspace_id": "<value>",
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
request	api.CreateOrUpdateWorkspaceOAuthCredentialsRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

api.CreateOrUpdateWorkspaceOAuthCredentialsResponse

Errors

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

create_workspace

Create a workspace

Example Usage: Workspace Creation Request Example

from airbyte_api import AirbyteAPI, models


with AirbyteAPI(
    security=models.Security(
        basic_auth=models.SchemeBasicAuth(
            password="",
            username="",
        ),
    ),
) as aa_client:

    res = aa_client.workspaces.create_workspace(request=models.WorkspaceCreateRequest(
        name="Company Workspace Name",
    ))

    assert res.workspace_response is not None

    # Handle response
    print(res.workspace_response)

Example Usage: Workspace Creation Response Example

from airbyte_api import AirbyteAPI, models


with AirbyteAPI(
    security=models.Security(
        basic_auth=models.SchemeBasicAuth(
            password="",
            username="",
        ),
    ),
) as aa_client:

    res = aa_client.workspaces.create_workspace(request=models.WorkspaceCreateRequest(
        name="<value>",
    ))

    assert res.workspace_response is not None

    # Handle response
    print(res.workspace_response)

Parameters

Parameter	Type	Required	Description
request	models.WorkspaceCreateRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

api.CreateWorkspaceResponse

Errors

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

delete_workspace

Delete a Workspace

Example Usage

from airbyte_api import AirbyteAPI, models


with AirbyteAPI(
    security=models.Security(
        basic_auth=models.SchemeBasicAuth(
            password="",
            username="",
        ),
    ),
) as aa_client:

    res = aa_client.workspaces.delete_workspace(request={
        "workspace_id": "<value>",
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
request	api.DeleteWorkspaceRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

api.DeleteWorkspaceResponse

Errors

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

delete_workspace_o_auth_credentials

Delete a set of OAuth credentials that overrides the Airbyte-provided OAuth credentials used for source/destination OAuth.

🚧 Warning

Deleting an override that is actively used by existing sources or destinations will cause those connectors to fail on their next sync and require re-authentication.

Example Usage

from airbyte_api import AirbyteAPI, models


with AirbyteAPI(
    security=models.Security(
        basic_auth=models.SchemeBasicAuth(
            password="",
            username="",
        ),
    ),
) as aa_client:

    res = aa_client.workspaces.delete_workspace_o_auth_credentials(request={
        "actor_type": models.ActorTypeEnum.SOURCE,
        "name": "<value>",
        "workspace_id": "<value>",
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
request	api.DeleteWorkspaceOAuthCredentialsRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

api.DeleteWorkspaceOAuthCredentialsResponse

Errors

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

get_workspace

Get Workspace details

Example Usage

from airbyte_api import AirbyteAPI, models


with AirbyteAPI(
    security=models.Security(
        basic_auth=models.SchemeBasicAuth(
            password="",
            username="",
        ),
    ),
) as aa_client:

    res = aa_client.workspaces.get_workspace(request={
        "workspace_id": "<value>",
    })

    assert res.workspace_response is not None

    # Handle response
    print(res.workspace_response)

Parameters

Parameter	Type	Required	Description
request	api.GetWorkspaceRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

api.GetWorkspaceResponse

Errors

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

list_workspaces

List workspaces

Example Usage

from airbyte_api import AirbyteAPI, models


with AirbyteAPI(
    security=models.Security(
        basic_auth=models.SchemeBasicAuth(
            password="",
            username="",
        ),
    ),
) as aa_client:

    res = aa_client.workspaces.list_workspaces(request={})

    assert res.workspaces_response is not None

    # Handle response
    print(res.workspaces_response)

Parameters

Parameter	Type	Required	Description
request	api.ListWorkspacesRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

api.ListWorkspacesResponse

Errors

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

update_workspace

Update a workspace

Example Usage: Workspace Update Request Example

from airbyte_api import AirbyteAPI, api, models


with AirbyteAPI(
    security=models.Security(
        basic_auth=models.SchemeBasicAuth(
            password="",
            username="",
        ),
    ),
) as aa_client:

    res = aa_client.workspaces.update_workspace(request=api.UpdateWorkspaceRequest(
        workspace_update_request=models.WorkspaceUpdateRequest(
            name="Company Workspace Name",
        ),
        workspace_id="<value>",
    ))

    assert res.workspace_response is not None

    # Handle response
    print(res.workspace_response)

Example Usage: Workspace Update Response Example

from airbyte_api import AirbyteAPI, api, models


with AirbyteAPI(
    security=models.Security(
        basic_auth=models.SchemeBasicAuth(
            password="",
            username="",
        ),
    ),
) as aa_client:

    res = aa_client.workspaces.update_workspace(request=api.UpdateWorkspaceRequest(
        workspace_update_request=models.WorkspaceUpdateRequest(),
        workspace_id="<value>",
    ))

    assert res.workspace_response is not None

    # Handle response
    print(res.workspace_response)

Parameters

Parameter	Type	Required	Description
request	api.UpdateWorkspaceRequest	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

api.UpdateWorkspaceResponse

Errors

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