### SourceGitlabOAuth20 Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcegitlabauthorizationmethod.md Example of how to use the SourceGitlabOAuth20 model. Replace '/* values here */' with actual configuration values. ```python value: models.SourceGitlabOAuth20 = /* values here */ ``` -------------------------------- ### Create Destination Response Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/sdks/destinations/README.md This snippet demonstrates how to handle the response after creating a destination. It uses a different configuration example for demonstration. ```python from airbyte_api import AirbyteAPI, models with AirbyteAPI( security=models.Security( basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) as aa_client: res = aa_client.destinations.create_destination(request=models.DestinationCreateRequest( configuration=models.DestinationTimeplus( apikey="", endpoint="https://us-west-2.timeplus.cloud/workspace_id", ), name="", workspace_id="dc693cc0-960d-4c6c-9d1b-05e8bf0c96ba", )) assert res.destination_response is not None # Handle response print(res.destination_response) ``` -------------------------------- ### Create Source Response Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/sdks/sources/README.md This example demonstrates how to handle the response after creating a source. It shows the structure of the successful response, including the source details. ```python from airbyte_api import AirbyteAPI, models with AirbyteAPI( security=models.Security( basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) as aa_client: res = aa_client.sources.create_source(request=models.SourceCreateRequest( configuration=models.SourceMailerlite( api_token="", ), name="", workspace_id="5923d04d-a31f-43ea-8396-170b96449103", )) assert res.source_response is not None # Handle response print(res.source_response) ``` -------------------------------- ### Instantiate SourceQuickbooks Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceQuickbooks model. ```python value: models.SourceQuickbooks = /* values here */ ``` -------------------------------- ### Instantiate SourceRentcast Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRentcast model. ```python value: models.SourceRentcast = /* values here */ ``` -------------------------------- ### Instantiate SourceRdStationMarketing Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRdStationMarketing model. ```python value: models.SourceRdStationMarketing = /* values here */ ``` -------------------------------- ### Instantiate SourceProductboard Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceProductboard model. ```python value: models.SourceProductboard = /* values here */ ``` -------------------------------- ### Instantiate SourceSecoda Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceSecoda model. ```python value: models.SourceSecoda = /* values here */ ``` -------------------------------- ### Install Airbyte API SDK with uv Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/README.md Install the SDK using the uv package manager. uv is a fast Python package installer and resolver. ```bash uv add airbyte-api ``` -------------------------------- ### Instantiate SourceS3 Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceS3 model. ```python value: models.SourceS3 = /* values here */ ``` -------------------------------- ### Instantiate SourceSalesloft Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceSalesloft model. ```python value: models.SourceSalesloft = /* values here */ ``` -------------------------------- ### Instantiate SourceRkiCovid Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRkiCovid model. ```python value: models.SourceRkiCovid = /* values here */ ``` -------------------------------- ### Instantiate SourcePrestashop Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourcePrestashop model. ```python value: models.SourcePrestashop = /* values here */ ``` -------------------------------- ### Instantiate SourceSalesforce Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceSalesforce model. ```python value: models.SourceSalesforce = /* values here */ ``` -------------------------------- ### Install Airbyte API SDK with pip Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/README.md Install the SDK using pip, the default package installer for Python. ```bash pip install airbyte-api ``` -------------------------------- ### Instantiate SourcePretix Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourcePretix model. ```python value: models.SourcePretix = /* values here */ ``` -------------------------------- ### Install Airbyte API SDK with Poetry Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/README.md Install the SDK using Poetry, a tool for dependency management and package publishing. ```bash poetry add airbyte-api ``` -------------------------------- ### Instantiate SourceReplyIo Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceReplyIo model. ```python value: models.SourceReplyIo = /* values here */ ``` -------------------------------- ### Instantiate SourcePypi Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourcePypi model. ```python value: models.SourcePypi = /* values here */ ``` -------------------------------- ### Instantiate SourcePostmarkapp Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourcePostmarkapp model. ```python value: models.SourcePostmarkapp = /* values here */ ``` -------------------------------- ### Instantiate SourceRecreation Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRecreation model. ```python value: models.SourceRecreation = /* values here */ ``` -------------------------------- ### Instantiate SourceSegment Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceSegment model. ```python value: models.SourceSegment = /* values here */ ``` -------------------------------- ### Instantiate SourcePrintify Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourcePrintify model. ```python value: models.SourcePrintify = /* values here */ ``` -------------------------------- ### SourceGitlabPrivateToken Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcegitlabauthorizationmethod.md Example of how to use the SourceGitlabPrivateToken model. Replace '/* values here */' with actual configuration values. ```python value: models.SourceGitlabPrivateToken = /* values here */ ``` -------------------------------- ### Instantiate SourceRepairshopr Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRepairshopr model. ```python value: models.SourceRepairshopr = /* values here */ ``` -------------------------------- ### Instantiate SourceRootly Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRootly model. ```python value: models.SourceRootly = /* values here */ ``` -------------------------------- ### Instantiate SourceRecruitee Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRecruitee model. ```python value: models.SourceRecruitee = /* values here */ ``` -------------------------------- ### Create Job Response Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/sdks/jobs/README.md Illustrates the response structure after creating a sync job. This example shows how to access the job details from the response object. ```python from airbyte_api import AirbyteAPI, models with AirbyteAPI( security=models.Security( basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) as aa_client: res = aa_client.jobs.create_job(request={ "connection_id": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826", "job_type": models.JobTypeEnum.SYNC, }) assert res.job_response is not None # Handle response print(res.job_response) ``` -------------------------------- ### Instantiate SourceRingcentral Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRingcentral model. ```python value: models.SourceRingcentral = /* values here */ ``` -------------------------------- ### Instantiate SourceSapHanaEnterprise Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceSapHanaEnterprise model. ```python value: models.SourceSapHanaEnterprise = /* values here */ ``` -------------------------------- ### Instantiate SourcePostgres Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourcePostgres model. ```python value: models.SourcePostgres = /* values here */ ``` -------------------------------- ### Instantiate SourceRollbar Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRollbar model. ```python value: models.SourceRollbar = /* values here */ ``` -------------------------------- ### Instantiate SourceSendgrid Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceSendgrid model. ```python value: models.SourceSendgrid = /* values here */ ``` -------------------------------- ### Update Source Response Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/sdks/sources/README.md This example demonstrates updating a source with specific Firebolt configuration details. It includes placeholders for sensitive information like client secrets and database credentials. ```python from airbyte_api import AirbyteAPI, api, models with AirbyteAPI( security=models.Security( basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) as aa_client: res = aa_client.sources.patch_source(request=api.PatchSourceRequest( source_patch_request=models.SourcePatchRequest( configuration=models.SourceFirebolt( account="95324582", client_id="bbl9qth066hmxkwyb0hy2iwk8ktez9dz", client_secret="", database="", engine="", ), name="My source", ), source_id="", )) assert res.source_response is not None # Handle response print(res.source_response) ``` -------------------------------- ### Instantiate SourceSalesflare Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceSalesflare model. ```python value: models.SourceSalesflare = /* values here */ ``` -------------------------------- ### Instantiate SourcePoplar Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourcePoplar model. ```python value: models.SourcePoplar = /* values here */ ``` -------------------------------- ### Instantiate SourceRss Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRss model. ```python value: models.SourceRss = /* values here */ ``` -------------------------------- ### Instantiate SourceQualaroo Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceQualaroo model. ```python value: models.SourceQualaroo = /* values here */ ``` -------------------------------- ### Instantiate SourcePosthog Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourcePosthog model. ```python value: models.SourcePosthog = /* values here */ ``` -------------------------------- ### Instantiate SourceRetently Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRetently model. ```python value: models.SourceRetently = /* values here */ ``` -------------------------------- ### Instantiate SourceSendinblue Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceSendinblue model. ```python value: models.SourceSendinblue = /* values here */ ``` -------------------------------- ### Instantiate SourceRecurly Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRecurly model. ```python value: models.SourceRecurly = /* values here */ ``` -------------------------------- ### Instantiate SourcePolygonStockAPI Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourcePolygonStockAPI model. ```python value: models.SourcePolygonStockAPI = /* values here */ ``` -------------------------------- ### SourceSftpBulkUserProvided Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcesftpbulkcsvheaderdefinition.md Represents the case where the user explicitly provides headers. ```python value: models.SourceSftpBulkUserProvided = /* values here */ ``` -------------------------------- ### Instantiate SourceSageHr Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceSageHr model. ```python value: models.SourceSageHr = /* values here */ ``` -------------------------------- ### Instantiate SourceRedshift Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRedshift model. ```python value: models.SourceRedshift = /* values here */ ``` -------------------------------- ### Instantiate SourceReferralhero Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceReferralhero model. ```python value: models.SourceReferralhero = /* values here */ ``` -------------------------------- ### Instantiate SourceSapFieldglass Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceSapFieldglass model. ```python value: models.SourceSapFieldglass = /* values here */ ``` -------------------------------- ### Instantiate SourceRecharge Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRecharge model. ```python value: models.SourceRecharge = /* values here */ ``` -------------------------------- ### Instantiate SourceScryfall Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceScryfall model. ```python value: models.SourceScryfall = /* values here */ ``` -------------------------------- ### Instantiate SourceRocketlane Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRocketlane model. ```python value: models.SourceRocketlane = /* values here */ ``` -------------------------------- ### Instantiate SourceRetailexpressByMaropost Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRetailexpressByMaropost model. ```python value: models.SourceRetailexpressByMaropost = /* values here */ ``` -------------------------------- ### Instantiate SourceProductive Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceProductive model. ```python value: models.SourceProductive = /* values here */ ``` -------------------------------- ### Instantiate SourceRuddr Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRuddr model. ```python value: models.SourceRuddr = /* values here */ ``` -------------------------------- ### Instantiate SourcePrimetric Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourcePrimetric model. ```python value: models.SourcePrimetric = /* values here */ ``` -------------------------------- ### Instantiate SourceRevenuecat Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRevenuecat model. ```python value: models.SourceRevenuecat = /* values here */ ``` -------------------------------- ### Get Source Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/sdks/sources/README.md Get Source details ```APIDOC ## GET /sources/{sourceId} ### Description Get Source details. ### Method GET ### Endpoint /sources/{sourceId} ### Parameters #### Path Parameters - **sourceId** (string) - Required - #### Request Body - **retries** (Optional[utils.RetryConfig]) - Optional - Configuration to override the default retry behavior of the client. ### Response #### Success Response (200) - **source_response** (api.SourceResponse) - Description ### Errors - **errors.SDKError** (4XX, 5XX) - */* ``` -------------------------------- ### SourceDriftAccessToken Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcedriftauthorizationmethod.md Example of assigning a value to models.SourceDriftAccessToken. ```python value: models.SourceDriftAccessToken = /* values here */ ``` -------------------------------- ### Instantiate SourceReddit Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceReddit model. ```python value: models.SourceReddit = /* values here */ ``` -------------------------------- ### Source Monday Configuration Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to define a SourceMonday configuration object. ```python value: models.SourceMonday = /* values here */ ``` -------------------------------- ### SourceDriftOAuth20 Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcedriftauthorizationmethod.md Example of assigning a value to models.SourceDriftOAuth20. ```python value: models.SourceDriftOAuth20 = /* values here */ ``` -------------------------------- ### DestinationQdrantByProgrammingLanguage Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/destinationqdranttextsplitter.md Example of using DestinationQdrantByProgrammingLanguage for text splitting. ```python value: models.DestinationQdrantByProgrammingLanguage = /* values here */ ``` -------------------------------- ### Instantiate SourceRailz Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRailz model. ```python value: models.SourceRailz = /* values here */ ``` -------------------------------- ### Instantiate SourceRevolutMerchant Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRevolutMerchant model. ```python value: models.SourceRevolutMerchant = /* values here */ ``` -------------------------------- ### DestinationQdrantByMarkdownHeader Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/destinationqdranttextsplitter.md Example of using DestinationQdrantByMarkdownHeader for text splitting. ```python value: models.DestinationQdrantByMarkdownHeader = /* values here */ ``` -------------------------------- ### DestinationQdrantBySeparator Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/destinationqdranttextsplitter.md Example of using DestinationQdrantBySeparator for text splitting. ```python value: models.DestinationQdrantBySeparator = /* values here */ ``` -------------------------------- ### Create Job Request Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/sdks/jobs/README.md Demonstrates how to create a sync job for a connection. Ensure you have the AirbyteAPI client initialized with appropriate security credentials. ```python from airbyte_api import AirbyteAPI, models with AirbyteAPI( security=models.Security( basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) as aa_client: res = aa_client.jobs.create_job(request={ "connection_id": "e735894a-e773-4938-969f-45f53957b75b", "job_type": models.JobTypeEnum.SYNC, }) assert res.job_response is not None # Handle response print(res.job_response) ``` -------------------------------- ### MetricsFilterFromValueDoubleValue Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/metricsfilterfromvalue.md Example of how to use the MetricsFilterFromValueDoubleValue type. Replace /* values here */ with actual double values. ```python value: models.MetricsFilterFromValueDoubleValue = /* values here */ ``` -------------------------------- ### MetricsFilterFromValueInt64Value Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/metricsfilterfromvalue.md Example of how to use the MetricsFilterFromValueInt64Value type. Replace /* values here */ with actual integer values. ```python value: models.MetricsFilterFromValueInt64Value = /* values here */ ``` -------------------------------- ### Source Okta Configuration Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to define a SourceOkta configuration object. ```python value: models.SourceOkta = /* values here */ ``` -------------------------------- ### DimensionsFilterToValueExpressionDoubleValue2 Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/dimensionsfilterexpressiontovalue2.md Example of how to use the DimensionsFilterToValueExpressionDoubleValue2 type. Replace '/* values here */' with actual double values. ```python value: models.DimensionsFilterToValueExpressionDoubleValue2 = /* values here */ ``` -------------------------------- ### DimensionsFilterToValueExpressionInt64Value2 Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/dimensionsfilterexpressiontovalue2.md Example of how to use the DimensionsFilterToValueExpressionInt64Value2 type. Replace '/* values here */' with actual integer values. ```python value: models.DimensionsFilterToValueExpressionInt64Value2 = /* values here */ ``` -------------------------------- ### Install Pre-release Version Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/CONTRIBUTING.md Install a specific pre-release version of the airbyte-api package using pip. This is useful for testing. ```bash pip install airbyte-api==1.0.0rc1 ``` -------------------------------- ### Destinations Response Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/api/listdestinationsresponse.md This is an example of a successful response when listing destinations. It includes pagination details and a sample destination object. ```json { "next": "https://api.airbyte.com/v1/destinations?limit=5\u0026offset=10", "previous": "https://api.airbyte.com/v1/destinations?limit=5\u0026offset=0", "data": { "destinationId": "18dccc91-0ab1-4f72-9ed7-0b8fc27c5826", "name": "Analytics Team Postgres", "destinationType": "postgres", "workspaceId": "871d9b60-11d1-44cb-8c92-c246d53bf87e" } } ``` -------------------------------- ### Instantiate AWSEnvironment Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/awsenvironment.md Demonstrates how to import and use the AWSEnvironment model to set the environment to PRODUCTION. ```python from airbyte_api.models import AWSEnvironment value = AWSEnvironment.PRODUCTION ``` -------------------------------- ### Update Destination Response Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/sdks/destinations/README.md This example demonstrates how to handle the response after attempting to update a destination. It shows how to access the updated destination details. ```python from airbyte_api import AirbyteAPI, api, models with AirbyteAPI( security=models.Security( basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) as aa_client: res = aa_client.destinations.patch_destination(request=api.PatchDestinationRequest( destination_patch_request=models.DestinationPatchRequest( configuration=models.DestinationHubspot( credentials=models.DestinationHubspotOAuth( client_id="", client_secret="", refresh_token="", type=models.Type.O_AUTH, ), ), ), destination_id="", )) assert res.destination_response is not None # Handle response print(res.destination_response) ``` -------------------------------- ### Source Mysql Configuration Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to define a SourceMysql configuration object. ```python value: models.SourceMysql = /* values here */ ``` -------------------------------- ### Source Mode Configuration Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to define a SourceMode configuration object. ```python value: models.SourceMode = /* values here */ ``` -------------------------------- ### Usage Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcemicrosoftsharepointauthtypeservice.md Demonstrates how to import and use the SERVICE value from SourceMicrosoftSharepointAuthTypeService. ```python from airbyte_api.models import SourceMicrosoftSharepointAuthTypeService value = SourceMicrosoftSharepointAuthTypeService.SERVICE ``` -------------------------------- ### get_workspace Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/sdks/workspaces/README.md Get details for a specific workspace. ```APIDOC ## get_workspace ### Description Get Workspace details. ### Method GET ### Endpoint /workspaces/{workspaceId} ### Parameters #### Path Parameters - **workspaceId** (string) - Required - The ID of the workspace to retrieve. ### Response #### Success Response (200) **api.WorkspaceResponse** ### Errors - **errors.SDKError** (4XX, 5XX) - */* ``` -------------------------------- ### Instantiate SourceMysqlMysql with MYSQL Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcemysqlmysql.md Demonstrates how to import and use the SourceMysqlMysql.MYSQL value. ```python from airbyte_api.models import SourceMysqlMysql value = SourceMysqlMysql.MYSQL ``` -------------------------------- ### Source Nutshell Configuration Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to define a SourceNutshell configuration object. ```python value: models.SourceNutshell = /* values here */ ``` -------------------------------- ### Instantiate Plugin with PGOUTPUT Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/plugin.md Demonstrates how to import and use the Plugin model to specify the PGOUTPUT value. ```python from airbyte_api.models import Plugin value = Plugin.PGOUTPUT ``` -------------------------------- ### Instantiate SourceSavvycal Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceSavvycal model. ```python value: models.SourceSavvycal = /* values here */ ``` -------------------------------- ### Create Source Request Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/sdks/sources/README.md Use this snippet to create a new source by providing its name, workspace ID, and configuration details. Ensure you have the necessary authentication credentials. ```python from airbyte_api import AirbyteAPI, models with AirbyteAPI( security=models.Security( basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) as aa_client: res = aa_client.sources.create_source(request=models.SourceCreateRequest( configuration=models.SourceOnepagecrm( username="Bartholome.Rolfson90", ), name="My Source", workspace_id="744cc0ed-7f05-4949-9e60-2a814f90c035", )) assert res.source_response is not None # Handle response print(res.source_response) ``` -------------------------------- ### Initialize SourceCoinAPIEnvironment Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcecoinapienvironment.md Demonstrates how to import and assign the SANDBOX environment value from SourceCoinAPIEnvironment. ```python from airbyte_api.models import SourceCoinAPIEnvironment value = SourceCoinAPIEnvironment.SANDBOX ``` -------------------------------- ### Initialize SourceGcsParsingStrategy Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcegcsparsingstrategy.md Demonstrates how to import and assign a value to the SourceGcsParsingStrategy. Use AUTO for automatic selection, FAST for quick extraction, OCR_ONLY for better reliability, or HI_RES for maximum accuracy. ```python from airbyte_api.models import SourceGcsParsingStrategy value = SourceGcsParsingStrategy.AUTO ``` -------------------------------- ### Instantiate SourceSafetyculture Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceSafetyculture model. ```python value: models.SourceSafetyculture = /* values here */ ``` -------------------------------- ### Example Usage of ConnectionSyncModeEnum Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/connectionsyncmodeenum.md Demonstrates how to import and use the ConnectionSyncModeEnum to specify a sync mode. ```python from airbyte_api.models import ConnectionSyncModeEnum value = ConnectionSyncModeEnum.FULL_REFRESH_OVERWRITE ``` -------------------------------- ### Instantiate SourceZohoBiginDataCenter Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcezohobigindatacenter.md Demonstrates how to import and use the SourceZohoBiginDataCenter enum to specify a data center. ```python from airbyte_api.models import SourceZohoBiginDataCenter value = SourceZohoBiginDataCenter.COM ``` -------------------------------- ### Using the Shortcut Model Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/shortcut.md Demonstrates how to import and use the Shortcut model to access its predefined values. ```python from airbyte_api.models import Shortcut value = Shortcut.SHORTCUT ``` -------------------------------- ### Instantiate SourceRocketChat Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconfiguration.md Example of how to instantiate the SourceRocketChat model. ```python value: models.SourceRocketChat = /* values here */ ``` -------------------------------- ### Instantiate StorageAzBlob Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/storageazblob.md Shows how to import and use the StorageAzBlob model to access its predefined values. ```python from airbyte_api.models import StorageAzBlob value = StorageAzBlob.AZ_BLOB ``` -------------------------------- ### Instantiate SourceGcsAuthTypeClient Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcegcsauthtypeclient.md Demonstrates how to import and use the SourceGcsAuthTypeClient.CLIENT value. ```python from airbyte_api.models import SourceGcsAuthTypeClient value = SourceGcsAuthTypeClient.CLIENT ``` -------------------------------- ### Instantiate DestinationQdrantModeOpenai Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/destinationqdrantmodeopenai.md Demonstrates how to import and use the OPENAI value from DestinationQdrantModeOpenai. ```python from airbyte_api.models import DestinationQdrantModeOpenai value = DestinationQdrantModeOpenai.OPENAI ``` -------------------------------- ### Example Usage of SourceZohoCrmEnvironment Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcezohocrmenvironment.md Demonstrates how to import and use the SourceZohoCrmEnvironment enum to select the PRODUCTION environment. ```python from airbyte_api.models import SourceZohoCrmEnvironment value = SourceZohoCrmEnvironment.PRODUCTION ``` -------------------------------- ### Using NotionEnum Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/notionenum.md Example of how to import and use the NotionEnum. This is useful when specifying Notion as a source or destination. ```python from airbyte_api.models import NotionEnum value = NotionEnum.NOTION ``` -------------------------------- ### Instantiate SourceConvexConvex Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceconvexconvex.md Demonstrates how to import and use the SourceConvexConvex.CONVEX value. ```python from airbyte_api.models import SourceConvexConvex value = SourceConvexConvex.CONVEX ``` -------------------------------- ### Instantiate SourceFireboltFirebolt Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcefireboltfirebolt.md Demonstrates how to import and use the SourceFireboltFirebolt enum to represent the Firebolt source. ```python from airbyte_api.models import SourceFireboltFirebolt value = SourceFireboltFirebolt.FIREBOLT ``` -------------------------------- ### Initialize SourceMicrosoftOnedriveParsingStrategy Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcemicrosoftonedriveparsingstrategy.md Demonstrates how to import and use the AUTO value from SourceMicrosoftOnedriveParsingStrategy. ```python from airbyte_api.models import SourceMicrosoftOnedriveParsingStrategy value = SourceMicrosoftOnedriveParsingStrategy.AUTO ``` -------------------------------- ### Instantiate StorageScp Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/storagescp.md Demonstrates how to import and assign the SCP value from the StorageScp enumeration. ```python from airbyte_api.models import StorageScp value = StorageScp.SCP ``` -------------------------------- ### Instantiate SourceBigqueryBigquery Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcebigquerybigquery.md Demonstrates how to import and use the SourceBigqueryBigquery model to access its values. Use this when configuring BigQuery sources. ```python from airbyte_api.models import SourceBigqueryBigquery value = SourceBigqueryBigquery.BIGQUERY ``` -------------------------------- ### Instantiate SourceAzureBlobStorageAzureBlobStorage Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceazureblobstorageazureblobstorage.md Demonstrates how to import and use the AZURE_BLOB_STORAGE value from the SourceAzureBlobStorageAzureBlobStorage model. ```python from airbyte_api.models import SourceAzureBlobStorageAzureBlobStorage value = SourceAzureBlobStorageAzureBlobStorage.AZURE_BLOB_STORAGE ``` -------------------------------- ### Update Source Request Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/sdks/sources/README.md Demonstrates how to construct and send a request to update a source. Ensure you replace placeholder values with your actual source details and credentials. ```python from airbyte_api import AirbyteAPI, api, models with AirbyteAPI( security=models.Security( basic_auth=models.SchemeBasicAuth( password="", username="", ), ), ) as aa_client: res = aa_client.sources.put_source(request=api.PutSourceRequest( source_put_request=models.SourcePutRequest( configuration=models.SourceRailz( client_id="", secret_key="", start_date="", ), name="My Source", ), source_id="", )) assert res.source_response is not None # Handle response print(res.source_response) ``` -------------------------------- ### Initialize SourceSftpBulkParsingStrategy Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcesftpbulkparsingstrategy.md Demonstrates how to import and assign a value to SourceSftpBulkParsingStrategy. Use AUTO for automatic selection, FAST for direct text extraction, OCR_ONLY for reliable OCR, and HI_RES for the most accurate results (requires specific setup). ```python from airbyte_api.models import SourceSftpBulkParsingStrategy value = SourceSftpBulkParsingStrategy.AUTO ``` -------------------------------- ### Instantiate Appfigures Model Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/appfigures.md Shows how to import and use the Appfigures model. This is useful for setting up configurations that require the Appfigures enum. ```python from airbyte_api.models import Appfigures value = Appfigures.APPFIGURES ``` -------------------------------- ### Instantiate DestinationSnowflakeCortexModeOpenai Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/destinationsnowflakecortexmodeopenai.md Demonstrates how to import and use the DestinationSnowflakeCortexModeOpenai model to set the OpenAI destination mode. ```python from airbyte_api.models import DestinationSnowflakeCortexModeOpenai value = DestinationSnowflakeCortexModeOpenai.OPENAI ``` -------------------------------- ### Initialize SDK with Custom HTTP Client Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/README.md Configure the SDK client with a custom httpx.Client instance to manage low-level HTTP configurations like timeouts, cookies, proxies, and custom headers. ```python from airbyte_api import AirbyteAPI import httpx http_client = httpx.Client(headers={"x-custom-header": "someValue"}) s = AirbyteAPI(client=http_client) ``` -------------------------------- ### OAuth2AccessToken Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceauth0authenticationmethodunion.md Assign a value of type models.OAuth2AccessToken. ```python value: models.OAuth2AccessToken = /* values here */ ``` -------------------------------- ### OAuth2ConfidentialApplication Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourceauth0authenticationmethodunion.md Assign a value of type models.OAuth2ConfidentialApplication. ```python value: models.OAuth2ConfidentialApplication = /* values here */ ``` -------------------------------- ### Instantiate DestinationCustomerIoStorageTypeNone Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/destinationcustomeriostoragetypenone.md Demonstrates how to import and use the DestinationCustomerIoStorageTypeNone.NONE value. ```python from airbyte_api.models import DestinationCustomerIoStorageTypeNone value = DestinationCustomerIoStorageTypeNone.NONE ``` -------------------------------- ### DimensionsFilterFromValueExpressionDoubleValue1 Type Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/dimensionsfilterexpressionfromvalue1.md Example of how to use the models.DimensionsFilterFromValueExpressionDoubleValue1 type. ```python value: models.DimensionsFilterFromValueExpressionDoubleValue1 = /* values here */ ``` -------------------------------- ### DimensionsFilterFromValueExpressionInt64Value1 Type Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/dimensionsfilterexpressionfromvalue1.md Example of how to use the models.DimensionsFilterFromValueExpressionInt64Value1 type. ```python value: models.DimensionsFilterFromValueExpressionInt64Value1 = /* values here */ ``` -------------------------------- ### Get Destination Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/sdks/destinations/README.md Retrieves the details of a specific destination by its ID. ```APIDOC ## get_destination ### Description Get Destination details ### Method GET ### Endpoint /destinations/{destinationId} ### Parameters #### Path Parameters - **destinationId** (string) - Required - The ID of the destination to retrieve. #### Request Body None ### Request Example None ### Response #### Success Response (200) - **destination_response** (api.GetDestinationResponse) - Details of the retrieved destination. #### Response Example None ### Errors - errors.SDKError (4XX, 5XX) - An error occurred during the request. ``` -------------------------------- ### Instantiate PlanFree Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/planfree.md Import and use the PlanFree.FREE value to represent the free plan. ```python from airbyte_api.models import PlanFree value = PlanFree.FREE ``` -------------------------------- ### Get Permission Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/sdks/permissions/README.md Retrieves the details of a specific permission by its ID. ```APIDOC ## GET /permissions/{permissionId} ### Description Retrieves the details of a specific permission by its ID. ### Method GET ### Endpoint /permissions/{permissionId} ### Parameters #### Path Parameters - **permissionId** (string) - Required - The ID of the permission to retrieve. ### Response #### Success Response (200) - **permission_response** (api.PermissionResponse) - The details of the requested permission. #### Response Example ```json { "permission_response": { "permission_type": "WORKSPACE_READER", "user_id": "dc1309ac-0e0a-43cf-80a3-b39dea83440d", "workspace_id": "9924bcd0-99be-453d-ba47-c2c9766f7da5", "permission_id": "b2c3d4e5-f6a7-8901-2345-67890abcdef1" } } ``` ### Errors - errors.SDKError (4XX, 5XX) - An error occurred during the request. ``` -------------------------------- ### SourceSharepointEnterpriseLocal Type Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcesharepointenterpriseprocessing.md Example of how to assign a value of type models.SourceSharepointEnterpriseLocal. ```python value: models.SourceSharepointEnterpriseLocal = /* values here */ ``` -------------------------------- ### SourceNetsuiteEnterpriseNoTunnel Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcenetsuiteenterprisesshtunnelmethod.md Use this when no SSH tunnel is required for the connection. ```python value: models.SourceNetsuiteEnterpriseNoTunnel = /* values here */ ``` -------------------------------- ### SourceMssqlUnencrypted Example Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcemssqlsslmethodunion.md Use this when no encryption is required for database communication. ```python value: models.SourceMssqlUnencrypted = /* values here */ ``` -------------------------------- ### SourceDb2EnterpriseTunnelMethodNoTunnel Usage Source: https://github.com/airbytehq/airbyte-api-python-sdk/blob/main/docs/models/sourcedb2enterprisetunnelmethodnotunnel.md Example of how to use the SourceDb2EnterpriseTunnelMethodNoTunnel enum in Python. ```APIDOC ## SourceDb2EnterpriseTunnelMethodNoTunnel Usage ### Description Example of how to use the `SourceDb2EnterpriseTunnelMethodNoTunnel` enum in Python. ### Method ```python from airbyte_api.models import SourceDb2EnterpriseTunnelMethodNoTunnel value = SourceDb2EnterpriseTunnelMethodNoTunnel.NO_TUNNEL ``` ### Values | Name | Value | | ----------- | ----------- | | `NO_TUNNEL` | NO_TUNNEL | ```