From 15014ba0d929340135bf0d54f0490c80ed34a601 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Thu, 1 Feb 2024 00:15:14 +0000 Subject: [PATCH 1/4] ci: regenerated with OpenAPI Doc 1.0.0, Speakeasy CLI 1.161.0 --- .speakeasy/gen.lock | 8 ++++---- RELEASES.md | 12 +++++++++++- gen.yaml | 2 +- pylintrc | 3 ++- setup.py | 7 ++++--- src/airbyte/sdkconfiguration.py | 6 +++--- src/airbyte/utils/utils.py | 2 +- 7 files changed, 26 insertions(+), 14 deletions(-) diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index bc8a0a9c..0771fbe6 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -4,9 +4,9 @@ management: docChecksum: c101e6356aa26bcdee80457c4dc64471 docVersion: 1.0.0 speakeasyVersion: internal - generationVersion: 2.237.2 - releaseVersion: 0.44.3 - configChecksum: e5234746f9bb8bf377f8400720a7b273 + generationVersion: 2.245.1 + releaseVersion: 0.45.0 + configChecksum: 42983d0d51ddc2618bf4cbf0315e060d repoURL: https://github.com/airbytehq/airbyte-api-python-sdk.git repoSubDirectory: . installationURL: https://github.com/airbytehq/airbyte-api-python-sdk.git @@ -15,7 +15,7 @@ features: python: additionalProperties: 0.1.0 constsAndDefaults: 0.1.2 - core: 4.4.2 + core: 4.4.3 globalSecurity: 2.83.2 globalServerURLs: 2.82.1 unions: 2.82.5 diff --git a/RELEASES.md b/RELEASES.md index ca5aaf37..da7a5e2c 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -808,4 +808,14 @@ Based on: ### Generated - [python v0.44.3] . ### Releases -- [PyPI v0.44.3] https://pypi.org/project/airbyte-api/0.44.3 - . \ No newline at end of file +- [PyPI v0.44.3] https://pypi.org/project/airbyte-api/0.44.3 - . + +## 2024-02-01 00:14:45 +### Changes +Based on: +- OpenAPI Doc 1.0.0 +- Speakeasy CLI 1.161.0 (2.245.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v0.45.0] . +### Releases +- [PyPI v0.45.0] https://pypi.org/project/airbyte-api/0.45.0 - . \ No newline at end of file diff --git a/gen.yaml b/gen.yaml index af4ecc17..b29cd1b0 100644 --- a/gen.yaml +++ b/gen.yaml @@ -7,7 +7,7 @@ generation: fixes: nameResolutionDec2023: false python: - version: 0.44.3 + version: 0.45.0 author: Airbyte clientServerStatusCodesAsErrors: true description: Python Client SDK for Airbyte API diff --git a/pylintrc b/pylintrc index cd85230b..2f59cabc 100644 --- a/pylintrc +++ b/pylintrc @@ -441,7 +441,8 @@ disable=raw-checker-failed, cyclic-import, too-many-nested-blocks, too-many-boolean-expressions, - no-else-raise + no-else-raise, + bare-except # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option diff --git a/setup.py b/setup.py index 24451242..b91b6fb8 100644 --- a/setup.py +++ b/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="airbyte-api", - version="0.44.3", + version="0.45.0", author="Airbyte", description="Python Client SDK for Airbyte API", long_description=long_description, @@ -19,7 +19,7 @@ install_requires=[ "certifi>=2023.7.22", "charset-normalizer>=3.2.0", - "dataclasses-json>=0.6.1", + "dataclasses-json @ git+https://github.com/speakeasy-api/dataclasses-json@fix-union-deserialization", "idna>=3.4", "jsonpath-python>=1.0.6 ", "marshmallow>=3.19.0", @@ -36,5 +36,6 @@ "dev":["pylint==2.16.2"] }, package_dir={'': 'src'}, - python_requires='>=3.8' + python_requires='>=3.8', + package_data={"airbyte-api": ["py.typed"]}, ) diff --git a/src/airbyte/sdkconfiguration.py b/src/airbyte/sdkconfiguration.py index 7db4d6a4..1cef40d3 100644 --- a/src/airbyte/sdkconfiguration.py +++ b/src/airbyte/sdkconfiguration.py @@ -22,9 +22,9 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '0.44.3' - gen_version: str = '2.237.2' - user_agent: str = 'speakeasy-sdk/python 0.44.3 2.237.2 1.0.0 airbyte-api' + sdk_version: str = '0.45.0' + gen_version: str = '2.245.1' + user_agent: str = 'speakeasy-sdk/python 0.45.0 2.245.1 1.0.0 airbyte-api' retry_config: RetryConfig = None def get_server_details(self) -> Tuple[str, Dict[str, str]]: diff --git a/src/airbyte/utils/utils.py b/src/airbyte/utils/utils.py index f7096142..52434025 100644 --- a/src/airbyte/utils/utils.py +++ b/src/airbyte/utils/utils.py @@ -695,7 +695,7 @@ def unmarshal_json(data, typ, decoder=None): out = unmarshal.from_dict({"res": json_dict}) except AttributeError as attr_err: raise AttributeError( - f'unable to unmarshal {data} as {typ}') from attr_err + f'unable to unmarshal {data} as {typ} - {attr_err}') from attr_err return out.res if decoder is None else decoder(out.res) From f7625bc4b821f4a078c9b497f91c77912d8b081f Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Fri, 2 Feb 2024 00:14:22 +0000 Subject: [PATCH 2/4] ci: regenerated with OpenAPI Doc 1.0.0, Speakeasy CLI 1.163.1 --- .speakeasy/gen.lock | 8 ++++---- RELEASES.md | 12 +++++++++++- gen.yaml | 3 ++- setup.py | 4 ++-- src/airbyte/sdkconfiguration.py | 6 +++--- 5 files changed, 22 insertions(+), 11 deletions(-) diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 0771fbe6..ef74f181 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -4,9 +4,9 @@ management: docChecksum: c101e6356aa26bcdee80457c4dc64471 docVersion: 1.0.0 speakeasyVersion: internal - generationVersion: 2.245.1 - releaseVersion: 0.45.0 - configChecksum: 42983d0d51ddc2618bf4cbf0315e060d + generationVersion: 2.248.1 + releaseVersion: 0.46.0 + configChecksum: 0c9ddc0ce5ae2f9e165a55e67a11d9ca repoURL: https://github.com/airbytehq/airbyte-api-python-sdk.git repoSubDirectory: . installationURL: https://github.com/airbytehq/airbyte-api-python-sdk.git @@ -15,7 +15,7 @@ features: python: additionalProperties: 0.1.0 constsAndDefaults: 0.1.2 - core: 4.4.3 + core: 4.4.4 globalSecurity: 2.83.2 globalServerURLs: 2.82.1 unions: 2.82.5 diff --git a/RELEASES.md b/RELEASES.md index da7a5e2c..c00ce51b 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -818,4 +818,14 @@ Based on: ### Generated - [python v0.45.0] . ### Releases -- [PyPI v0.45.0] https://pypi.org/project/airbyte-api/0.45.0 - . \ No newline at end of file +- [PyPI v0.45.0] https://pypi.org/project/airbyte-api/0.45.0 - . + +## 2024-02-02 00:13:52 +### Changes +Based on: +- OpenAPI Doc 1.0.0 +- Speakeasy CLI 1.163.1 (2.248.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v0.46.0] . +### Releases +- [PyPI v0.46.0] https://pypi.org/project/airbyte-api/0.46.0 - . \ No newline at end of file diff --git a/gen.yaml b/gen.yaml index b29cd1b0..9bba8e50 100644 --- a/gen.yaml +++ b/gen.yaml @@ -6,8 +6,9 @@ generation: useClassNamesForArrayFields: true fixes: nameResolutionDec2023: false + parameterOrderingFeb2024: false python: - version: 0.45.0 + version: 0.46.0 author: Airbyte clientServerStatusCodesAsErrors: true description: Python Client SDK for Airbyte API diff --git a/setup.py b/setup.py index b91b6fb8..6c34a126 100644 --- a/setup.py +++ b/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="airbyte-api", - version="0.45.0", + version="0.46.0", author="Airbyte", description="Python Client SDK for Airbyte API", long_description=long_description, @@ -19,7 +19,7 @@ install_requires=[ "certifi>=2023.7.22", "charset-normalizer>=3.2.0", - "dataclasses-json @ git+https://github.com/speakeasy-api/dataclasses-json@fix-union-deserialization", + "dataclasses-json-speakeasy>=0.5.11", "idna>=3.4", "jsonpath-python>=1.0.6 ", "marshmallow>=3.19.0", diff --git a/src/airbyte/sdkconfiguration.py b/src/airbyte/sdkconfiguration.py index 1cef40d3..2ec18200 100644 --- a/src/airbyte/sdkconfiguration.py +++ b/src/airbyte/sdkconfiguration.py @@ -22,9 +22,9 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '0.45.0' - gen_version: str = '2.245.1' - user_agent: str = 'speakeasy-sdk/python 0.45.0 2.245.1 1.0.0 airbyte-api' + sdk_version: str = '0.46.0' + gen_version: str = '2.248.1' + user_agent: str = 'speakeasy-sdk/python 0.46.0 2.248.1 1.0.0 airbyte-api' retry_config: RetryConfig = None def get_server_details(self) -> Tuple[str, Dict[str, str]]: From ca75411cfeec32c59c6b950f5365c0f287d35d77 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 7 Feb 2024 00:14:15 +0000 Subject: [PATCH 3/4] ci: regenerated with OpenAPI Doc 1.0.0, Speakeasy CLI 1.170.1 --- .speakeasy/gen.lock | 8 ++-- README.md | 40 +++++++++---------- RELEASES.md | 12 +++++- USAGE.md | 8 ++-- docs/models/operations/canceljobresponse.md | 4 +- .../operations/createconnectionresponse.md | 4 +- .../operations/createdestinationresponse.md | 4 +- docs/models/operations/createjobresponse.md | 4 +- .../models/operations/createsourceresponse.md | 4 +- .../operations/getconnectionresponse.md | 4 +- .../operations/getdestinationresponse.md | 4 +- docs/models/operations/getjobresponse.md | 4 +- docs/models/operations/getsourceresponse.md | 4 +- .../operations/getstreampropertiesrequest.md | 4 +- .../operations/listconnectionsresponse.md | 4 +- .../operations/listdestinationsresponse.md | 4 +- docs/models/operations/listjobsresponse.md | 4 +- docs/models/operations/listsourcesresponse.md | 4 +- .../operations/patchconnectionresponse.md | 4 +- .../operations/patchdestinationrequest.md | 4 +- .../operations/patchdestinationresponse.md | 4 +- docs/models/operations/patchsourcerequest.md | 4 +- docs/models/operations/patchsourceresponse.md | 4 +- .../operations/putdestinationrequest.md | 4 +- .../operations/putdestinationresponse.md | 4 +- docs/models/operations/putsourcerequest.md | 4 +- docs/models/operations/putsourceresponse.md | 4 +- docs/models/shared/amazons3.md | 8 ++-- .../shared/authenticateviaasanaoauth.md | 4 +- .../shared/authenticateviagoogleoauth.md | 6 +-- .../shared/authenticateviaharvestoauth.md | 6 +-- .../shared/authenticatevialeveroauth.md | 4 +- .../models/shared/authenticateviamicrosoft.md | 4 +- .../shared/authenticateviamicrosoftoauth20.md | 4 +- docs/models/shared/authenticateviaoauth.md | 4 +- docs/models/shared/authenticateviaoauth20.md | 4 +- .../shared/authenticateviaretentlyoauth.md | 6 +-- .../models/shared/authenticatewithapitoken.md | 2 +- .../authenticatewithpersonalaccesstoken.md | 4 +- docs/models/shared/awss3staging.md | 6 +-- docs/models/shared/azblobazureblobstorage.md | 4 +- docs/models/shared/azureopenai.md | 4 +- docs/models/shared/betweenfilter.md | 4 +- docs/models/shared/centralapirouter.md | 4 +- docs/models/shared/chromalocalpersistance.md | 2 +- docs/models/shared/connectioncreaterequest.md | 4 +- docs/models/shared/connectionresponse.md | 12 +++--- docs/models/shared/connectionschedule.md | 4 +- .../shared/connectionscheduleresponse.md | 4 +- docs/models/shared/continuousfeed.md | 2 +- docs/models/shared/customreportconfig.md | 4 +- docs/models/shared/destinationawsdatalake.md | 6 +-- .../shared/destinationazureblobstorage.md | 4 +- docs/models/shared/destinationbigquery.md | 6 +-- .../shared/destinationbigqueryhmackey.md | 4 +- docs/models/shared/destinationclickhouse.md | 6 +-- .../models/shared/destinationcreaterequest.md | 4 +- docs/models/shared/destinationcumulio.md | 2 +- docs/models/shared/destinationdatabend.md | 6 +-- docs/models/shared/destinationdatabricks.md | 6 +-- .../destinationdatabricksazureblobstorage.md | 2 +- docs/models/shared/destinationdevnull.md | 4 +- docs/models/shared/destinationduckdb.md | 2 +- docs/models/shared/destinationdynamodb.md | 6 +-- .../models/shared/destinationelasticsearch.md | 2 +- docs/models/shared/destinationfirebolt.md | 8 ++-- docs/models/shared/destinationfirestore.md | 4 +- docs/models/shared/destinationgcs.md | 2 +- docs/models/shared/destinationgooglesheets.md | 4 +- docs/models/shared/destinationkeen.md | 4 +- docs/models/shared/destinationkinesis.md | 4 +- docs/models/shared/destinationlangchain.md | 4 +- .../shared/destinationlangchainpinecone.md | 4 +- docs/models/shared/destinationmilvus.md | 6 +-- .../shared/destinationmilvusapitoken.md | 4 +- .../shared/destinationmilvusindexing.md | 2 +- docs/models/shared/destinationmilvusopenai.md | 4 +- .../destinationmilvusprocessingconfigmodel.md | 2 +- .../destinationmilvususernamepassword.md | 4 +- ...estinationmongodbpasswordauthentication.md | 6 +-- .../destinationmongodbsshkeyauthentication.md | 4 +- docs/models/shared/destinationmssql.md | 6 +-- .../destinationmssqlpasswordauthentication.md | 6 +-- .../destinationmssqlsshkeyauthentication.md | 4 +- docs/models/shared/destinationmysql.md | 6 +-- .../destinationmysqlpasswordauthentication.md | 6 +-- .../destinationmysqlsshkeyauthentication.md | 4 +- docs/models/shared/destinationoracle.md | 8 ++-- ...destinationoraclepasswordauthentication.md | 6 +-- .../destinationoraclesshkeyauthentication.md | 4 +- docs/models/shared/destinationpinecone.md | 6 +-- .../shared/destinationpineconeazureopenai.md | 4 +- .../shared/destinationpineconeopenai.md | 4 +- .../destinationpineconeopenaicompatible.md | 2 +- ...estinationpineconeprocessingconfigmodel.md | 2 +- docs/models/shared/destinationpostgres.md | 6 +-- ...stinationpostgrespasswordauthentication.md | 6 +-- ...destinationpostgressshkeyauthentication.md | 4 +- docs/models/shared/destinationpubsub.md | 8 ++-- docs/models/shared/destinationqdrant.md | 6 +-- .../shared/destinationqdrantazureopenai.md | 4 +- .../shared/destinationqdrantindexing.md | 6 +-- docs/models/shared/destinationqdrantopenai.md | 4 +- .../destinationqdrantopenaicompatible.md | 2 +- .../destinationqdrantprocessingconfigmodel.md | 2 +- docs/models/shared/destinationredis.md | 6 +-- .../destinationredispasswordauthentication.md | 6 +-- .../destinationredissshkeyauthentication.md | 4 +- docs/models/shared/destinationredshift.md | 8 ++-- ...stinationredshiftpasswordauthentication.md | 6 +-- ...destinationredshiftsshkeyauthentication.md | 4 +- docs/models/shared/destinations3.md | 6 +-- docs/models/shared/destinations3glue.md | 8 ++-- docs/models/shared/destinationsftpjson.md | 6 +-- docs/models/shared/destinationsnowflake.md | 14 +++---- .../shared/destinationsnowflakeoauth20.md | 4 +- docs/models/shared/destinationtypesense.md | 2 +- docs/models/shared/destinationvectara.md | 2 +- docs/models/shared/destinationvertica.md | 8 ++-- ...estinationverticapasswordauthentication.md | 6 +-- .../destinationverticasshkeyauthentication.md | 4 +- docs/models/shared/destinationweaviate.md | 6 +-- .../shared/destinationweaviateapitoken.md | 4 +- .../shared/destinationweaviateazureopenai.md | 4 +- .../shared/destinationweaviateindexing.md | 4 +- .../shared/destinationweaviateopenai.md | 4 +- .../destinationweaviateopenaicompatible.md | 2 +- ...estinationweaviateprocessingconfigmodel.md | 2 +- .../destinationweaviateusernamepassword.md | 4 +- docs/models/shared/externaltablevias3.md | 4 +- docs/models/shared/filebasedstreamconfig.md | 4 +- docs/models/shared/googlecredentials.md | 4 +- docs/models/shared/hmackey.md | 4 +- docs/models/shared/iamrole.md | 4 +- docs/models/shared/initiateoauthrequest.md | 4 +- docs/models/shared/inlistfilter.md | 4 +- docs/models/shared/insightconfig.md | 2 +- docs/models/shared/jobresponse.md | 10 ++--- docs/models/shared/keypairauthentication.md | 2 +- docs/models/shared/logicalreplicationcdc.md | 6 +-- docs/models/shared/loginpassword.md | 4 +- docs/models/shared/mongodbatlasreplicaset.md | 10 ++--- docs/models/shared/numericfilter.md | 4 +- docs/models/shared/oauth20.md | 4 +- .../shared/oauth2confidentialapplication.md | 4 +- docs/models/shared/oauthauthentication.md | 4 +- docs/models/shared/openai.md | 4 +- docs/models/shared/openaicompatible.md | 2 +- docs/models/shared/passwordauthentication.md | 6 +-- docs/models/shared/processingconfigmodel.md | 4 +- .../readchangesusingwriteaheadlogcdc.md | 6 +-- docs/models/shared/replicaset.md | 4 +- docs/models/shared/reportconfig.md | 4 +- docs/models/shared/scpsecurecopyprotocol.md | 4 +- docs/models/shared/selfmanagedreplicaset.md | 4 +- docs/models/shared/serviceaccount.md | 4 +- docs/models/shared/serviceaccountkey.md | 4 +- .../shared/serviceaccountkeyauthentication.md | 4 +- docs/models/shared/servicename.md | 4 +- .../shared/sftpsecurefiletransferprotocol.md | 4 +- docs/models/shared/signinviagoogleoauth.md | 4 +- docs/models/shared/singlestoreaccesstoken.md | 4 +- docs/models/shared/sourceaha.md | 4 +- docs/models/shared/sourceaircall.md | 4 +- docs/models/shared/sourceairtableoauth20.md | 4 +- docs/models/shared/sourcealloydb.md | 4 +- .../sourcealloydbpasswordauthentication.md | 6 +-- .../sourcealloydbsshkeyauthentication.md | 4 +- docs/models/shared/sourcealloydbverifyca.md | 2 +- docs/models/shared/sourcealloydbverifyfull.md | 2 +- docs/models/shared/sourceamazonads.md | 4 +- .../shared/sourceamazonsellerpartner.md | 6 +-- docs/models/shared/sourceamazonsqs.md | 4 +- docs/models/shared/sourceamplitude.md | 6 +-- docs/models/shared/sourceapifydataset.md | 4 +- docs/models/shared/sourceazureblobstorage.md | 4 +- docs/models/shared/sourceazuretable.md | 2 +- docs/models/shared/sourcebamboohr.md | 4 +- docs/models/shared/sourcebigquery.md | 2 +- docs/models/shared/sourcebingads.md | 6 +-- docs/models/shared/sourcebraze.md | 4 +- docs/models/shared/sourcecart.md | 4 +- docs/models/shared/sourcechargebee.md | 4 +- docs/models/shared/sourcechartmogul.md | 4 +- docs/models/shared/sourceclickhouse.md | 4 +- .../sourceclickhousepasswordauthentication.md | 6 +-- .../sourceclickhousesshkeyauthentication.md | 4 +- docs/models/shared/sourceclockify.md | 4 +- docs/models/shared/sourcecoinapi.md | 8 ++-- docs/models/shared/sourceconfigcat.md | 4 +- docs/models/shared/sourcecreaterequest.md | 6 +-- docs/models/shared/sourcedatascope.md | 4 +- docs/models/shared/sourcedixa.md | 4 +- docs/models/shared/sourcedynamodb.md | 2 +- docs/models/shared/sourceexchangerates.md | 4 +- docs/models/shared/sourcefauna.md | 2 +- docs/models/shared/sourcefile.md | 6 +-- docs/models/shared/sourcefirebolt.md | 8 ++-- docs/models/shared/sourcegcs.md | 4 +- docs/models/shared/sourcegcsstreamconfig.md | 4 +- docs/models/shared/sourcegithub.md | 4 +- .../shared/sourcegithubpersonalaccesstoken.md | 4 +- docs/models/shared/sourcegitlab.md | 2 +- docs/models/shared/sourcegitlaboauth20.md | 4 +- docs/models/shared/sourcegnews.md | 2 +- docs/models/shared/sourcegoogleads.md | 2 +- .../shared/sourcegoogleanalyticsdataapi.md | 2 +- ...urcegoogleanalyticsdataapibetweenfilter.md | 4 +- ...oogleanalyticsdataapicustomreportconfig.md | 8 ++-- ...ourcegoogleanalyticsdataapiinlistfilter.md | 4 +- ...urcegoogleanalyticsdataapinumericfilter.md | 4 +- ...gleanalyticsdataapischemasbetweenfilter.md | 4 +- ...ischemascustomreportsarraybetweenfilter.md | 4 +- ...eportsarraydimensionfilterbetweenfilter.md | 4 +- ...reportsarraydimensionfilterinlistfilter.md | 4 +- ...eportsarraydimensionfilternumericfilter.md | 4 +- ...reportsarraydimensionfilterstringfilter.md | 4 +- ...pischemascustomreportsarrayinlistfilter.md | 4 +- ...omreportsarraymetricfilterbetweenfilter.md | 4 +- ...tomreportsarraymetricfilterinlistfilter.md | 4 +- ...metricfiltermetricsfilter3betweenfilter.md | 4 +- ...ymetricfiltermetricsfilter3inlistfilter.md | 4 +- ...metricfiltermetricsfilter3numericfilter.md | 4 +- ...ymetricfiltermetricsfilter3stringfilter.md | 4 +- ...ymetricfiltermetricsfilterbetweenfilter.md | 4 +- ...aymetricfiltermetricsfilterinlistfilter.md | 4 +- ...ymetricfiltermetricsfilternumericfilter.md | 4 +- ...aymetricfiltermetricsfilterstringfilter.md | 4 +- ...omreportsarraymetricfilternumericfilter.md | 4 +- ...tomreportsarraymetricfilterstringfilter.md | 4 +- ...ischemascustomreportsarraynumericfilter.md | 4 +- ...pischemascustomreportsarraystringfilter.md | 4 +- ...ogleanalyticsdataapischemasinlistfilter.md | 4 +- ...gleanalyticsdataapischemasnumericfilter.md | 4 +- ...ogleanalyticsdataapischemasstringfilter.md | 4 +- ...ourcegoogleanalyticsdataapistringfilter.md | 4 +- docs/models/shared/sourcegoogledrive.md | 4 +- ...cegoogledriveauthenticateviagoogleoauth.md | 4 +- .../sourcegoogledrivefilebasedstreamconfig.md | 4 +- ...gledriveserviceaccountkeyauthentication.md | 4 +- .../shared/sourcegooglepagespeedinsights.md | 6 +-- .../shared/sourcegooglesearchconsole.md | 2 +- .../shared/sourcegooglesearchconsoleoauth.md | 6 +-- ...hconsoleserviceaccountkeyauthentication.md | 4 +- docs/models/shared/sourcegooglesheets.md | 4 +- ...egooglesheetsauthenticateviagoogleoauth.md | 4 +- ...lesheetsserviceaccountkeyauthentication.md | 4 +- docs/models/shared/sourcegooglewebfonts.md | 2 +- docs/models/shared/sourceharvest.md | 2 +- ...vestauthenticatewithpersonalaccesstoken.md | 2 +- docs/models/shared/sourcehubspot.md | 4 +- docs/models/shared/sourcehubspotoauth.md | 4 +- docs/models/shared/sourceinsightly.md | 4 +- docs/models/shared/sourceintercom.md | 4 +- docs/models/shared/sourceiterable.md | 4 +- docs/models/shared/sourceklarna.md | 6 +-- docs/models/shared/sourcekustomersinger.md | 4 +- docs/models/shared/sourcekyve.md | 4 +- docs/models/shared/sourceleverhiring.md | 4 +- docs/models/shared/sourcelinkedinads.md | 4 +- .../models/shared/sourcelinkedinadsoauth20.md | 4 +- docs/models/shared/sourcelinkedinpages.md | 2 +- .../shared/sourcelinkedinpagesoauth20.md | 4 +- docs/models/shared/sourcelinnworks.md | 4 +- docs/models/shared/sourcemailgun.md | 2 +- docs/models/shared/sourcemailjetsms.md | 4 +- docs/models/shared/sourcemarketo.md | 4 +- docs/models/shared/sourcemicrosoftteams.md | 2 +- docs/models/shared/sourcemixpanel.md | 2 +- docs/models/shared/sourcemondayoauth20.md | 2 +- docs/models/shared/sourcemssql.md | 6 +-- .../sourcemssqlpasswordauthentication.md | 6 +-- .../shared/sourcemssqlsshkeyauthentication.md | 4 +- docs/models/shared/sourcemyhours.md | 6 +-- docs/models/shared/sourcemysql.md | 6 +-- .../sourcemysqlpasswordauthentication.md | 6 +-- .../shared/sourcemysqlsshkeyauthentication.md | 4 +- docs/models/shared/sourcenetsuite.md | 4 +- docs/models/shared/sourcenotionaccesstoken.md | 4 +- docs/models/shared/sourcenotionoauth20.md | 4 +- docs/models/shared/sourcenytimes.md | 6 +-- docs/models/shared/sourceoktaoauth20.md | 4 +- docs/models/shared/sourceonesignal.md | 4 +- docs/models/shared/sourceoracle.md | 6 +-- .../sourceoraclepasswordauthentication.md | 6 +-- .../sourceoraclesshkeyauthentication.md | 4 +- docs/models/shared/sourceorb.md | 2 +- docs/models/shared/sourceorbit.md | 4 +- docs/models/shared/sourceoutbrainamplify.md | 4 +- .../sourceoutbrainamplifyusernamepassword.md | 4 +- docs/models/shared/sourceoutreach.md | 4 +- docs/models/shared/sourcepaypaltransaction.md | 2 +- docs/models/shared/sourcepaystack.md | 6 +-- docs/models/shared/sourcepexelsapi.md | 2 +- docs/models/shared/sourcepolygonstockapi.md | 10 ++--- docs/models/shared/sourcepostgres.md | 4 +- .../sourcepostgrespasswordauthentication.md | 6 +-- .../sourcepostgressshkeyauthentication.md | 4 +- docs/models/shared/sourcepostgresverifyca.md | 2 +- .../models/shared/sourcepostgresverifyfull.md | 2 +- docs/models/shared/sourceposthog.md | 4 +- docs/models/shared/sourceprestashop.md | 4 +- docs/models/shared/sourcequalaroo.md | 6 +-- docs/models/shared/sourcequickbooks.md | 4 +- docs/models/shared/sourcequickbooksoauth20.md | 4 +- docs/models/shared/sourcerailz.md | 4 +- docs/models/shared/sourcerecharge.md | 4 +- docs/models/shared/sourceredshift.md | 6 +-- docs/models/shared/sourcerkicovid.md | 4 +- docs/models/shared/sourcerss.md | 4 +- docs/models/shared/sources3.md | 6 +-- .../shared/sources3filebasedstreamconfig.md | 4 +- docs/models/shared/sourcesalesforce.md | 4 +- docs/models/shared/sourcesalesloft.md | 4 +- docs/models/shared/sourcesenseforce.md | 4 +- docs/models/shared/sourcesentry.md | 4 +- docs/models/shared/sourcesftp.md | 6 +-- docs/models/shared/sourcesftpbulk.md | 10 ++--- .../sourcesftppasswordauthentication.md | 4 +- .../shared/sourcesftpsshkeyauthentication.md | 4 +- docs/models/shared/sourceshopify.md | 2 +- docs/models/shared/sourceshortio.md | 4 +- docs/models/shared/sourceslack.md | 4 +- docs/models/shared/sourcesmartsheets.md | 2 +- .../models/shared/sourcesmartsheetsoauth20.md | 4 +- docs/models/shared/sourcesnapchatmarketing.md | 2 +- docs/models/shared/sourcesnowflake.md | 8 ++-- docs/models/shared/sourcesnowflakeoauth20.md | 4 +- .../sourcesnowflakeusernameandpassword.md | 4 +- docs/models/shared/sourcesonarcloud.md | 6 +-- docs/models/shared/sourcestrava.md | 6 +-- docs/models/shared/sourcestripe.md | 2 +- docs/models/shared/sourcesurveymonkey.md | 2 +- docs/models/shared/sourcetheguardianapi.md | 2 +- .../shared/sourcetiktokmarketingoauth20.md | 6 +-- docs/models/shared/sourcetrello.md | 6 +-- docs/models/shared/sourcetrustpilot.md | 4 +- docs/models/shared/sourcetrustpilotapikey.md | 4 +- docs/models/shared/sourcetrustpilotoauth20.md | 4 +- docs/models/shared/sourcetvmazeschedule.md | 2 +- docs/models/shared/sourcetwilio.md | 4 +- docs/models/shared/sourcetwitter.md | 2 +- docs/models/shared/sourcetypeformoauth20.md | 4 +- docs/models/shared/sourceuscensus.md | 2 +- docs/models/shared/sourcewebflow.md | 2 +- .../models/shared/sourcewikipediapageviews.md | 4 +- docs/models/shared/sourcewoocommerce.md | 4 +- docs/models/shared/sourceyandexmetrica.md | 4 +- docs/models/shared/sourceyotpo.md | 4 +- docs/models/shared/sourcezendeskchat.md | 2 +- docs/models/shared/sourcezendesksunshine.md | 6 +-- .../shared/sourcezendesksunshineapitoken.md | 4 +- .../shared/sourcezendesksunshineoauth20.md | 4 +- docs/models/shared/sourcezendesksupport.md | 4 +- .../shared/sourcezendesksupportapitoken.md | 6 +-- .../shared/sourcezendesksupportoauth20.md | 2 +- docs/models/shared/sourcezendesktalk.md | 6 +-- .../shared/sourcezendesktalkapitoken.md | 6 +-- .../models/shared/sourcezendesktalkoauth20.md | 2 +- docs/models/shared/sourcezohocrm.md | 2 +- docs/models/shared/sourcezuora.md | 4 +- docs/models/shared/sshkeyauthentication.md | 4 +- docs/models/shared/sshsecureshell.md | 4 +- docs/models/shared/streamconfiguration.md | 2 +- docs/models/shared/streamscriteria.md | 4 +- docs/models/shared/stringfilter.md | 4 +- docs/models/shared/systemidsid.md | 4 +- .../shared/tlsencryptedverifycertificate.md | 4 +- docs/models/shared/usernameandpassword.md | 4 +- docs/models/shared/usernamepassword.md | 4 +- docs/models/shared/workspaceresponse.md | 4 +- docs/sdks/connections/README.md | 10 ++--- docs/sdks/destinations/README.md | 4 +- docs/sdks/sources/README.md | 6 +-- gen.yaml | 3 +- setup.py | 2 +- src/airbyte/models/operations/canceljob.py | 4 +- .../models/operations/createconnection.py | 4 +- .../models/operations/createdestination.py | 4 +- src/airbyte/models/operations/createjob.py | 4 +- ...createorupdateworkspaceoauthcredentials.py | 6 +-- src/airbyte/models/operations/createsource.py | 4 +- .../models/operations/createworkspace.py | 4 +- .../models/operations/deleteconnection.py | 4 +- .../models/operations/deletedestination.py | 4 +- src/airbyte/models/operations/deletesource.py | 4 +- .../models/operations/deleteworkspace.py | 4 +- .../models/operations/getconnection.py | 4 +- .../models/operations/getdestination.py | 4 +- src/airbyte/models/operations/getjob.py | 4 +- src/airbyte/models/operations/getsource.py | 4 +- .../models/operations/getstreamproperties.py | 4 +- src/airbyte/models/operations/getworkspace.py | 4 +- .../models/operations/initiateoauth.py | 4 +- .../models/operations/listconnections.py | 4 +- .../models/operations/listdestinations.py | 4 +- src/airbyte/models/operations/listjobs.py | 4 +- src/airbyte/models/operations/listsources.py | 4 +- .../models/operations/listworkspaces.py | 4 +- .../models/operations/patchconnection.py | 6 +-- .../models/operations/patchdestination.py | 4 +- src/airbyte/models/operations/patchsource.py | 4 +- .../models/operations/putdestination.py | 4 +- src/airbyte/models/operations/putsource.py | 4 +- .../models/operations/updateworkspace.py | 6 +-- .../models/shared/destination_aws_datalake.py | 2 +- .../shared/destination_azure_blob_storage.py | 4 +- .../models/shared/destination_bigquery.py | 4 +- .../models/shared/destination_cumulio.py | 2 +- .../models/shared/destination_databricks.py | 4 +- .../shared/destination_elasticsearch.py | 2 +- .../models/shared/destination_firebolt.py | 2 +- .../models/shared/destination_firestore.py | 2 +- .../models/shared/destination_kinesis.py | 2 +- .../models/shared/destination_pubsub.py | 2 +- .../models/shared/destination_redis.py | 2 +- .../models/shared/destination_redshift.py | 2 +- src/airbyte/models/shared/destination_s3.py | 2 +- .../models/shared/destination_s3_glue.py | 2 +- .../models/shared/destination_snowflake.py | 2 +- .../models/shared/destination_typesense.py | 2 +- src/airbyte/models/shared/source_alloydb.py | 16 ++++---- .../models/shared/source_amazon_ads.py | 2 +- .../shared/source_amazon_seller_partner.py | 2 +- .../models/shared/source_amazon_sqs.py | 2 +- src/airbyte/models/shared/source_amplitude.py | 2 +- src/airbyte/models/shared/source_appfollow.py | 2 +- .../shared/source_azure_blob_storage.py | 2 +- src/airbyte/models/shared/source_bamboo_hr.py | 2 +- src/airbyte/models/shared/source_bigquery.py | 2 +- src/airbyte/models/shared/source_bing_ads.py | 2 +- src/airbyte/models/shared/source_cart.py | 2 +- .../models/shared/source_clickhouse.py | 2 +- .../models/shared/source_clickup_api.py | 2 +- src/airbyte/models/shared/source_clockify.py | 2 +- src/airbyte/models/shared/source_coin_api.py | 2 +- src/airbyte/models/shared/source_dixa.py | 2 +- src/airbyte/models/shared/source_dremio.py | 2 +- src/airbyte/models/shared/source_dynamodb.py | 2 +- .../models/shared/source_exchange_rates.py | 2 +- .../shared/source_facebook_marketing.py | 2 +- src/airbyte/models/shared/source_faker.py | 2 +- src/airbyte/models/shared/source_fauna.py | 4 +- src/airbyte/models/shared/source_file.py | 14 +++---- src/airbyte/models/shared/source_firebolt.py | 2 +- .../models/shared/source_freshcaller.py | 2 +- src/airbyte/models/shared/source_freshdesk.py | 2 +- src/airbyte/models/shared/source_getlago.py | 2 +- src/airbyte/models/shared/source_github.py | 2 +- src/airbyte/models/shared/source_gitlab.py | 2 +- src/airbyte/models/shared/source_gnews.py | 2 +- .../models/shared/source_google_ads.py | 2 +- .../source_google_analytics_data_api.py | 34 ++++++++-------- .../models/shared/source_google_directory.py | 2 +- .../source_google_pagespeed_insights.py | 2 +- .../shared/source_google_search_console.py | 4 +- .../models/shared/source_google_sheets.py | 2 +- .../models/shared/source_google_webfonts.py | 2 +- .../source_google_workspace_admin_reports.py | 2 +- src/airbyte/models/shared/source_harvest.py | 2 +- src/airbyte/models/shared/source_hubspot.py | 2 +- src/airbyte/models/shared/source_instagram.py | 2 +- src/airbyte/models/shared/source_intercom.py | 2 +- src/airbyte/models/shared/source_jira.py | 2 +- src/airbyte/models/shared/source_klarna.py | 2 +- src/airbyte/models/shared/source_kyve.py | 2 +- .../models/shared/source_lever_hiring.py | 2 +- .../models/shared/source_linkedin_ads.py | 2 +- .../models/shared/source_linkedin_pages.py | 2 +- src/airbyte/models/shared/source_mailchimp.py | 2 +- src/airbyte/models/shared/source_mailgun.py | 2 +- .../models/shared/source_mailjet_sms.py | 2 +- src/airbyte/models/shared/source_metabase.py | 2 +- .../models/shared/source_microsoft_teams.py | 2 +- src/airbyte/models/shared/source_mixpanel.py | 2 +- src/airbyte/models/shared/source_monday.py | 2 +- .../shared/source_mongodb_internal_poc.py | 2 +- .../models/shared/source_mongodb_v2.py | 6 +-- src/airbyte/models/shared/source_mssql.py | 6 +-- src/airbyte/models/shared/source_my_hours.py | 2 +- src/airbyte/models/shared/source_mysql.py | 8 ++-- src/airbyte/models/shared/source_netsuite.py | 2 +- src/airbyte/models/shared/source_nytimes.py | 2 +- src/airbyte/models/shared/source_okta.py | 2 +- src/airbyte/models/shared/source_oracle.py | 4 +- src/airbyte/models/shared/source_orb.py | 2 +- .../models/shared/source_outbrain_amplify.py | 2 +- .../shared/source_paypal_transaction.py | 2 +- src/airbyte/models/shared/source_paystack.py | 2 +- .../models/shared/source_pexels_api.py | 2 +- src/airbyte/models/shared/source_pocket.py | 2 +- .../models/shared/source_polygon_stock_api.py | 2 +- src/airbyte/models/shared/source_postgres.py | 16 ++++---- src/airbyte/models/shared/source_posthog.py | 2 +- src/airbyte/models/shared/source_punk_api.py | 2 +- .../models/shared/source_quickbooks.py | 2 +- .../models/shared/source_recreation.py | 2 +- src/airbyte/models/shared/source_recurly.py | 2 +- src/airbyte/models/shared/source_redshift.py | 2 +- src/airbyte/models/shared/source_s3.py | 2 +- .../models/shared/source_salesforce.py | 2 +- .../models/shared/source_senseforce.py | 2 +- src/airbyte/models/shared/source_sentry.py | 2 +- src/airbyte/models/shared/source_sftp.py | 2 +- src/airbyte/models/shared/source_sftp_bulk.py | 2 +- src/airbyte/models/shared/source_shopify.py | 4 +- src/airbyte/models/shared/source_slack.py | 2 +- .../models/shared/source_smartsheets.py | 2 +- .../shared/source_snapchat_marketing.py | 2 +- src/airbyte/models/shared/source_snowflake.py | 4 +- .../models/shared/source_sonar_cloud.py | 2 +- .../models/shared/source_spacex_api.py | 2 +- src/airbyte/models/shared/source_square.py | 2 +- src/airbyte/models/shared/source_strava.py | 2 +- src/airbyte/models/shared/source_stripe.py | 2 +- .../models/shared/source_survey_sparrow.py | 2 +- .../models/shared/source_surveymonkey.py | 2 +- .../models/shared/source_the_guardian_api.py | 2 +- src/airbyte/models/shared/source_trello.py | 2 +- .../models/shared/source_tvmaze_schedule.py | 2 +- src/airbyte/models/shared/source_twilio.py | 2 +- src/airbyte/models/shared/source_twitter.py | 2 +- src/airbyte/models/shared/source_typeform.py | 2 +- src/airbyte/models/shared/source_us_census.py | 2 +- src/airbyte/models/shared/source_webflow.py | 2 +- .../models/shared/source_yandex_metrica.py | 2 +- src/airbyte/models/shared/source_yotpo.py | 2 +- .../models/shared/source_zendesk_chat.py | 4 +- .../models/shared/source_zendesk_sunshine.py | 2 +- .../models/shared/source_zendesk_support.py | 2 +- .../models/shared/source_zendesk_talk.py | 2 +- src/airbyte/models/shared/source_zenloop.py | 2 +- src/airbyte/models/shared/source_zoho_crm.py | 2 +- src/airbyte/models/shared/source_zuora.py | 2 +- src/airbyte/sdkconfiguration.py | 6 +-- 535 files changed, 1078 insertions(+), 1067 deletions(-) diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index ef74f181..d2d84ab5 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -4,9 +4,9 @@ management: docChecksum: c101e6356aa26bcdee80457c4dc64471 docVersion: 1.0.0 speakeasyVersion: internal - generationVersion: 2.248.1 - releaseVersion: 0.46.0 - configChecksum: 0c9ddc0ce5ae2f9e165a55e67a11d9ca + generationVersion: 2.250.12 + releaseVersion: 0.47.0 + configChecksum: 3fcff865c11ce83075716a8313369445 repoURL: https://github.com/airbytehq/airbyte-api-python-sdk.git repoSubDirectory: . installationURL: https://github.com/airbytehq/airbyte-api-python-sdk.git @@ -15,7 +15,7 @@ features: python: additionalProperties: 0.1.0 constsAndDefaults: 0.1.2 - core: 4.4.4 + core: 4.4.5 globalSecurity: 2.83.2 globalServerURLs: 2.82.1 unions: 2.82.5 diff --git a/README.md b/README.md index 017e2277..386738cc 100755 --- a/README.md +++ b/README.md @@ -40,13 +40,15 @@ s = airbyte.Airbyte( ) req = shared.ConnectionCreateRequest( + destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', + source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', configurations=shared.StreamConfigurations( streams=[ shared.StreamConfiguration( + name='string', cursor_field=[ 'string', ], - name='string', primary_key=[ [ 'string', @@ -55,12 +57,10 @@ req = shared.ConnectionCreateRequest( ), ], ), - destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', namespace_format='${SOURCE_NAMESPACE}', schedule=shared.ConnectionSchedule( - schedule_type=shared.ScheduleTypeEnum.MANUAL, + schedule_type=shared.ScheduleTypeEnum.CRON, ), - source_id='dd427d83-a555-4847-8358-42325b6c7b3f', ) res = s.connections.create_connection(req) @@ -153,13 +153,15 @@ s = airbyte.Airbyte( ) req = shared.ConnectionCreateRequest( + destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', + source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', configurations=shared.StreamConfigurations( streams=[ shared.StreamConfiguration( + name='string', cursor_field=[ 'string', ], - name='string', primary_key=[ [ 'string', @@ -168,12 +170,10 @@ req = shared.ConnectionCreateRequest( ), ], ), - destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', namespace_format='${SOURCE_NAMESPACE}', schedule=shared.ConnectionSchedule( - schedule_type=shared.ScheduleTypeEnum.MANUAL, + schedule_type=shared.ScheduleTypeEnum.CRON, ), - source_id='dd427d83-a555-4847-8358-42325b6c7b3f', ) res = None @@ -219,13 +219,15 @@ s = airbyte.Airbyte( ) req = shared.ConnectionCreateRequest( + destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', + source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', configurations=shared.StreamConfigurations( streams=[ shared.StreamConfiguration( + name='string', cursor_field=[ 'string', ], - name='string', primary_key=[ [ 'string', @@ -234,12 +236,10 @@ req = shared.ConnectionCreateRequest( ), ], ), - destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', namespace_format='${SOURCE_NAMESPACE}', schedule=shared.ConnectionSchedule( - schedule_type=shared.ScheduleTypeEnum.MANUAL, + schedule_type=shared.ScheduleTypeEnum.CRON, ), - source_id='dd427d83-a555-4847-8358-42325b6c7b3f', ) res = s.connections.create_connection(req) @@ -268,13 +268,15 @@ s = airbyte.Airbyte( ) req = shared.ConnectionCreateRequest( + destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', + source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', configurations=shared.StreamConfigurations( streams=[ shared.StreamConfiguration( + name='string', cursor_field=[ 'string', ], - name='string', primary_key=[ [ 'string', @@ -283,12 +285,10 @@ req = shared.ConnectionCreateRequest( ), ], ), - destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', namespace_format='${SOURCE_NAMESPACE}', schedule=shared.ConnectionSchedule( - schedule_type=shared.ScheduleTypeEnum.MANUAL, + schedule_type=shared.ScheduleTypeEnum.CRON, ), - source_id='dd427d83-a555-4847-8358-42325b6c7b3f', ) res = s.connections.create_connection(req) @@ -346,13 +346,15 @@ s = airbyte.Airbyte( ) req = shared.ConnectionCreateRequest( + destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', + source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', configurations=shared.StreamConfigurations( streams=[ shared.StreamConfiguration( + name='string', cursor_field=[ 'string', ], - name='string', primary_key=[ [ 'string', @@ -361,12 +363,10 @@ req = shared.ConnectionCreateRequest( ), ], ), - destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', namespace_format='${SOURCE_NAMESPACE}', schedule=shared.ConnectionSchedule( - schedule_type=shared.ScheduleTypeEnum.MANUAL, + schedule_type=shared.ScheduleTypeEnum.CRON, ), - source_id='dd427d83-a555-4847-8358-42325b6c7b3f', ) res = s.connections.create_connection(req) diff --git a/RELEASES.md b/RELEASES.md index c00ce51b..3c4b4d88 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -828,4 +828,14 @@ Based on: ### Generated - [python v0.46.0] . ### Releases -- [PyPI v0.46.0] https://pypi.org/project/airbyte-api/0.46.0 - . \ No newline at end of file +- [PyPI v0.46.0] https://pypi.org/project/airbyte-api/0.46.0 - . + +## 2024-02-07 00:13:42 +### Changes +Based on: +- OpenAPI Doc 1.0.0 +- Speakeasy CLI 1.170.1 (2.250.12) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v0.47.0] . +### Releases +- [PyPI v0.47.0] https://pypi.org/project/airbyte-api/0.47.0 - . \ No newline at end of file diff --git a/USAGE.md b/USAGE.md index 08aae1c6..e87ae5d2 100644 --- a/USAGE.md +++ b/USAGE.md @@ -13,13 +13,15 @@ s = airbyte.Airbyte( ) req = shared.ConnectionCreateRequest( + destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', + source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', configurations=shared.StreamConfigurations( streams=[ shared.StreamConfiguration( + name='string', cursor_field=[ 'string', ], - name='string', primary_key=[ [ 'string', @@ -28,12 +30,10 @@ req = shared.ConnectionCreateRequest( ), ], ), - destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', namespace_format='${SOURCE_NAMESPACE}', schedule=shared.ConnectionSchedule( - schedule_type=shared.ScheduleTypeEnum.MANUAL, + schedule_type=shared.ScheduleTypeEnum.CRON, ), - source_id='dd427d83-a555-4847-8358-42325b6c7b3f', ) res = s.connections.create_connection(req) diff --git a/docs/models/operations/canceljobresponse.md b/docs/models/operations/canceljobresponse.md index 62eebf98..344ddd4e 100644 --- a/docs/models/operations/canceljobresponse.md +++ b/docs/models/operations/canceljobresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `job_response` | [Optional[shared.JobResponse]](../../models/shared/jobresponse.md) | :heavy_minus_sign: | Cancel a Job. | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `job_response` | [Optional[shared.JobResponse]](../../models/shared/jobresponse.md) | :heavy_minus_sign: | Cancel a Job. | \ No newline at end of file diff --git a/docs/models/operations/createconnectionresponse.md b/docs/models/operations/createconnectionresponse.md index 7709daee..3467ea8a 100644 --- a/docs/models/operations/createconnectionresponse.md +++ b/docs/models/operations/createconnectionresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `connection_response` | [Optional[shared.ConnectionResponse]](../../models/shared/connectionresponse.md) | :heavy_minus_sign: | Successful operation | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `connection_response` | [Optional[shared.ConnectionResponse]](../../models/shared/connectionresponse.md) | :heavy_minus_sign: | Successful operation | \ No newline at end of file diff --git a/docs/models/operations/createdestinationresponse.md b/docs/models/operations/createdestinationresponse.md index cc60507f..b705e661 100644 --- a/docs/models/operations/createdestinationresponse.md +++ b/docs/models/operations/createdestinationresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `destination_response` | [Optional[shared.DestinationResponse]](../../models/shared/destinationresponse.md) | :heavy_minus_sign: | Successful operation | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `destination_response` | [Optional[shared.DestinationResponse]](../../models/shared/destinationresponse.md) | :heavy_minus_sign: | Successful operation | \ No newline at end of file diff --git a/docs/models/operations/createjobresponse.md b/docs/models/operations/createjobresponse.md index 9b452971..9e33bf33 100644 --- a/docs/models/operations/createjobresponse.md +++ b/docs/models/operations/createjobresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `job_response` | [Optional[shared.JobResponse]](../../models/shared/jobresponse.md) | :heavy_minus_sign: | Kicks off a new Job based on the JobType. The connectionId is the resource that Job will be run for. | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `job_response` | [Optional[shared.JobResponse]](../../models/shared/jobresponse.md) | :heavy_minus_sign: | Kicks off a new Job based on the JobType. The connectionId is the resource that Job will be run for. | \ No newline at end of file diff --git a/docs/models/operations/createsourceresponse.md b/docs/models/operations/createsourceresponse.md index 9a892038..62a51392 100644 --- a/docs/models/operations/createsourceresponse.md +++ b/docs/models/operations/createsourceresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `source_response` | [Optional[shared.SourceResponse]](../../models/shared/sourceresponse.md) | :heavy_minus_sign: | Successful operation | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `source_response` | [Optional[shared.SourceResponse]](../../models/shared/sourceresponse.md) | :heavy_minus_sign: | Successful operation | \ No newline at end of file diff --git a/docs/models/operations/getconnectionresponse.md b/docs/models/operations/getconnectionresponse.md index 34e7beac..53faf956 100644 --- a/docs/models/operations/getconnectionresponse.md +++ b/docs/models/operations/getconnectionresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `connection_response` | [Optional[shared.ConnectionResponse]](../../models/shared/connectionresponse.md) | :heavy_minus_sign: | Get a Connection by the id in the path. | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `connection_response` | [Optional[shared.ConnectionResponse]](../../models/shared/connectionresponse.md) | :heavy_minus_sign: | Get a Connection by the id in the path. | \ No newline at end of file diff --git a/docs/models/operations/getdestinationresponse.md b/docs/models/operations/getdestinationresponse.md index c67a480e..eb46db32 100644 --- a/docs/models/operations/getdestinationresponse.md +++ b/docs/models/operations/getdestinationresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `destination_response` | [Optional[shared.DestinationResponse]](../../models/shared/destinationresponse.md) | :heavy_minus_sign: | Get a Destination by the id in the path. | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `destination_response` | [Optional[shared.DestinationResponse]](../../models/shared/destinationresponse.md) | :heavy_minus_sign: | Get a Destination by the id in the path. | \ No newline at end of file diff --git a/docs/models/operations/getjobresponse.md b/docs/models/operations/getjobresponse.md index da896acf..70425cd7 100644 --- a/docs/models/operations/getjobresponse.md +++ b/docs/models/operations/getjobresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `job_response` | [Optional[shared.JobResponse]](../../models/shared/jobresponse.md) | :heavy_minus_sign: | Get a Job by the id in the path. | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `job_response` | [Optional[shared.JobResponse]](../../models/shared/jobresponse.md) | :heavy_minus_sign: | Get a Job by the id in the path. | \ No newline at end of file diff --git a/docs/models/operations/getsourceresponse.md b/docs/models/operations/getsourceresponse.md index 5965df72..88e6f03a 100644 --- a/docs/models/operations/getsourceresponse.md +++ b/docs/models/operations/getsourceresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `source_response` | [Optional[shared.SourceResponse]](../../models/shared/sourceresponse.md) | :heavy_minus_sign: | Get a Source by the id in the path. | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `source_response` | [Optional[shared.SourceResponse]](../../models/shared/sourceresponse.md) | :heavy_minus_sign: | Get a Source by the id in the path. | \ No newline at end of file diff --git a/docs/models/operations/getstreampropertiesrequest.md b/docs/models/operations/getstreampropertiesrequest.md index ccc27881..67381f81 100644 --- a/docs/models/operations/getstreampropertiesrequest.md +++ b/docs/models/operations/getstreampropertiesrequest.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | `destination_id` | *str* | :heavy_check_mark: | ID of the destination | -| `ignore_cache` | *Optional[bool]* | :heavy_minus_sign: | If true pull the latest schema from the source, else pull from cache (default false) | -| `source_id` | *str* | :heavy_check_mark: | ID of the source | \ No newline at end of file +| `source_id` | *str* | :heavy_check_mark: | ID of the source | +| `ignore_cache` | *Optional[bool]* | :heavy_minus_sign: | If true pull the latest schema from the source, else pull from cache (default false) | \ No newline at end of file diff --git a/docs/models/operations/listconnectionsresponse.md b/docs/models/operations/listconnectionsresponse.md index f2d27f72..b5f291ab 100644 --- a/docs/models/operations/listconnectionsresponse.md +++ b/docs/models/operations/listconnectionsresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `connections_response` | [Optional[shared.ConnectionsResponse]](../../models/shared/connectionsresponse.md) | :heavy_minus_sign: | Successful operation | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `connections_response` | [Optional[shared.ConnectionsResponse]](../../models/shared/connectionsresponse.md) | :heavy_minus_sign: | Successful operation | \ No newline at end of file diff --git a/docs/models/operations/listdestinationsresponse.md b/docs/models/operations/listdestinationsresponse.md index e6a5c16e..13a19428 100644 --- a/docs/models/operations/listdestinationsresponse.md +++ b/docs/models/operations/listdestinationsresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `destinations_response` | [Optional[shared.DestinationsResponse]](../../models/shared/destinationsresponse.md) | :heavy_minus_sign: | Successful operation | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `destinations_response` | [Optional[shared.DestinationsResponse]](../../models/shared/destinationsresponse.md) | :heavy_minus_sign: | Successful operation | \ No newline at end of file diff --git a/docs/models/operations/listjobsresponse.md b/docs/models/operations/listjobsresponse.md index d58d70a6..f5a064d6 100644 --- a/docs/models/operations/listjobsresponse.md +++ b/docs/models/operations/listjobsresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `jobs_response` | [Optional[shared.JobsResponse]](../../models/shared/jobsresponse.md) | :heavy_minus_sign: | List all the Jobs by connectionId. | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `jobs_response` | [Optional[shared.JobsResponse]](../../models/shared/jobsresponse.md) | :heavy_minus_sign: | List all the Jobs by connectionId. | \ No newline at end of file diff --git a/docs/models/operations/listsourcesresponse.md b/docs/models/operations/listsourcesresponse.md index aec2888b..ceeaee56 100644 --- a/docs/models/operations/listsourcesresponse.md +++ b/docs/models/operations/listsourcesresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `sources_response` | [Optional[shared.SourcesResponse]](../../models/shared/sourcesresponse.md) | :heavy_minus_sign: | Successful operation | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `sources_response` | [Optional[shared.SourcesResponse]](../../models/shared/sourcesresponse.md) | :heavy_minus_sign: | Successful operation | \ No newline at end of file diff --git a/docs/models/operations/patchconnectionresponse.md b/docs/models/operations/patchconnectionresponse.md index aad7f70b..dfc3de6d 100644 --- a/docs/models/operations/patchconnectionresponse.md +++ b/docs/models/operations/patchconnectionresponse.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `connection_response` | [Optional[shared.ConnectionResponse]](../../models/shared/connectionresponse.md) | :heavy_minus_sign: | Update a Connection by the id in the path. | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `connection_response` | [Optional[shared.ConnectionResponse]](../../models/shared/connectionresponse.md) | :heavy_minus_sign: | Update a Connection by the id in the path. | \ No newline at end of file diff --git a/docs/models/operations/patchdestinationrequest.md b/docs/models/operations/patchdestinationrequest.md index 7599f24e..78ba063c 100644 --- a/docs/models/operations/patchdestinationrequest.md +++ b/docs/models/operations/patchdestinationrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `destination_patch_request` | [Optional[shared.DestinationPatchRequest]](../../models/shared/destinationpatchrequest.md) | :heavy_minus_sign: | N/A | -| `destination_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `destination_id` | *str* | :heavy_check_mark: | N/A | +| `destination_patch_request` | [Optional[shared.DestinationPatchRequest]](../../models/shared/destinationpatchrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/patchdestinationresponse.md b/docs/models/operations/patchdestinationresponse.md index f72892d5..5b35a483 100644 --- a/docs/models/operations/patchdestinationresponse.md +++ b/docs/models/operations/patchdestinationresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `destination_response` | [Optional[shared.DestinationResponse]](../../models/shared/destinationresponse.md) | :heavy_minus_sign: | Update a Destination | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `destination_response` | [Optional[shared.DestinationResponse]](../../models/shared/destinationresponse.md) | :heavy_minus_sign: | Update a Destination | \ No newline at end of file diff --git a/docs/models/operations/patchsourcerequest.md b/docs/models/operations/patchsourcerequest.md index 3ece2989..23c8c84f 100644 --- a/docs/models/operations/patchsourcerequest.md +++ b/docs/models/operations/patchsourcerequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `source_patch_request` | [Optional[shared.SourcePatchRequest]](../../models/shared/sourcepatchrequest.md) | :heavy_minus_sign: | N/A | -| `source_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_id` | *str* | :heavy_check_mark: | N/A | +| `source_patch_request` | [Optional[shared.SourcePatchRequest]](../../models/shared/sourcepatchrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/patchsourceresponse.md b/docs/models/operations/patchsourceresponse.md index b6f3d6b8..93ff3cc2 100644 --- a/docs/models/operations/patchsourceresponse.md +++ b/docs/models/operations/patchsourceresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `source_response` | [Optional[shared.SourceResponse]](../../models/shared/sourceresponse.md) | :heavy_minus_sign: | Update a Source | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `source_response` | [Optional[shared.SourceResponse]](../../models/shared/sourceresponse.md) | :heavy_minus_sign: | Update a Source | \ No newline at end of file diff --git a/docs/models/operations/putdestinationrequest.md b/docs/models/operations/putdestinationrequest.md index c98a4197..93f7ae1d 100644 --- a/docs/models/operations/putdestinationrequest.md +++ b/docs/models/operations/putdestinationrequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `destination_put_request` | [Optional[shared.DestinationPutRequest]](../../models/shared/destinationputrequest.md) | :heavy_minus_sign: | N/A | -| `destination_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `destination_id` | *str* | :heavy_check_mark: | N/A | +| `destination_put_request` | [Optional[shared.DestinationPutRequest]](../../models/shared/destinationputrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/putdestinationresponse.md b/docs/models/operations/putdestinationresponse.md index 599e5a93..005358df 100644 --- a/docs/models/operations/putdestinationresponse.md +++ b/docs/models/operations/putdestinationresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `destination_response` | [Optional[shared.DestinationResponse]](../../models/shared/destinationresponse.md) | :heavy_minus_sign: | Update a Destination and fully overwrite it | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `destination_response` | [Optional[shared.DestinationResponse]](../../models/shared/destinationresponse.md) | :heavy_minus_sign: | Update a Destination and fully overwrite it | \ No newline at end of file diff --git a/docs/models/operations/putsourcerequest.md b/docs/models/operations/putsourcerequest.md index f6d38115..ba170e0c 100644 --- a/docs/models/operations/putsourcerequest.md +++ b/docs/models/operations/putsourcerequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `source_put_request` | [Optional[shared.SourcePutRequest]](../../models/shared/sourceputrequest.md) | :heavy_minus_sign: | N/A | -| `source_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `source_id` | *str* | :heavy_check_mark: | N/A | +| `source_put_request` | [Optional[shared.SourcePutRequest]](../../models/shared/sourceputrequest.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/putsourceresponse.md b/docs/models/operations/putsourceresponse.md index 2e6cdebe..7515a378 100644 --- a/docs/models/operations/putsourceresponse.md +++ b/docs/models/operations/putsourceresponse.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `source_response` | [Optional[shared.SourceResponse]](../../models/shared/sourceresponse.md) | :heavy_minus_sign: | Update a source and fully overwrite it | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `source_response` | [Optional[shared.SourceResponse]](../../models/shared/sourceresponse.md) | :heavy_minus_sign: | Update a source and fully overwrite it | \ No newline at end of file diff --git a/docs/models/shared/amazons3.md b/docs/models/shared/amazons3.md index 17b775dc..d868b0c8 100644 --- a/docs/models/shared/amazons3.md +++ b/docs/models/shared/amazons3.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| `data_source_type` | [shared.DestinationDatabricksDataSourceType](../../models/shared/destinationdatabricksdatasourcetype.md) | :heavy_check_mark: | N/A | | -| `file_name_pattern` | *Optional[str]* | :heavy_minus_sign: | The pattern allows you to set the file-name format for the S3 staging file(s) | {date} | | `s3_access_key_id` | *str* | :heavy_check_mark: | The Access Key Id granting allow one to access the above S3 staging bucket. Airbyte requires Read and Write permissions to the given bucket. | A012345678910EXAMPLE | | `s3_bucket_name` | *str* | :heavy_check_mark: | The name of the S3 bucket to use for intermittent staging of the data. | airbyte.staging | | `s3_bucket_path` | *str* | :heavy_check_mark: | The directory under the S3 bucket where data will be written. | data_sync/test | -| `s3_bucket_region` | [Optional[shared.DestinationDatabricksS3BucketRegion]](../../models/shared/destinationdatabrickss3bucketregion.md) | :heavy_minus_sign: | The region of the S3 staging bucket to use if utilising a copy strategy. | | -| `s3_secret_access_key` | *str* | :heavy_check_mark: | The corresponding secret to the above access key id. | a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY | \ No newline at end of file +| `s3_secret_access_key` | *str* | :heavy_check_mark: | The corresponding secret to the above access key id. | a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY | +| `data_source_type` | [shared.DestinationDatabricksDataSourceType](../../models/shared/destinationdatabricksdatasourcetype.md) | :heavy_check_mark: | N/A | | +| `file_name_pattern` | *Optional[str]* | :heavy_minus_sign: | The pattern allows you to set the file-name format for the S3 staging file(s) | {date} | +| `s3_bucket_region` | [Optional[shared.DestinationDatabricksS3BucketRegion]](../../models/shared/destinationdatabrickss3bucketregion.md) | :heavy_minus_sign: | The region of the S3 staging bucket to use if utilising a copy strategy. | | \ No newline at end of file diff --git a/docs/models/shared/authenticateviaasanaoauth.md b/docs/models/shared/authenticateviaasanaoauth.md index 72e993e1..897cab89 100644 --- a/docs/models/shared/authenticateviaasanaoauth.md +++ b/docs/models/shared/authenticateviaasanaoauth.md @@ -7,5 +7,5 @@ | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | `client_id` | *str* | :heavy_check_mark: | N/A | | `client_secret` | *str* | :heavy_check_mark: | N/A | -| `option_title` | [Optional[shared.SourceAsanaCredentialsTitle]](../../models/shared/sourceasanacredentialstitle.md) | :heavy_minus_sign: | OAuth Credentials | -| `refresh_token` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `refresh_token` | *str* | :heavy_check_mark: | N/A | +| `option_title` | [Optional[shared.SourceAsanaCredentialsTitle]](../../models/shared/sourceasanacredentialstitle.md) | :heavy_minus_sign: | OAuth Credentials | \ No newline at end of file diff --git a/docs/models/shared/authenticateviagoogleoauth.md b/docs/models/shared/authenticateviagoogleoauth.md index d84d5f05..05e63d25 100644 --- a/docs/models/shared/authenticateviagoogleoauth.md +++ b/docs/models/shared/authenticateviagoogleoauth.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `access_token` | *Optional[str]* | :heavy_minus_sign: | Access Token for making authenticated requests. | -| `auth_type` | [Optional[shared.SourceGoogleAnalyticsDataAPIAuthType]](../../models/shared/sourcegoogleanalyticsdataapiauthtype.md) | :heavy_minus_sign: | N/A | | `client_id` | *str* | :heavy_check_mark: | The Client ID of your Google Analytics developer application. | | `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your Google Analytics developer application. | -| `refresh_token` | *str* | :heavy_check_mark: | The token for obtaining a new access token. | \ No newline at end of file +| `refresh_token` | *str* | :heavy_check_mark: | The token for obtaining a new access token. | +| `access_token` | *Optional[str]* | :heavy_minus_sign: | Access Token for making authenticated requests. | +| `auth_type` | [Optional[shared.SourceGoogleAnalyticsDataAPIAuthType]](../../models/shared/sourcegoogleanalyticsdataapiauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/authenticateviaharvestoauth.md b/docs/models/shared/authenticateviaharvestoauth.md index 177dee77..bfe06a97 100644 --- a/docs/models/shared/authenticateviaharvestoauth.md +++ b/docs/models/shared/authenticateviaharvestoauth.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `auth_type` | [Optional[shared.SourceHarvestAuthType]](../../models/shared/sourceharvestauthtype.md) | :heavy_minus_sign: | N/A | | `client_id` | *str* | :heavy_check_mark: | The Client ID of your Harvest developer application. | | `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your Harvest developer application. | -| `refresh_token` | *str* | :heavy_check_mark: | Refresh Token to renew the expired Access Token. | \ No newline at end of file +| `refresh_token` | *str* | :heavy_check_mark: | Refresh Token to renew the expired Access Token. | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `auth_type` | [Optional[shared.SourceHarvestAuthType]](../../models/shared/sourceharvestauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/authenticatevialeveroauth.md b/docs/models/shared/authenticatevialeveroauth.md index 3bef003d..61e028a8 100644 --- a/docs/models/shared/authenticatevialeveroauth.md +++ b/docs/models/shared/authenticatevialeveroauth.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `refresh_token` | *str* | :heavy_check_mark: | The token for obtaining new access token. | | `auth_type` | [Optional[shared.SourceLeverHiringAuthType]](../../models/shared/sourceleverhiringauthtype.md) | :heavy_minus_sign: | N/A | | `client_id` | *Optional[str]* | :heavy_minus_sign: | The Client ID of your Lever Hiring developer application. | -| `client_secret` | *Optional[str]* | :heavy_minus_sign: | The Client Secret of your Lever Hiring developer application. | -| `refresh_token` | *str* | :heavy_check_mark: | The token for obtaining new access token. | \ No newline at end of file +| `client_secret` | *Optional[str]* | :heavy_minus_sign: | The Client Secret of your Lever Hiring developer application. | \ No newline at end of file diff --git a/docs/models/shared/authenticateviamicrosoft.md b/docs/models/shared/authenticateviamicrosoft.md index 96f3d6b8..316895a7 100644 --- a/docs/models/shared/authenticateviamicrosoft.md +++ b/docs/models/shared/authenticateviamicrosoft.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth_type` | [Optional[shared.SourceMicrosoftTeamsSchemasAuthType]](../../models/shared/sourcemicrosoftteamsschemasauthtype.md) | :heavy_minus_sign: | N/A | | `client_id` | *str* | :heavy_check_mark: | The Client ID of your Microsoft Teams developer application. | | `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your Microsoft Teams developer application. | -| `tenant_id` | *str* | :heavy_check_mark: | A globally unique identifier (GUID) that is different than your organization name or domain. Follow these steps to obtain: open one of the Teams where you belong inside the Teams Application -> Click on the … next to the Team title -> Click on Get link to team -> Copy the link to the team and grab the tenant ID form the URL | \ No newline at end of file +| `tenant_id` | *str* | :heavy_check_mark: | A globally unique identifier (GUID) that is different than your organization name or domain. Follow these steps to obtain: open one of the Teams where you belong inside the Teams Application -> Click on the … next to the Team title -> Click on Get link to team -> Copy the link to the team and grab the tenant ID form the URL | +| `auth_type` | [Optional[shared.SourceMicrosoftTeamsSchemasAuthType]](../../models/shared/sourcemicrosoftteamsschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/authenticateviamicrosoftoauth20.md b/docs/models/shared/authenticateviamicrosoftoauth20.md index fda4ce04..7e4d4526 100644 --- a/docs/models/shared/authenticateviamicrosoftoauth20.md +++ b/docs/models/shared/authenticateviamicrosoftoauth20.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth_type` | [Optional[shared.SourceMicrosoftTeamsAuthType]](../../models/shared/sourcemicrosoftteamsauthtype.md) | :heavy_minus_sign: | N/A | | `client_id` | *str* | :heavy_check_mark: | The Client ID of your Microsoft Teams developer application. | | `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your Microsoft Teams developer application. | | `refresh_token` | *str* | :heavy_check_mark: | A Refresh Token to renew the expired Access Token. | -| `tenant_id` | *str* | :heavy_check_mark: | A globally unique identifier (GUID) that is different than your organization name or domain. Follow these steps to obtain: open one of the Teams where you belong inside the Teams Application -> Click on the … next to the Team title -> Click on Get link to team -> Copy the link to the team and grab the tenant ID form the URL | \ No newline at end of file +| `tenant_id` | *str* | :heavy_check_mark: | A globally unique identifier (GUID) that is different than your organization name or domain. Follow these steps to obtain: open one of the Teams where you belong inside the Teams Application -> Click on the … next to the Team title -> Click on Get link to team -> Copy the link to the team and grab the tenant ID form the URL | +| `auth_type` | [Optional[shared.SourceMicrosoftTeamsAuthType]](../../models/shared/sourcemicrosoftteamsauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/authenticateviaoauth.md b/docs/models/shared/authenticateviaoauth.md index 477eff4d..e2c0d9cc 100644 --- a/docs/models/shared/authenticateviaoauth.md +++ b/docs/models/shared/authenticateviaoauth.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | -| `auth_type` | [shared.SourceSalesloftAuthType](../../models/shared/sourcesalesloftauthtype.md) | :heavy_check_mark: | N/A | | `client_id` | *str* | :heavy_check_mark: | The Client ID of your Salesloft developer application. | | `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your Salesloft developer application. | | `refresh_token` | *str* | :heavy_check_mark: | The token for obtaining a new access token. | -| `token_expiry_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date-time when the access token should be refreshed. | \ No newline at end of file +| `token_expiry_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date-time when the access token should be refreshed. | +| `auth_type` | [shared.SourceSalesloftAuthType](../../models/shared/sourcesalesloftauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/authenticateviaoauth20.md b/docs/models/shared/authenticateviaoauth20.md index 3fed47f7..6ee3e6c2 100644 --- a/docs/models/shared/authenticateviaoauth20.md +++ b/docs/models/shared/authenticateviaoauth20.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `client_id` | *str* | :heavy_check_mark: | The Client ID of your developer application | | `client_secret` | *str* | :heavy_check_mark: | The client secret of your developer application | -| `refresh_token` | *str* | :heavy_check_mark: | A refresh token generated using the above client ID and secret | \ No newline at end of file +| `refresh_token` | *str* | :heavy_check_mark: | A refresh token generated using the above client ID and secret | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/authenticateviaretentlyoauth.md b/docs/models/shared/authenticateviaretentlyoauth.md index b1ff3932..a0fc2813 100644 --- a/docs/models/shared/authenticateviaretentlyoauth.md +++ b/docs/models/shared/authenticateviaretentlyoauth.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | -| `auth_type` | [Optional[shared.SourceRetentlyAuthType]](../../models/shared/sourceretentlyauthtype.md) | :heavy_minus_sign: | N/A | | `client_id` | *str* | :heavy_check_mark: | The Client ID of your Retently developer application. | | `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your Retently developer application. | -| `refresh_token` | *str* | :heavy_check_mark: | Retently Refresh Token which can be used to fetch new Bearer Tokens when the current one expires. | \ No newline at end of file +| `refresh_token` | *str* | :heavy_check_mark: | Retently Refresh Token which can be used to fetch new Bearer Tokens when the current one expires. | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `auth_type` | [Optional[shared.SourceRetentlyAuthType]](../../models/shared/sourceretentlyauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/authenticatewithapitoken.md b/docs/models/shared/authenticatewithapitoken.md index 45043293..2ff33afc 100644 --- a/docs/models/shared/authenticatewithapitoken.md +++ b/docs/models/shared/authenticatewithapitoken.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `api_key` | *str* | :heavy_check_mark: | Retently API Token. See the docs for more information on how to obtain this key. | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `auth_type` | [Optional[shared.SourceRetentlySchemasAuthType]](../../models/shared/sourceretentlyschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/authenticatewithpersonalaccesstoken.md b/docs/models/shared/authenticatewithpersonalaccesstoken.md index 613a8a87..14c6c23b 100644 --- a/docs/models/shared/authenticatewithpersonalaccesstoken.md +++ b/docs/models/shared/authenticatewithpersonalaccesstoken.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `option_title` | [Optional[shared.SourceAsanaSchemasCredentialsTitle]](../../models/shared/sourceasanaschemascredentialstitle.md) | :heavy_minus_sign: | PAT Credentials | -| `personal_access_token` | *str* | :heavy_check_mark: | Asana Personal Access Token (generate yours here). | \ No newline at end of file +| `personal_access_token` | *str* | :heavy_check_mark: | Asana Personal Access Token (generate yours here). | +| `option_title` | [Optional[shared.SourceAsanaSchemasCredentialsTitle]](../../models/shared/sourceasanaschemascredentialstitle.md) | :heavy_minus_sign: | PAT Credentials | \ No newline at end of file diff --git a/docs/models/shared/awss3staging.md b/docs/models/shared/awss3staging.md index 31d1fe02..5c492055 100644 --- a/docs/models/shared/awss3staging.md +++ b/docs/models/shared/awss3staging.md @@ -8,12 +8,12 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `access_key_id` | *str* | :heavy_check_mark: | This ID grants access to the above S3 staging bucket. Airbyte requires Read and Write permissions to the given bucket. See AWS docs on how to generate an access key ID and secret access key. | | +| `s3_bucket_name` | *str* | :heavy_check_mark: | The name of the staging S3 bucket. | airbyte.staging | +| `secret_access_key` | *str* | :heavy_check_mark: | The corresponding secret to the above access key id. See AWS docs on how to generate an access key ID and secret access key. | | | `encryption` | [Optional[Union[shared.NoEncryption, shared.AESCBCEnvelopeEncryption]]](../../models/shared/destinationredshiftencryption.md) | :heavy_minus_sign: | How to encrypt the staging data | | | `file_buffer_count` | *Optional[int]* | :heavy_minus_sign: | Number of file buffers allocated for writing data. Increasing this number is beneficial for connections using Change Data Capture (CDC) and up to the number of streams within a connection. Increasing the number of file buffers past the maximum number of streams has deteriorating effects | 10 | | `file_name_pattern` | *Optional[str]* | :heavy_minus_sign: | The pattern allows you to set the file-name format for the S3 staging file(s) | {date} | | `method` | [shared.DestinationRedshiftMethod](../../models/shared/destinationredshiftmethod.md) | :heavy_check_mark: | N/A | | | `purge_staging_data` | *Optional[bool]* | :heavy_minus_sign: | Whether to delete the staging files from S3 after completing the sync. See docs for details. | | -| `s3_bucket_name` | *str* | :heavy_check_mark: | The name of the staging S3 bucket. | airbyte.staging | | `s3_bucket_path` | *Optional[str]* | :heavy_minus_sign: | The directory under the S3 bucket where data will be written. If not provided, then defaults to the root directory. See path's name recommendations for more details. | data_sync/test | -| `s3_bucket_region` | [Optional[shared.DestinationRedshiftS3BucketRegion]](../../models/shared/destinationredshifts3bucketregion.md) | :heavy_minus_sign: | The region of the S3 staging bucket. | | -| `secret_access_key` | *str* | :heavy_check_mark: | The corresponding secret to the above access key id. See AWS docs on how to generate an access key ID and secret access key. | | \ No newline at end of file +| `s3_bucket_region` | [Optional[shared.DestinationRedshiftS3BucketRegion]](../../models/shared/destinationredshifts3bucketregion.md) | :heavy_minus_sign: | The region of the S3 staging bucket. | | \ No newline at end of file diff --git a/docs/models/shared/azblobazureblobstorage.md b/docs/models/shared/azblobazureblobstorage.md index 29340aa6..5062c1af 100644 --- a/docs/models/shared/azblobazureblobstorage.md +++ b/docs/models/shared/azblobazureblobstorage.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `storage_account` | *str* | :heavy_check_mark: | The globally unique name of the storage account that the desired blob sits within. See here for more details. | | `sas_token` | *Optional[str]* | :heavy_minus_sign: | To access Azure Blob Storage, this connector would need credentials with the proper permissions. One option is a SAS (Shared Access Signature) token. If accessing publicly available data, this field is not necessary. | | `shared_key` | *Optional[str]* | :heavy_minus_sign: | To access Azure Blob Storage, this connector would need credentials with the proper permissions. One option is a storage account shared key (aka account key or access key). If accessing publicly available data, this field is not necessary. | -| `storage` | [shared.SourceFileSchemasProviderStorage](../../models/shared/sourcefileschemasproviderstorage.md) | :heavy_check_mark: | N/A | -| `storage_account` | *str* | :heavy_check_mark: | The globally unique name of the storage account that the desired blob sits within. See here for more details. | \ No newline at end of file +| `storage` | [shared.SourceFileSchemasProviderStorage](../../models/shared/sourcefileschemasproviderstorage.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/azureopenai.md b/docs/models/shared/azureopenai.md index c4c9a972..adcc1358 100644 --- a/docs/models/shared/azureopenai.md +++ b/docs/models/shared/azureopenai.md @@ -9,5 +9,5 @@ Use the Azure-hosted OpenAI API to embed text. This option is using the text-emb | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `api_base` | *str* | :heavy_check_mark: | The base URL for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource | https://your-resource-name.openai.azure.com | | `deployment` | *str* | :heavy_check_mark: | The deployment for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource | your-resource-name | -| `mode` | [Optional[shared.DestinationMilvusSchemasEmbeddingEmbeddingMode]](../../models/shared/destinationmilvusschemasembeddingembeddingmode.md) | :heavy_minus_sign: | N/A | | -| `openai_key` | *str* | :heavy_check_mark: | The API key for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource | | \ No newline at end of file +| `openai_key` | *str* | :heavy_check_mark: | The API key for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource | | +| `mode` | [Optional[shared.DestinationMilvusSchemasEmbeddingEmbeddingMode]](../../models/shared/destinationmilvusschemasembeddingembeddingmode.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/betweenfilter.md b/docs/models/shared/betweenfilter.md index 96087603..e6893fe7 100644 --- a/docs/models/shared/betweenfilter.md +++ b/docs/models/shared/betweenfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfiltername.md) | :heavy_check_mark: | N/A | | `from_value` | [Union[shared.SourceGoogleAnalyticsDataAPIInt64Value, shared.SourceGoogleAnalyticsDataAPIDoubleValue]](../../models/shared/fromvalue.md) | :heavy_check_mark: | N/A | -| `to_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasDoubleValue]](../../models/shared/tovalue.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `to_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasDoubleValue]](../../models/shared/tovalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/centralapirouter.md b/docs/models/shared/centralapirouter.md index 40b0b114..8c6b2bd8 100644 --- a/docs/models/shared/centralapirouter.md +++ b/docs/models/shared/centralapirouter.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `auth_type` | [shared.SourceCartAuthType](../../models/shared/sourcecartauthtype.md) | :heavy_check_mark: | N/A | | `site_id` | *str* | :heavy_check_mark: | You can determine a site provisioning site Id by hitting https://site.com/store/sitemonitor.aspx and reading the response param PSID | | `user_name` | *str* | :heavy_check_mark: | Enter your application's User Name | -| `user_secret` | *str* | :heavy_check_mark: | Enter your application's User Secret | \ No newline at end of file +| `user_secret` | *str* | :heavy_check_mark: | Enter your application's User Secret | +| `auth_type` | [shared.SourceCartAuthType](../../models/shared/sourcecartauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/chromalocalpersistance.md b/docs/models/shared/chromalocalpersistance.md index c5639965..1d1d1870 100644 --- a/docs/models/shared/chromalocalpersistance.md +++ b/docs/models/shared/chromalocalpersistance.md @@ -7,6 +7,6 @@ Chroma is a popular vector store that can be used to store and retrieve embeddin | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `collection_name` | *Optional[str]* | :heavy_minus_sign: | Name of the collection to use. | | | `destination_path` | *str* | :heavy_check_mark: | Path to the directory where chroma files will be written. The files will be placed inside that local mount. | /local/my_chroma_db | +| `collection_name` | *Optional[str]* | :heavy_minus_sign: | Name of the collection to use. | | | `mode` | [Optional[shared.DestinationLangchainSchemasIndexingIndexingMode]](../../models/shared/destinationlangchainschemasindexingindexingmode.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/connectioncreaterequest.md b/docs/models/shared/connectioncreaterequest.md index c557362e..9d96300e 100644 --- a/docs/models/shared/connectioncreaterequest.md +++ b/docs/models/shared/connectioncreaterequest.md @@ -5,14 +5,14 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `destination_id` | *str* | :heavy_check_mark: | N/A | | +| `source_id` | *str* | :heavy_check_mark: | N/A | | | `configurations` | [Optional[shared.StreamConfigurations]](../../models/shared/streamconfigurations.md) | :heavy_minus_sign: | A list of configured stream options for a connection. | | | `data_residency` | [Optional[shared.GeographyEnum]](../../models/shared/geographyenum.md) | :heavy_minus_sign: | N/A | | -| `destination_id` | *str* | :heavy_check_mark: | N/A | | | `name` | *Optional[str]* | :heavy_minus_sign: | Optional name of the connection | | | `namespace_definition` | [Optional[shared.NamespaceDefinitionEnum]](../../models/shared/namespacedefinitionenum.md) | :heavy_minus_sign: | Define the location where the data will be stored in the destination | | | `namespace_format` | *Optional[str]* | :heavy_minus_sign: | Used when namespaceDefinition is 'custom_format'. If blank then behaves like namespaceDefinition = 'destination'. If "${SOURCE_NAMESPACE}" then behaves like namespaceDefinition = 'source'. | ${SOURCE_NAMESPACE} | | `non_breaking_schema_updates_behavior` | [Optional[shared.NonBreakingSchemaUpdatesBehaviorEnum]](../../models/shared/nonbreakingschemaupdatesbehaviorenum.md) | :heavy_minus_sign: | Set how Airbyte handles syncs when it detects a non-breaking schema change in the source | | | `prefix` | *Optional[str]* | :heavy_minus_sign: | Prefix that will be prepended to the name of each stream when it is written to the destination (ex. “airbyte_” causes “projects” => “airbyte_projects”). | | | `schedule` | [Optional[shared.ConnectionSchedule]](../../models/shared/connectionschedule.md) | :heavy_minus_sign: | schedule for when the the connection should run, per the schedule type | | -| `source_id` | *str* | :heavy_check_mark: | N/A | | | `status` | [Optional[shared.ConnectionStatusEnum]](../../models/shared/connectionstatusenum.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/connectionresponse.md b/docs/models/shared/connectionresponse.md index 4f19b38b..b7ae038d 100644 --- a/docs/models/shared/connectionresponse.md +++ b/docs/models/shared/connectionresponse.md @@ -9,14 +9,14 @@ Provides details of a single connection. | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | | `configurations` | [shared.StreamConfigurations](../../models/shared/streamconfigurations.md) | :heavy_check_mark: | A list of configured stream options for a connection. | | `connection_id` | *str* | :heavy_check_mark: | N/A | -| `data_residency` | [Optional[shared.GeographyEnum]](../../models/shared/geographyenum.md) | :heavy_minus_sign: | N/A | | `destination_id` | *str* | :heavy_check_mark: | N/A | | `name` | *str* | :heavy_check_mark: | N/A | -| `namespace_definition` | [Optional[shared.NamespaceDefinitionEnum]](../../models/shared/namespacedefinitionenum.md) | :heavy_minus_sign: | Define the location where the data will be stored in the destination | -| `namespace_format` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `non_breaking_schema_updates_behavior` | [Optional[shared.NonBreakingSchemaUpdatesBehaviorEnum]](../../models/shared/nonbreakingschemaupdatesbehaviorenum.md) | :heavy_minus_sign: | Set how Airbyte handles syncs when it detects a non-breaking schema change in the source | -| `prefix` | *Optional[str]* | :heavy_minus_sign: | N/A | | `schedule` | [shared.ConnectionScheduleResponse](../../models/shared/connectionscheduleresponse.md) | :heavy_check_mark: | schedule for when the the connection should run, per the schedule type | | `source_id` | *str* | :heavy_check_mark: | N/A | | `status` | [shared.ConnectionStatusEnum](../../models/shared/connectionstatusenum.md) | :heavy_check_mark: | N/A | -| `workspace_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `workspace_id` | *str* | :heavy_check_mark: | N/A | +| `data_residency` | [Optional[shared.GeographyEnum]](../../models/shared/geographyenum.md) | :heavy_minus_sign: | N/A | +| `namespace_definition` | [Optional[shared.NamespaceDefinitionEnum]](../../models/shared/namespacedefinitionenum.md) | :heavy_minus_sign: | Define the location where the data will be stored in the destination | +| `namespace_format` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `non_breaking_schema_updates_behavior` | [Optional[shared.NonBreakingSchemaUpdatesBehaviorEnum]](../../models/shared/nonbreakingschemaupdatesbehaviorenum.md) | :heavy_minus_sign: | Set how Airbyte handles syncs when it detects a non-breaking schema change in the source | +| `prefix` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/connectionschedule.md b/docs/models/shared/connectionschedule.md index 05115ebf..c6322857 100644 --- a/docs/models/shared/connectionschedule.md +++ b/docs/models/shared/connectionschedule.md @@ -7,5 +7,5 @@ schedule for when the the connection should run, per the schedule type | Field | Type | Required | Description | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | -| `cron_expression` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `schedule_type` | [shared.ScheduleTypeEnum](../../models/shared/scheduletypeenum.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `schedule_type` | [shared.ScheduleTypeEnum](../../models/shared/scheduletypeenum.md) | :heavy_check_mark: | N/A | +| `cron_expression` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/connectionscheduleresponse.md b/docs/models/shared/connectionscheduleresponse.md index 99b78d88..70132466 100644 --- a/docs/models/shared/connectionscheduleresponse.md +++ b/docs/models/shared/connectionscheduleresponse.md @@ -7,6 +7,6 @@ schedule for when the the connection should run, per the schedule type | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | +| `schedule_type` | [shared.ScheduleTypeWithBasicEnum](../../models/shared/scheduletypewithbasicenum.md) | :heavy_check_mark: | N/A | | `basic_timing` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `cron_expression` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `schedule_type` | [shared.ScheduleTypeWithBasicEnum](../../models/shared/scheduletypewithbasicenum.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `cron_expression` | *Optional[str]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/continuousfeed.md b/docs/models/shared/continuousfeed.md index 96920b2a..e4c1aa35 100644 --- a/docs/models/shared/continuousfeed.md +++ b/docs/models/shared/continuousfeed.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| `mock_catalog` | [Union[shared.SingleSchema, shared.MultiSchema]](../../models/shared/mockcatalog.md) | :heavy_check_mark: | N/A | | | `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | | `max_messages` | *Optional[int]* | :heavy_minus_sign: | Number of records to emit per stream. Min 1. Max 100 billion. | | | `message_interval_ms` | *Optional[int]* | :heavy_minus_sign: | Interval between messages in ms. Min 0 ms. Max 60000 ms (1 minute). | | -| `mock_catalog` | [Union[shared.SingleSchema, shared.MultiSchema]](../../models/shared/mockcatalog.md) | :heavy_check_mark: | N/A | | | `seed` | *Optional[int]* | :heavy_minus_sign: | When the seed is unspecified, the current time millis will be used as the seed. Range: [0, 1000000]. | 42 | | `source_type` | [Optional[shared.E2eTestCloud]](../../models/shared/e2etestcloud.md) | :heavy_minus_sign: | N/A | | | `type` | [Optional[shared.Type]](../../models/shared/type.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/customreportconfig.md b/docs/models/shared/customreportconfig.md index 5650b9e3..6a251d81 100644 --- a/docs/models/shared/customreportconfig.md +++ b/docs/models/shared/customreportconfig.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `name` | *str* | :heavy_check_mark: | The name of the custom report, this name would be used as stream name | Account Performance | -| `report_aggregation` | *Optional[str]* | :heavy_minus_sign: | A list of available aggregations. | | | `report_columns` | List[*str*] | :heavy_check_mark: | A list of available report object columns. You can find it in description of reporting object that you want to add to custom report. | | -| `reporting_object` | [shared.ReportingDataObject](../../models/shared/reportingdataobject.md) | :heavy_check_mark: | The name of the the object derives from the ReportRequest object. You can find it in Bing Ads Api docs - Reporting API - Reporting Data Objects. | | \ No newline at end of file +| `reporting_object` | [shared.ReportingDataObject](../../models/shared/reportingdataobject.md) | :heavy_check_mark: | The name of the the object derives from the ReportRequest object. You can find it in Bing Ads Api docs - Reporting API - Reporting Data Objects. | | +| `report_aggregation` | *Optional[str]* | :heavy_minus_sign: | A list of available aggregations. | | \ No newline at end of file diff --git a/docs/models/shared/destinationawsdatalake.md b/docs/models/shared/destinationawsdatalake.md index 5305a426..818054df 100644 --- a/docs/models/shared/destinationawsdatalake.md +++ b/docs/models/shared/destinationawsdatalake.md @@ -5,16 +5,16 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `aws_account_id` | *Optional[str]* | :heavy_minus_sign: | target aws account id | 111111111111 | | `bucket_name` | *str* | :heavy_check_mark: | The name of the S3 bucket. Read more here. | | -| `bucket_prefix` | *Optional[str]* | :heavy_minus_sign: | S3 prefix | | | `credentials` | [Union[shared.IAMRole, shared.IAMUser]](../../models/shared/authenticationmode.md) | :heavy_check_mark: | Choose How to Authenticate to AWS. | | +| `lakeformation_database_name` | *str* | :heavy_check_mark: | The default database this destination will use to create tables in per stream. Can be changed per connection by customizing the namespace. | | +| `aws_account_id` | *Optional[str]* | :heavy_minus_sign: | target aws account id | 111111111111 | +| `bucket_prefix` | *Optional[str]* | :heavy_minus_sign: | S3 prefix | | | `destination_type` | [shared.AwsDatalake](../../models/shared/awsdatalake.md) | :heavy_check_mark: | N/A | | | `format` | [Optional[Union[shared.JSONLinesNewlineDelimitedJSON, shared.ParquetColumnarStorage]]](../../models/shared/outputformatwildcard.md) | :heavy_minus_sign: | Format of the data output. | | | `glue_catalog_float_as_decimal` | *Optional[bool]* | :heavy_minus_sign: | Cast float/double as decimal(38,18). This can help achieve higher accuracy and represent numbers correctly as received from the source. | | | `lakeformation_database_default_tag_key` | *Optional[str]* | :heavy_minus_sign: | Add a default tag key to databases created by this destination | pii_level | | `lakeformation_database_default_tag_values` | *Optional[str]* | :heavy_minus_sign: | Add default values for the `Tag Key` to databases created by this destination. Comma separate for multiple values. | private,public | -| `lakeformation_database_name` | *str* | :heavy_check_mark: | The default database this destination will use to create tables in per stream. Can be changed per connection by customizing the namespace. | | | `lakeformation_governed_tables` | *Optional[bool]* | :heavy_minus_sign: | Whether to create tables as LF governed tables. | | | `partitioning` | [Optional[shared.ChooseHowToPartitionData]](../../models/shared/choosehowtopartitiondata.md) | :heavy_minus_sign: | Partition data by cursor fields when a cursor field is a date | | | `region` | [Optional[shared.S3BucketRegion]](../../models/shared/s3bucketregion.md) | :heavy_minus_sign: | The region of the S3 bucket. See here for all region codes. | | \ No newline at end of file diff --git a/docs/models/shared/destinationazureblobstorage.md b/docs/models/shared/destinationazureblobstorage.md index 72b9a6b5..2580fe47 100644 --- a/docs/models/shared/destinationazureblobstorage.md +++ b/docs/models/shared/destinationazureblobstorage.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `azure_blob_storage_account_key` | *str* | :heavy_check_mark: | The Azure blob storage account key. | Z8ZkZpteggFx394vm+PJHnGTvdRncaYS+JhLKdj789YNmD+iyGTnG+PV+POiuYNhBg/ACS+LKjd%4FG3FHGN12Nd== | | `azure_blob_storage_account_name` | *str* | :heavy_check_mark: | The account's name of the Azure Blob Storage. | airbyte5storage | +| `format` | [Union[shared.CSVCommaSeparatedValues, shared.DestinationAzureBlobStorageJSONLinesNewlineDelimitedJSON]](../../models/shared/outputformat.md) | :heavy_check_mark: | Output data format | | | `azure_blob_storage_container_name` | *Optional[str]* | :heavy_minus_sign: | The name of the Azure blob storage container. If not exists - will be created automatically. May be empty, then will be created automatically airbytecontainer+timestamp | airbytetescontainername | | `azure_blob_storage_endpoint_domain_name` | *Optional[str]* | :heavy_minus_sign: | This is Azure Blob Storage endpoint domain name. Leave default value (or leave it empty if run container from command line) to use Microsoft native from example. | blob.core.windows.net | | `azure_blob_storage_output_buffer_size` | *Optional[int]* | :heavy_minus_sign: | The amount of megabytes to buffer for the output stream to Azure. This will impact memory footprint on workers, but may need adjustment for performance and appropriate block size in Azure. | 5 | | `azure_blob_storage_spill_size` | *Optional[int]* | :heavy_minus_sign: | The amount of megabytes after which the connector should spill the records in a new blob object. Make sure to configure size greater than individual records. Enter 0 if not applicable | 500 | -| `destination_type` | [shared.AzureBlobStorage](../../models/shared/azureblobstorage.md) | :heavy_check_mark: | N/A | | -| `format` | [Union[shared.CSVCommaSeparatedValues, shared.DestinationAzureBlobStorageJSONLinesNewlineDelimitedJSON]](../../models/shared/outputformat.md) | :heavy_check_mark: | Output data format | | \ No newline at end of file +| `destination_type` | [shared.AzureBlobStorage](../../models/shared/azureblobstorage.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/destinationbigquery.md b/docs/models/shared/destinationbigquery.md index aae1cf0b..d703faf7 100644 --- a/docs/models/shared/destinationbigquery.md +++ b/docs/models/shared/destinationbigquery.md @@ -5,13 +5,13 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `big_query_client_buffer_size_mb` | *Optional[int]* | :heavy_minus_sign: | Google BigQuery client's chunk (buffer) size (MIN=1, MAX = 15) for each table. The size that will be written by a single RPC. Written data will be buffered and only flushed upon reaching this size or closing the channel. The default 15MB value is used if not set explicitly. Read more here. | 15 | -| `credentials_json` | *Optional[str]* | :heavy_minus_sign: | The contents of the JSON service account key. Check out the docs if you need help generating this key. Default credentials will be used if this field is left empty. | | | `dataset_id` | *str* | :heavy_check_mark: | The default BigQuery Dataset ID that tables are replicated to if the source does not specify a namespace. Read more here. | | | `dataset_location` | [shared.DatasetLocation](../../models/shared/datasetlocation.md) | :heavy_check_mark: | The location of the dataset. Warning: Changes made after creation will not be applied. Read more here. | | +| `project_id` | *str* | :heavy_check_mark: | The GCP project ID for the project containing the target BigQuery dataset. Read more here. | | +| `big_query_client_buffer_size_mb` | *Optional[int]* | :heavy_minus_sign: | Google BigQuery client's chunk (buffer) size (MIN=1, MAX = 15) for each table. The size that will be written by a single RPC. Written data will be buffered and only flushed upon reaching this size or closing the channel. The default 15MB value is used if not set explicitly. Read more here. | 15 | +| `credentials_json` | *Optional[str]* | :heavy_minus_sign: | The contents of the JSON service account key. Check out the docs if you need help generating this key. Default credentials will be used if this field is left empty. | | | `destination_type` | [shared.Bigquery](../../models/shared/bigquery.md) | :heavy_check_mark: | N/A | | | `disable_type_dedupe` | *Optional[bool]* | :heavy_minus_sign: | Disable Writing Final Tables. WARNING! The data format in _airbyte_data is likely stable but there are no guarantees that other metadata columns will remain the same in future versions | | | `loading_method` | [Optional[Union[shared.GCSStaging, shared.StandardInserts]]](../../models/shared/loadingmethod.md) | :heavy_minus_sign: | The way data will be uploaded to BigQuery. | | -| `project_id` | *str* | :heavy_check_mark: | The GCP project ID for the project containing the target BigQuery dataset. Read more here. | | | `raw_data_dataset` | *Optional[str]* | :heavy_minus_sign: | The dataset to write raw tables into (default: airbyte_internal) | | | `transformation_priority` | [Optional[shared.TransformationQueryRunType]](../../models/shared/transformationqueryruntype.md) | :heavy_minus_sign: | Interactive run type means that the query is executed as soon as possible, and these queries count towards concurrent rate limit and daily limit. Read more about interactive run type here. Batch queries are queued and started as soon as idle resources are available in the BigQuery shared resource pool, which usually occurs within a few minutes. Batch queries don’t count towards your concurrent rate limit. Read more about batch queries here. The default "interactive" value is used if not set explicitly. | | \ No newline at end of file diff --git a/docs/models/shared/destinationbigqueryhmackey.md b/docs/models/shared/destinationbigqueryhmackey.md index 86f82d1f..f192db21 100644 --- a/docs/models/shared/destinationbigqueryhmackey.md +++ b/docs/models/shared/destinationbigqueryhmackey.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `credential_type` | [shared.DestinationBigqueryCredentialType](../../models/shared/destinationbigquerycredentialtype.md) | :heavy_check_mark: | N/A | | | `hmac_key_access_id` | *str* | :heavy_check_mark: | HMAC key access ID. When linked to a service account, this ID is 61 characters long; when linked to a user account, it is 24 characters long. | 1234567890abcdefghij1234 | -| `hmac_key_secret` | *str* | :heavy_check_mark: | The corresponding secret for the access ID. It is a 40-character base-64 encoded string. | 1234567890abcdefghij1234567890ABCDEFGHIJ | \ No newline at end of file +| `hmac_key_secret` | *str* | :heavy_check_mark: | The corresponding secret for the access ID. It is a 40-character base-64 encoded string. | 1234567890abcdefghij1234567890ABCDEFGHIJ | +| `credential_type` | [shared.DestinationBigqueryCredentialType](../../models/shared/destinationbigquerycredentialtype.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/destinationclickhouse.md b/docs/models/shared/destinationclickhouse.md index 86101623..911e8575 100644 --- a/docs/models/shared/destinationclickhouse.md +++ b/docs/models/shared/destinationclickhouse.md @@ -6,10 +6,10 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `database` | *str* | :heavy_check_mark: | Name of the database. | | -| `destination_type` | [shared.Clickhouse](../../models/shared/clickhouse.md) | :heavy_check_mark: | N/A | | | `host` | *str* | :heavy_check_mark: | Hostname of the database. | | +| `username` | *str* | :heavy_check_mark: | Username to use to access the database. | | +| `destination_type` | [shared.Clickhouse](../../models/shared/clickhouse.md) | :heavy_check_mark: | N/A | | | `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3). | | | `password` | *Optional[str]* | :heavy_minus_sign: | Password associated with the username. | | | `port` | *Optional[int]* | :heavy_minus_sign: | HTTP port of the database. | 8123 | -| `tunnel_method` | [Optional[Union[shared.NoTunnel, shared.SSHKeyAuthentication, shared.PasswordAuthentication]]](../../models/shared/sshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | -| `username` | *str* | :heavy_check_mark: | Username to use to access the database. | | \ No newline at end of file +| `tunnel_method` | [Optional[Union[shared.NoTunnel, shared.SSHKeyAuthentication, shared.PasswordAuthentication]]](../../models/shared/sshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | \ No newline at end of file diff --git a/docs/models/shared/destinationcreaterequest.md b/docs/models/shared/destinationcreaterequest.md index a9fefe00..fc4c898f 100644 --- a/docs/models/shared/destinationcreaterequest.md +++ b/docs/models/shared/destinationcreaterequest.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `configuration` | [Union[shared.DestinationGoogleSheets, shared.DestinationAwsDatalake, shared.DestinationAzureBlobStorage, shared.DestinationBigquery, shared.DestinationClickhouse, shared.DestinationConvex, shared.DestinationCumulio, shared.DestinationDatabend, shared.DestinationDatabricks, shared.DestinationDevNull, shared.DestinationDuckdb, shared.DestinationDynamodb, shared.DestinationElasticsearch, shared.DestinationFirebolt, shared.DestinationFirestore, shared.DestinationGcs, shared.DestinationKeen, shared.DestinationKinesis, shared.DestinationLangchain, shared.DestinationMilvus, shared.DestinationMongodb, shared.DestinationMssql, shared.DestinationMysql, shared.DestinationOracle, shared.DestinationPinecone, shared.DestinationPostgres, shared.DestinationPubsub, shared.DestinationQdrant, shared.DestinationRedis, shared.DestinationRedshift, shared.DestinationS3, shared.DestinationS3Glue, shared.DestinationSftpJSON, shared.DestinationSnowflake, shared.DestinationTimeplus, shared.DestinationTypesense, shared.DestinationVectara, shared.DestinationVertica, shared.DestinationWeaviate, shared.DestinationXata]](../../models/shared/destinationconfiguration.md) | :heavy_check_mark: | The values required to configure the destination. | {"user":"charles"} | -| `definition_id` | *Optional[str]* | :heavy_minus_sign: | The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. | | | `name` | *str* | :heavy_check_mark: | Name of the destination e.g. dev-mysql-instance. | | -| `workspace_id` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `workspace_id` | *str* | :heavy_check_mark: | N/A | | +| `definition_id` | *Optional[str]* | :heavy_minus_sign: | The UUID of the connector definition. One of configuration.destinationType or definitionId must be provided. | | \ No newline at end of file diff --git a/docs/models/shared/destinationcumulio.md b/docs/models/shared/destinationcumulio.md index 2a8782a6..2dd1616c 100644 --- a/docs/models/shared/destinationcumulio.md +++ b/docs/models/shared/destinationcumulio.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_host` | *Optional[str]* | :heavy_minus_sign: | URL of the Cumul.io API (e.g. 'https://api.cumul.io', 'https://api.us.cumul.io', or VPC-specific API url). Defaults to 'https://api.cumul.io'. | | `api_key` | *str* | :heavy_check_mark: | An API key generated in Cumul.io's platform (can be generated here: https://app.cumul.io/start/profile/integration). | | `api_token` | *str* | :heavy_check_mark: | The corresponding API token generated in Cumul.io's platform (can be generated here: https://app.cumul.io/start/profile/integration). | +| `api_host` | *Optional[str]* | :heavy_minus_sign: | URL of the Cumul.io API (e.g. 'https://api.cumul.io', 'https://api.us.cumul.io', or VPC-specific API url). Defaults to 'https://api.cumul.io'. | | `destination_type` | [shared.Cumulio](../../models/shared/cumulio.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationdatabend.md b/docs/models/shared/destinationdatabend.md index 4cc8ec7c..dac88f4a 100644 --- a/docs/models/shared/destinationdatabend.md +++ b/docs/models/shared/destinationdatabend.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | | `database` | *str* | :heavy_check_mark: | Name of the database. | | -| `destination_type` | [shared.Databend](../../models/shared/databend.md) | :heavy_check_mark: | N/A | | | `host` | *str* | :heavy_check_mark: | Hostname of the database. | | +| `username` | *str* | :heavy_check_mark: | Username to use to access the database. | | +| `destination_type` | [shared.Databend](../../models/shared/databend.md) | :heavy_check_mark: | N/A | | | `password` | *Optional[str]* | :heavy_minus_sign: | Password associated with the username. | | | `port` | *Optional[int]* | :heavy_minus_sign: | Port of the database. | 443 | -| `table` | *Optional[str]* | :heavy_minus_sign: | The default table was written to. | default | -| `username` | *str* | :heavy_check_mark: | Username to use to access the database. | | \ No newline at end of file +| `table` | *Optional[str]* | :heavy_minus_sign: | The default table was written to. | default | \ No newline at end of file diff --git a/docs/models/shared/destinationdatabricks.md b/docs/models/shared/destinationdatabricks.md index 35fb3ae9..a5d1f773 100644 --- a/docs/models/shared/destinationdatabricks.md +++ b/docs/models/shared/destinationdatabricks.md @@ -5,13 +5,13 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | -| `accept_terms` | *Optional[bool]* | :heavy_minus_sign: | You must agree to the Databricks JDBC Driver Terms & Conditions to use this connector. | | | `data_source` | [Union[shared.RecommendedManagedTables, shared.AmazonS3, shared.DestinationDatabricksAzureBlobStorage]](../../models/shared/datasource.md) | :heavy_check_mark: | Storage on which the delta lake is built. | | -| `database` | *Optional[str]* | :heavy_minus_sign: | The name of the catalog. If not specified otherwise, the "hive_metastore" will be used. | | | `databricks_http_path` | *str* | :heavy_check_mark: | Databricks Cluster HTTP Path. | sql/protocolvx/o/1234567489/0000-1111111-abcd90 | | `databricks_personal_access_token` | *str* | :heavy_check_mark: | Databricks Personal Access Token for making authenticated requests. | dapi0123456789abcdefghij0123456789AB | -| `databricks_port` | *Optional[str]* | :heavy_minus_sign: | Databricks Cluster Port. | 443 | | `databricks_server_hostname` | *str* | :heavy_check_mark: | Databricks Cluster Server Hostname. | abc-12345678-wxyz.cloud.databricks.com | +| `accept_terms` | *Optional[bool]* | :heavy_minus_sign: | You must agree to the Databricks JDBC Driver Terms & Conditions to use this connector. | | +| `database` | *Optional[str]* | :heavy_minus_sign: | The name of the catalog. If not specified otherwise, the "hive_metastore" will be used. | | +| `databricks_port` | *Optional[str]* | :heavy_minus_sign: | Databricks Cluster Port. | 443 | | `destination_type` | [shared.Databricks](../../models/shared/databricks.md) | :heavy_check_mark: | N/A | | | `enable_schema_evolution` | *Optional[bool]* | :heavy_minus_sign: | Support schema evolution for all streams. If "false", the connector might fail when a stream's schema changes. | | | `purge_staging_data` | *Optional[bool]* | :heavy_minus_sign: | Default to 'true'. Switch it to 'false' for debugging purpose. | | diff --git a/docs/models/shared/destinationdatabricksazureblobstorage.md b/docs/models/shared/destinationdatabricksazureblobstorage.md index 0f419bfa..30154c6c 100644 --- a/docs/models/shared/destinationdatabricksazureblobstorage.md +++ b/docs/models/shared/destinationdatabricksazureblobstorage.md @@ -7,6 +7,6 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `azure_blob_storage_account_name` | *str* | :heavy_check_mark: | The account's name of the Azure Blob Storage. | airbyte5storage | | `azure_blob_storage_container_name` | *str* | :heavy_check_mark: | The name of the Azure blob storage container. | airbytetestcontainername | -| `azure_blob_storage_endpoint_domain_name` | *Optional[str]* | :heavy_minus_sign: | This is Azure Blob Storage endpoint domain name. Leave default value (or leave it empty if run container from command line) to use Microsoft native from example. | blob.core.windows.net | | `azure_blob_storage_sas_token` | *str* | :heavy_check_mark: | Shared access signature (SAS) token to grant limited access to objects in your storage account. | ?sv=2016-05-31&ss=b&srt=sco&sp=rwdl&se=2018-06-27T10:05:50Z&st=2017-06-27T02:05:50Z&spr=https,http&sig=bgqQwoXwxzuD2GJfagRg7VOS8hzNr3QLT7rhS8OFRLQ%3D | +| `azure_blob_storage_endpoint_domain_name` | *Optional[str]* | :heavy_minus_sign: | This is Azure Blob Storage endpoint domain name. Leave default value (or leave it empty if run container from command line) to use Microsoft native from example. | blob.core.windows.net | | `data_source_type` | [shared.DestinationDatabricksSchemasDataSourceType](../../models/shared/destinationdatabricksschemasdatasourcetype.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/destinationdevnull.md b/docs/models/shared/destinationdevnull.md index c64a0de7..3f70e443 100644 --- a/docs/models/shared/destinationdevnull.md +++ b/docs/models/shared/destinationdevnull.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `destination_type` | [shared.DevNull](../../models/shared/devnull.md) | :heavy_check_mark: | N/A | -| `test_destination` | [Union[shared.Silent]](../../models/shared/testdestination.md) | :heavy_check_mark: | The type of destination to be used | \ No newline at end of file +| `test_destination` | [Union[shared.Silent]](../../models/shared/testdestination.md) | :heavy_check_mark: | The type of destination to be used | +| `destination_type` | [shared.DevNull](../../models/shared/devnull.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationduckdb.md b/docs/models/shared/destinationduckdb.md index 69689bd6..e3d1eded 100644 --- a/docs/models/shared/destinationduckdb.md +++ b/docs/models/shared/destinationduckdb.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `destination_type` | [shared.Duckdb](../../models/shared/duckdb.md) | :heavy_check_mark: | N/A | | | `destination_path` | *str* | :heavy_check_mark: | Path to the .duckdb file, or the text 'md:' to connect to MotherDuck. The file will be placed inside that local mount. For more information check out our docs | /local/destination.duckdb | +| `destination_type` | [shared.Duckdb](../../models/shared/duckdb.md) | :heavy_check_mark: | N/A | | | `motherduck_api_key` | *Optional[str]* | :heavy_minus_sign: | API key to use for authentication to a MotherDuck database. | | | `schema` | *Optional[str]* | :heavy_minus_sign: | Database schema name, default for duckdb is 'main'. | main | \ No newline at end of file diff --git a/docs/models/shared/destinationdynamodb.md b/docs/models/shared/destinationdynamodb.md index ce47390a..176b7ea9 100644 --- a/docs/models/shared/destinationdynamodb.md +++ b/docs/models/shared/destinationdynamodb.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | | `access_key_id` | *str* | :heavy_check_mark: | The access key id to access the DynamoDB. Airbyte requires Read and Write permissions to the DynamoDB. | A012345678910EXAMPLE | +| `dynamodb_table_name_prefix` | *str* | :heavy_check_mark: | The prefix to use when naming DynamoDB tables. | airbyte_sync | +| `secret_access_key` | *str* | :heavy_check_mark: | The corresponding secret to the access key id. | a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY | | `destination_type` | [shared.Dynamodb](../../models/shared/dynamodb.md) | :heavy_check_mark: | N/A | | | `dynamodb_endpoint` | *Optional[str]* | :heavy_minus_sign: | This is your DynamoDB endpoint url.(if you are working with AWS DynamoDB, just leave empty). | http://localhost:9000 | -| `dynamodb_region` | [Optional[shared.DynamoDBRegion]](../../models/shared/dynamodbregion.md) | :heavy_minus_sign: | The region of the DynamoDB. | | -| `dynamodb_table_name_prefix` | *str* | :heavy_check_mark: | The prefix to use when naming DynamoDB tables. | airbyte_sync | -| `secret_access_key` | *str* | :heavy_check_mark: | The corresponding secret to the access key id. | a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY | \ No newline at end of file +| `dynamodb_region` | [Optional[shared.DynamoDBRegion]](../../models/shared/dynamodbregion.md) | :heavy_minus_sign: | The region of the DynamoDB. | | \ No newline at end of file diff --git a/docs/models/shared/destinationelasticsearch.md b/docs/models/shared/destinationelasticsearch.md index 418445c8..fd07f0e0 100644 --- a/docs/models/shared/destinationelasticsearch.md +++ b/docs/models/shared/destinationelasticsearch.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `endpoint` | *str* | :heavy_check_mark: | The full url of the Elasticsearch server | | `authentication_method` | [Optional[Union[shared.APIKeySecret, shared.UsernamePassword]]](../../models/shared/authenticationmethod.md) | :heavy_minus_sign: | The type of authentication to be used | | `ca_certificate` | *Optional[str]* | :heavy_minus_sign: | CA certificate | | `destination_type` | [shared.Elasticsearch](../../models/shared/elasticsearch.md) | :heavy_check_mark: | N/A | -| `endpoint` | *str* | :heavy_check_mark: | The full url of the Elasticsearch server | | `upsert` | *Optional[bool]* | :heavy_minus_sign: | If a primary key identifier is defined in the source, an upsert will be performed using the primary key value as the elasticsearch doc id. Does not support composite primary keys. | \ No newline at end of file diff --git a/docs/models/shared/destinationfirebolt.md b/docs/models/shared/destinationfirebolt.md index 5ca4cff4..eaf82dde 100644 --- a/docs/models/shared/destinationfirebolt.md +++ b/docs/models/shared/destinationfirebolt.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `account` | *Optional[str]* | :heavy_minus_sign: | Firebolt account to login. | | | `database` | *str* | :heavy_check_mark: | The database to connect to. | | +| `password` | *str* | :heavy_check_mark: | Firebolt password. | | +| `username` | *str* | :heavy_check_mark: | Firebolt email address you use to login. | username@email.com | +| `account` | *Optional[str]* | :heavy_minus_sign: | Firebolt account to login. | | | `destination_type` | [shared.Firebolt](../../models/shared/firebolt.md) | :heavy_check_mark: | N/A | | | `engine` | *Optional[str]* | :heavy_minus_sign: | Engine name or url to connect to. | | | `host` | *Optional[str]* | :heavy_minus_sign: | The host name of your Firebolt database. | api.app.firebolt.io | -| `loading_method` | [Optional[Union[shared.SQLInserts, shared.ExternalTableViaS3]]](../../models/shared/destinationfireboltloadingmethod.md) | :heavy_minus_sign: | Loading method used to select the way data will be uploaded to Firebolt | | -| `password` | *str* | :heavy_check_mark: | Firebolt password. | | -| `username` | *str* | :heavy_check_mark: | Firebolt email address you use to login. | username@email.com | \ No newline at end of file +| `loading_method` | [Optional[Union[shared.SQLInserts, shared.ExternalTableViaS3]]](../../models/shared/destinationfireboltloadingmethod.md) | :heavy_minus_sign: | Loading method used to select the way data will be uploaded to Firebolt | | \ No newline at end of file diff --git a/docs/models/shared/destinationfirestore.md b/docs/models/shared/destinationfirestore.md index 2e1179ef..23c91b0e 100644 --- a/docs/models/shared/destinationfirestore.md +++ b/docs/models/shared/destinationfirestore.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `project_id` | *str* | :heavy_check_mark: | The GCP project ID for the project containing the target BigQuery dataset. | | `credentials_json` | *Optional[str]* | :heavy_minus_sign: | The contents of the JSON service account key. Check out the docs if you need help generating this key. Default credentials will be used if this field is left empty. | -| `destination_type` | [shared.Firestore](../../models/shared/firestore.md) | :heavy_check_mark: | N/A | -| `project_id` | *str* | :heavy_check_mark: | The GCP project ID for the project containing the target BigQuery dataset. | \ No newline at end of file +| `destination_type` | [shared.Firestore](../../models/shared/firestore.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationgcs.md b/docs/models/shared/destinationgcs.md index 06922f58..9a65082f 100644 --- a/docs/models/shared/destinationgcs.md +++ b/docs/models/shared/destinationgcs.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `credential` | [Union[shared.HMACKey]](../../models/shared/authentication.md) | :heavy_check_mark: | An HMAC key is a type of credential and can be associated with a service account or a user account in Cloud Storage. Read more here. | | -| `destination_type` | [shared.Gcs](../../models/shared/gcs.md) | :heavy_check_mark: | N/A | | | `format` | [Union[shared.AvroApacheAvro, shared.DestinationGcsCSVCommaSeparatedValues, shared.DestinationGcsJSONLinesNewlineDelimitedJSON, shared.DestinationGcsParquetColumnarStorage]](../../models/shared/destinationgcsoutputformat.md) | :heavy_check_mark: | Output data format. One of the following formats must be selected - AVRO format, PARQUET format, CSV format, or JSONL format. | | | `gcs_bucket_name` | *str* | :heavy_check_mark: | You can find the bucket name in the App Engine Admin console Application Settings page, under the label Google Cloud Storage Bucket. Read more here. | airbyte_sync | | `gcs_bucket_path` | *str* | :heavy_check_mark: | GCS Bucket Path string Subdirectory under the above bucket to sync the data into. | data_sync/test | +| `destination_type` | [shared.Gcs](../../models/shared/gcs.md) | :heavy_check_mark: | N/A | | | `gcs_bucket_region` | [Optional[shared.GCSBucketRegion]](../../models/shared/gcsbucketregion.md) | :heavy_minus_sign: | Select a Region of the GCS Bucket. Read more here. | | \ No newline at end of file diff --git a/docs/models/shared/destinationgooglesheets.md b/docs/models/shared/destinationgooglesheets.md index 48a7dc9f..dc332e2b 100644 --- a/docs/models/shared/destinationgooglesheets.md +++ b/docs/models/shared/destinationgooglesheets.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `credentials` | [shared.AuthenticationViaGoogleOAuth](../../models/shared/authenticationviagoogleoauth.md) | :heavy_check_mark: | Google API Credentials for connecting to Google Sheets and Google Drive APIs | | -| `destination_type` | [shared.DestinationGoogleSheetsGoogleSheets](../../models/shared/destinationgooglesheetsgooglesheets.md) | :heavy_check_mark: | N/A | | -| `spreadsheet_id` | *str* | :heavy_check_mark: | The link to your spreadsheet. See this guide for more details. | https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG/edit | \ No newline at end of file +| `spreadsheet_id` | *str* | :heavy_check_mark: | The link to your spreadsheet. See this guide for more details. | https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG/edit | +| `destination_type` | [shared.DestinationGoogleSheetsGoogleSheets](../../models/shared/destinationgooglesheetsgooglesheets.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/destinationkeen.md b/docs/models/shared/destinationkeen.md index 73d69385..1573adb2 100644 --- a/docs/models/shared/destinationkeen.md +++ b/docs/models/shared/destinationkeen.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | To get Keen Master API Key, navigate to the Access tab from the left-hand, side panel and check the Project Details section. | ABCDEFGHIJKLMNOPRSTUWXYZ | +| `project_id` | *str* | :heavy_check_mark: | To get Keen Project ID, navigate to the Access tab from the left-hand, side panel and check the Project Details section. | 58b4acc22ba938934e888322e | | `destination_type` | [shared.Keen](../../models/shared/keen.md) | :heavy_check_mark: | N/A | | -| `infer_timestamp` | *Optional[bool]* | :heavy_minus_sign: | Allow connector to guess keen.timestamp value based on the streamed data. | | -| `project_id` | *str* | :heavy_check_mark: | To get Keen Project ID, navigate to the Access tab from the left-hand, side panel and check the Project Details section. | 58b4acc22ba938934e888322e | \ No newline at end of file +| `infer_timestamp` | *Optional[bool]* | :heavy_minus_sign: | Allow connector to guess keen.timestamp value based on the streamed data. | | \ No newline at end of file diff --git a/docs/models/shared/destinationkinesis.md b/docs/models/shared/destinationkinesis.md index 965d2962..5c2127ed 100644 --- a/docs/models/shared/destinationkinesis.md +++ b/docs/models/shared/destinationkinesis.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `access_key` | *str* | :heavy_check_mark: | Generate the AWS Access Key for current user. | | -| `buffer_size` | *Optional[int]* | :heavy_minus_sign: | Buffer size for storing kinesis records before being batch streamed. | | -| `destination_type` | [shared.Kinesis](../../models/shared/kinesis.md) | :heavy_check_mark: | N/A | | | `endpoint` | *str* | :heavy_check_mark: | AWS Kinesis endpoint. | kinesis.us‑west‑1.amazonaws.com | | `private_key` | *str* | :heavy_check_mark: | The AWS Private Key - a string of numbers and letters that are unique for each account, also known as a "recovery phrase". | | | `region` | *str* | :heavy_check_mark: | AWS region. Your account determines the Regions that are available to you. | us‑west‑1 | +| `buffer_size` | *Optional[int]* | :heavy_minus_sign: | Buffer size for storing kinesis records before being batch streamed. | | +| `destination_type` | [shared.Kinesis](../../models/shared/kinesis.md) | :heavy_check_mark: | N/A | | | `shard_count` | *Optional[int]* | :heavy_minus_sign: | Number of shards to which the data should be streamed. | | \ No newline at end of file diff --git a/docs/models/shared/destinationlangchain.md b/docs/models/shared/destinationlangchain.md index 4d5c0e10..59889231 100644 --- a/docs/models/shared/destinationlangchain.md +++ b/docs/models/shared/destinationlangchain.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `destination_type` | [shared.Langchain](../../models/shared/langchain.md) | :heavy_check_mark: | N/A | | `embedding` | [Union[shared.OpenAI, shared.Fake]](../../models/shared/embedding.md) | :heavy_check_mark: | Embedding configuration | | `indexing` | [Union[shared.DestinationLangchainPinecone, shared.DocArrayHnswSearch, shared.ChromaLocalPersistance]](../../models/shared/indexing.md) | :heavy_check_mark: | Indexing configuration | -| `processing` | [shared.ProcessingConfigModel](../../models/shared/processingconfigmodel.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `processing` | [shared.ProcessingConfigModel](../../models/shared/processingconfigmodel.md) | :heavy_check_mark: | N/A | +| `destination_type` | [shared.Langchain](../../models/shared/langchain.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationlangchainpinecone.md b/docs/models/shared/destinationlangchainpinecone.md index b3239af2..bd744c49 100644 --- a/docs/models/shared/destinationlangchainpinecone.md +++ b/docs/models/shared/destinationlangchainpinecone.md @@ -8,6 +8,6 @@ Pinecone is a popular vector store that can be used to store and retrieve embedd | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `index` | *str* | :heavy_check_mark: | Pinecone index to use | -| `mode` | [Optional[shared.DestinationLangchainSchemasMode]](../../models/shared/destinationlangchainschemasmode.md) | :heavy_minus_sign: | N/A | | `pinecone_environment` | *str* | :heavy_check_mark: | Pinecone environment to use | -| `pinecone_key` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `pinecone_key` | *str* | :heavy_check_mark: | N/A | +| `mode` | [Optional[shared.DestinationLangchainSchemasMode]](../../models/shared/destinationlangchainschemasmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationmilvus.md b/docs/models/shared/destinationmilvus.md index a1960517..b323708c 100644 --- a/docs/models/shared/destinationmilvus.md +++ b/docs/models/shared/destinationmilvus.md @@ -16,8 +16,8 @@ Processing, embedding and advanced configuration are provided by this base class | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `destination_type` | [shared.Milvus](../../models/shared/milvus.md) | :heavy_check_mark: | N/A | | `embedding` | [Union[shared.DestinationMilvusOpenAI, shared.Cohere, shared.DestinationMilvusFake, shared.AzureOpenAI, shared.OpenAICompatible]](../../models/shared/destinationmilvusembedding.md) | :heavy_check_mark: | Embedding configuration | | `indexing` | [shared.DestinationMilvusIndexing](../../models/shared/destinationmilvusindexing.md) | :heavy_check_mark: | Indexing configuration | -| `omit_raw_text` | *Optional[bool]* | :heavy_minus_sign: | Do not store the text that gets embedded along with the vector and the metadata in the destination. If set to true, only the vector and the metadata will be stored - in this case raw text for LLM use cases needs to be retrieved from another source. | -| `processing` | [shared.DestinationMilvusProcessingConfigModel](../../models/shared/destinationmilvusprocessingconfigmodel.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `processing` | [shared.DestinationMilvusProcessingConfigModel](../../models/shared/destinationmilvusprocessingconfigmodel.md) | :heavy_check_mark: | N/A | +| `destination_type` | [shared.Milvus](../../models/shared/milvus.md) | :heavy_check_mark: | N/A | +| `omit_raw_text` | *Optional[bool]* | :heavy_minus_sign: | Do not store the text that gets embedded along with the vector and the metadata in the destination. If set to true, only the vector and the metadata will be stored - in this case raw text for LLM use cases needs to be retrieved from another source. | \ No newline at end of file diff --git a/docs/models/shared/destinationmilvusapitoken.md b/docs/models/shared/destinationmilvusapitoken.md index 4e946c7c..8903e150 100644 --- a/docs/models/shared/destinationmilvusapitoken.md +++ b/docs/models/shared/destinationmilvusapitoken.md @@ -7,5 +7,5 @@ Authenticate using an API token (suitable for Zilliz Cloud) | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationMilvusSchemasIndexingMode]](../../models/shared/destinationmilvusschemasindexingmode.md) | :heavy_minus_sign: | N/A | -| `token` | *str* | :heavy_check_mark: | API Token for the Milvus instance | \ No newline at end of file +| `token` | *str* | :heavy_check_mark: | API Token for the Milvus instance | +| `mode` | [Optional[shared.DestinationMilvusSchemasIndexingMode]](../../models/shared/destinationmilvusschemasindexingmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationmilvusindexing.md b/docs/models/shared/destinationmilvusindexing.md index 37efc89c..fe3eaddc 100644 --- a/docs/models/shared/destinationmilvusindexing.md +++ b/docs/models/shared/destinationmilvusindexing.md @@ -9,7 +9,7 @@ Indexing configuration | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | `auth` | [Union[shared.DestinationMilvusAPIToken, shared.DestinationMilvusUsernamePassword, shared.NoAuth]](../../models/shared/destinationmilvusauthentication.md) | :heavy_check_mark: | Authentication method | | | `collection` | *str* | :heavy_check_mark: | The collection to load data into | | -| `db` | *Optional[str]* | :heavy_minus_sign: | The database to connect to | | | `host` | *str* | :heavy_check_mark: | The public endpoint of the Milvus instance. | https://my-instance.zone.zillizcloud.com | +| `db` | *Optional[str]* | :heavy_minus_sign: | The database to connect to | | | `text_field` | *Optional[str]* | :heavy_minus_sign: | The field in the entity that contains the embedded text | | | `vector_field` | *Optional[str]* | :heavy_minus_sign: | The field in the entity that contains the vector | | \ No newline at end of file diff --git a/docs/models/shared/destinationmilvusopenai.md b/docs/models/shared/destinationmilvusopenai.md index a510c74d..b53263c4 100644 --- a/docs/models/shared/destinationmilvusopenai.md +++ b/docs/models/shared/destinationmilvusopenai.md @@ -7,5 +7,5 @@ Use the OpenAI API to embed text. This option is using the text-embedding-ada-00 | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationMilvusMode]](../../models/shared/destinationmilvusmode.md) | :heavy_minus_sign: | N/A | -| `openai_key` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `openai_key` | *str* | :heavy_check_mark: | N/A | +| `mode` | [Optional[shared.DestinationMilvusMode]](../../models/shared/destinationmilvusmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationmilvusprocessingconfigmodel.md b/docs/models/shared/destinationmilvusprocessingconfigmodel.md index 7700f117..a38866fb 100644 --- a/docs/models/shared/destinationmilvusprocessingconfigmodel.md +++ b/docs/models/shared/destinationmilvusprocessingconfigmodel.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chunk_overlap` | *Optional[int]* | :heavy_minus_sign: | Size of overlap between chunks in tokens to store in vector store to better capture relevant context | | | `chunk_size` | *int* | :heavy_check_mark: | Size of chunks in tokens to store in vector store (make sure it is not too big for the context if your LLM) | | +| `chunk_overlap` | *Optional[int]* | :heavy_minus_sign: | Size of overlap between chunks in tokens to store in vector store to better capture relevant context | | | `field_name_mappings` | List[[shared.FieldNameMappingConfigModel](../../models/shared/fieldnamemappingconfigmodel.md)] | :heavy_minus_sign: | List of fields to rename. Not applicable for nested fields, but can be used to rename fields already flattened via dot notation. | | | `metadata_fields` | List[*str*] | :heavy_minus_sign: | List of fields in the record that should be stored as metadata. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered metadata fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. `user.name` will access the `name` field in the `user` object. It's also possible to use wildcards to access all fields in an object, e.g. `users.*.name` will access all `names` fields in all entries of the `users` array. When specifying nested paths, all matching values are flattened into an array set to a field named by the path. | age | | `text_fields` | List[*str*] | :heavy_minus_sign: | List of fields in the record that should be used to calculate the embedding. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered text fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. `user.name` will access the `name` field in the `user` object. It's also possible to use wildcards to access all fields in an object, e.g. `users.*.name` will access all `names` fields in all entries of the `users` array. | text | diff --git a/docs/models/shared/destinationmilvususernamepassword.md b/docs/models/shared/destinationmilvususernamepassword.md index a982d791..6d46607f 100644 --- a/docs/models/shared/destinationmilvususernamepassword.md +++ b/docs/models/shared/destinationmilvususernamepassword.md @@ -7,6 +7,6 @@ Authenticate using username and password (suitable for self-managed Milvus clust | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationMilvusSchemasIndexingAuthMode]](../../models/shared/destinationmilvusschemasindexingauthmode.md) | :heavy_minus_sign: | N/A | | `password` | *str* | :heavy_check_mark: | Password for the Milvus instance | -| `username` | *str* | :heavy_check_mark: | Username for the Milvus instance | \ No newline at end of file +| `username` | *str* | :heavy_check_mark: | Username for the Milvus instance | +| `mode` | [Optional[shared.DestinationMilvusSchemasIndexingAuthMode]](../../models/shared/destinationmilvusschemasindexingauthmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationmongodbpasswordauthentication.md b/docs/models/shared/destinationmongodbpasswordauthentication.md index 532d4229..79d42ff7 100644 --- a/docs/models/shared/destinationmongodbpasswordauthentication.md +++ b/docs/models/shared/destinationmongodbpasswordauthentication.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | -| `tunnel_method` | [shared.DestinationMongodbSchemasTunnelMethodTunnelMethod](../../models/shared/destinationmongodbschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | | `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host | | -| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | \ No newline at end of file +| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [shared.DestinationMongodbSchemasTunnelMethodTunnelMethod](../../models/shared/destinationmongodbschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/destinationmongodbsshkeyauthentication.md b/docs/models/shared/destinationmongodbsshkeyauthentication.md index f07aca0c..08aaed96 100644 --- a/docs/models/shared/destinationmongodbsshkeyauthentication.md +++ b/docs/models/shared/destinationmongodbsshkeyauthentication.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `ssh_key` | *str* | :heavy_check_mark: | OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa ) | | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | +| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | | `tunnel_method` | [shared.DestinationMongodbSchemasTunnelMethod](../../models/shared/destinationmongodbschemastunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and ssh key | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | -| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | \ No newline at end of file +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/destinationmssql.md b/docs/models/shared/destinationmssql.md index f53dab38..9b82506e 100644 --- a/docs/models/shared/destinationmssql.md +++ b/docs/models/shared/destinationmssql.md @@ -6,12 +6,12 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `database` | *str* | :heavy_check_mark: | The name of the MSSQL database. | | -| `destination_type` | [shared.Mssql](../../models/shared/mssql.md) | :heavy_check_mark: | N/A | | | `host` | *str* | :heavy_check_mark: | The host name of the MSSQL database. | | +| `username` | *str* | :heavy_check_mark: | The username which is used to access the database. | | +| `destination_type` | [shared.Mssql](../../models/shared/mssql.md) | :heavy_check_mark: | N/A | | | `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3). | | | `password` | *Optional[str]* | :heavy_minus_sign: | The password associated with this username. | | | `port` | *Optional[int]* | :heavy_minus_sign: | The port of the MSSQL database. | 1433 | | `schema` | *Optional[str]* | :heavy_minus_sign: | The default schema tables are written to if the source does not specify a namespace. The usual value for this field is "public". | public | | `ssl_method` | [Optional[Union[shared.EncryptedTrustServerCertificate, shared.EncryptedVerifyCertificate]]](../../models/shared/sslmethod.md) | :heavy_minus_sign: | The encryption method which is used to communicate with the database. | | -| `tunnel_method` | [Optional[Union[shared.DestinationMssqlNoTunnel, shared.DestinationMssqlSSHKeyAuthentication, shared.DestinationMssqlPasswordAuthentication]]](../../models/shared/destinationmssqlsshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | -| `username` | *str* | :heavy_check_mark: | The username which is used to access the database. | | \ No newline at end of file +| `tunnel_method` | [Optional[Union[shared.DestinationMssqlNoTunnel, shared.DestinationMssqlSSHKeyAuthentication, shared.DestinationMssqlPasswordAuthentication]]](../../models/shared/destinationmssqlsshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | \ No newline at end of file diff --git a/docs/models/shared/destinationmssqlpasswordauthentication.md b/docs/models/shared/destinationmssqlpasswordauthentication.md index 75732e52..83dc78fa 100644 --- a/docs/models/shared/destinationmssqlpasswordauthentication.md +++ b/docs/models/shared/destinationmssqlpasswordauthentication.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | -| `tunnel_method` | [shared.DestinationMssqlSchemasTunnelMethodTunnelMethod](../../models/shared/destinationmssqlschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | | `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host | | -| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | \ No newline at end of file +| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [shared.DestinationMssqlSchemasTunnelMethodTunnelMethod](../../models/shared/destinationmssqlschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/destinationmssqlsshkeyauthentication.md b/docs/models/shared/destinationmssqlsshkeyauthentication.md index 3fdac59d..09c36aa0 100644 --- a/docs/models/shared/destinationmssqlsshkeyauthentication.md +++ b/docs/models/shared/destinationmssqlsshkeyauthentication.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `ssh_key` | *str* | :heavy_check_mark: | OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa ) | | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | +| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | | `tunnel_method` | [shared.DestinationMssqlSchemasTunnelMethod](../../models/shared/destinationmssqlschemastunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and ssh key | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | -| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | \ No newline at end of file +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/destinationmysql.md b/docs/models/shared/destinationmysql.md index 26b52d25..e95bb482 100644 --- a/docs/models/shared/destinationmysql.md +++ b/docs/models/shared/destinationmysql.md @@ -6,10 +6,10 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `database` | *str* | :heavy_check_mark: | Name of the database. | | -| `destination_type` | [shared.Mysql](../../models/shared/mysql.md) | :heavy_check_mark: | N/A | | | `host` | *str* | :heavy_check_mark: | Hostname of the database. | | +| `username` | *str* | :heavy_check_mark: | Username to use to access the database. | | +| `destination_type` | [shared.Mysql](../../models/shared/mysql.md) | :heavy_check_mark: | N/A | | | `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3). | | | `password` | *Optional[str]* | :heavy_minus_sign: | Password associated with the username. | | | `port` | *Optional[int]* | :heavy_minus_sign: | Port of the database. | 3306 | -| `tunnel_method` | [Optional[Union[shared.DestinationMysqlNoTunnel, shared.DestinationMysqlSSHKeyAuthentication, shared.DestinationMysqlPasswordAuthentication]]](../../models/shared/destinationmysqlsshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | -| `username` | *str* | :heavy_check_mark: | Username to use to access the database. | | \ No newline at end of file +| `tunnel_method` | [Optional[Union[shared.DestinationMysqlNoTunnel, shared.DestinationMysqlSSHKeyAuthentication, shared.DestinationMysqlPasswordAuthentication]]](../../models/shared/destinationmysqlsshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | \ No newline at end of file diff --git a/docs/models/shared/destinationmysqlpasswordauthentication.md b/docs/models/shared/destinationmysqlpasswordauthentication.md index 3e85d55b..71c5929f 100644 --- a/docs/models/shared/destinationmysqlpasswordauthentication.md +++ b/docs/models/shared/destinationmysqlpasswordauthentication.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | -| `tunnel_method` | [shared.DestinationMysqlSchemasTunnelMethodTunnelMethod](../../models/shared/destinationmysqlschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | | `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host | | -| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | \ No newline at end of file +| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [shared.DestinationMysqlSchemasTunnelMethodTunnelMethod](../../models/shared/destinationmysqlschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/destinationmysqlsshkeyauthentication.md b/docs/models/shared/destinationmysqlsshkeyauthentication.md index 04becfcc..551e2821 100644 --- a/docs/models/shared/destinationmysqlsshkeyauthentication.md +++ b/docs/models/shared/destinationmysqlsshkeyauthentication.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `ssh_key` | *str* | :heavy_check_mark: | OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa ) | | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | +| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | | `tunnel_method` | [shared.DestinationMysqlSchemasTunnelMethod](../../models/shared/destinationmysqlschemastunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and ssh key | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | -| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | \ No newline at end of file +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/destinationoracle.md b/docs/models/shared/destinationoracle.md index 3238bfae..290beaad 100644 --- a/docs/models/shared/destinationoracle.md +++ b/docs/models/shared/destinationoracle.md @@ -5,12 +5,12 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `destination_type` | [shared.Oracle](../../models/shared/oracle.md) | :heavy_check_mark: | N/A | | | `host` | *str* | :heavy_check_mark: | The hostname of the database. | | +| `sid` | *str* | :heavy_check_mark: | The System Identifier uniquely distinguishes the instance from any other instance on the same computer. | | +| `username` | *str* | :heavy_check_mark: | The username to access the database. This user must have CREATE USER privileges in the database. | | +| `destination_type` | [shared.Oracle](../../models/shared/oracle.md) | :heavy_check_mark: | N/A | | | `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3). | | | `password` | *Optional[str]* | :heavy_minus_sign: | The password associated with the username. | | | `port` | *Optional[int]* | :heavy_minus_sign: | The port of the database. | 1521 | | `schema` | *Optional[str]* | :heavy_minus_sign: | The default schema is used as the target schema for all statements issued from the connection that do not explicitly specify a schema name. The usual value for this field is "airbyte". In Oracle, schemas and users are the same thing, so the "user" parameter is used as the login credentials and this is used for the default Airbyte message schema. | airbyte | -| `sid` | *str* | :heavy_check_mark: | The System Identifier uniquely distinguishes the instance from any other instance on the same computer. | | -| `tunnel_method` | [Optional[Union[shared.DestinationOracleNoTunnel, shared.DestinationOracleSSHKeyAuthentication, shared.DestinationOraclePasswordAuthentication]]](../../models/shared/destinationoraclesshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | -| `username` | *str* | :heavy_check_mark: | The username to access the database. This user must have CREATE USER privileges in the database. | | \ No newline at end of file +| `tunnel_method` | [Optional[Union[shared.DestinationOracleNoTunnel, shared.DestinationOracleSSHKeyAuthentication, shared.DestinationOraclePasswordAuthentication]]](../../models/shared/destinationoraclesshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | \ No newline at end of file diff --git a/docs/models/shared/destinationoraclepasswordauthentication.md b/docs/models/shared/destinationoraclepasswordauthentication.md index 72adc899..0b571546 100644 --- a/docs/models/shared/destinationoraclepasswordauthentication.md +++ b/docs/models/shared/destinationoraclepasswordauthentication.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | -| `tunnel_method` | [shared.DestinationOracleSchemasTunnelMethodTunnelMethod](../../models/shared/destinationoracleschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | | `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host | | -| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | \ No newline at end of file +| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [shared.DestinationOracleSchemasTunnelMethodTunnelMethod](../../models/shared/destinationoracleschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/destinationoraclesshkeyauthentication.md b/docs/models/shared/destinationoraclesshkeyauthentication.md index d262446e..44a5861e 100644 --- a/docs/models/shared/destinationoraclesshkeyauthentication.md +++ b/docs/models/shared/destinationoraclesshkeyauthentication.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `ssh_key` | *str* | :heavy_check_mark: | OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa ) | | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | +| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | | `tunnel_method` | [shared.DestinationOracleSchemasTunnelMethod](../../models/shared/destinationoracleschemastunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and ssh key | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | -| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | \ No newline at end of file +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/destinationpinecone.md b/docs/models/shared/destinationpinecone.md index 544f09e2..04739cef 100644 --- a/docs/models/shared/destinationpinecone.md +++ b/docs/models/shared/destinationpinecone.md @@ -16,8 +16,8 @@ Processing, embedding and advanced configuration are provided by this base class | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `destination_type` | [shared.Pinecone](../../models/shared/pinecone.md) | :heavy_check_mark: | N/A | | `embedding` | [Union[shared.DestinationPineconeOpenAI, shared.DestinationPineconeCohere, shared.DestinationPineconeFake, shared.DestinationPineconeAzureOpenAI, shared.DestinationPineconeOpenAICompatible]](../../models/shared/destinationpineconeembedding.md) | :heavy_check_mark: | Embedding configuration | | `indexing` | [shared.DestinationPineconeIndexing](../../models/shared/destinationpineconeindexing.md) | :heavy_check_mark: | Pinecone is a popular vector store that can be used to store and retrieve embeddings. | -| `omit_raw_text` | *Optional[bool]* | :heavy_minus_sign: | Do not store the text that gets embedded along with the vector and the metadata in the destination. If set to true, only the vector and the metadata will be stored - in this case raw text for LLM use cases needs to be retrieved from another source. | -| `processing` | [shared.DestinationPineconeProcessingConfigModel](../../models/shared/destinationpineconeprocessingconfigmodel.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `processing` | [shared.DestinationPineconeProcessingConfigModel](../../models/shared/destinationpineconeprocessingconfigmodel.md) | :heavy_check_mark: | N/A | +| `destination_type` | [shared.Pinecone](../../models/shared/pinecone.md) | :heavy_check_mark: | N/A | +| `omit_raw_text` | *Optional[bool]* | :heavy_minus_sign: | Do not store the text that gets embedded along with the vector and the metadata in the destination. If set to true, only the vector and the metadata will be stored - in this case raw text for LLM use cases needs to be retrieved from another source. | \ No newline at end of file diff --git a/docs/models/shared/destinationpineconeazureopenai.md b/docs/models/shared/destinationpineconeazureopenai.md index b67b576f..1b6967da 100644 --- a/docs/models/shared/destinationpineconeazureopenai.md +++ b/docs/models/shared/destinationpineconeazureopenai.md @@ -9,5 +9,5 @@ Use the Azure-hosted OpenAI API to embed text. This option is using the text-emb | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | `api_base` | *str* | :heavy_check_mark: | The base URL for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource | https://your-resource-name.openai.azure.com | | `deployment` | *str* | :heavy_check_mark: | The deployment for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource | your-resource-name | -| `mode` | [Optional[shared.DestinationPineconeSchemasEmbeddingEmbeddingMode]](../../models/shared/destinationpineconeschemasembeddingembeddingmode.md) | :heavy_minus_sign: | N/A | | -| `openai_key` | *str* | :heavy_check_mark: | The API key for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource | | \ No newline at end of file +| `openai_key` | *str* | :heavy_check_mark: | The API key for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource | | +| `mode` | [Optional[shared.DestinationPineconeSchemasEmbeddingEmbeddingMode]](../../models/shared/destinationpineconeschemasembeddingembeddingmode.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/destinationpineconeopenai.md b/docs/models/shared/destinationpineconeopenai.md index 182ef35a..b07376a6 100644 --- a/docs/models/shared/destinationpineconeopenai.md +++ b/docs/models/shared/destinationpineconeopenai.md @@ -7,5 +7,5 @@ Use the OpenAI API to embed text. This option is using the text-embedding-ada-00 | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| `mode` | [Optional[shared.DestinationPineconeMode]](../../models/shared/destinationpineconemode.md) | :heavy_minus_sign: | N/A | -| `openai_key` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `openai_key` | *str* | :heavy_check_mark: | N/A | +| `mode` | [Optional[shared.DestinationPineconeMode]](../../models/shared/destinationpineconemode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationpineconeopenaicompatible.md b/docs/models/shared/destinationpineconeopenaicompatible.md index 654008b6..5d31bbff 100644 --- a/docs/models/shared/destinationpineconeopenaicompatible.md +++ b/docs/models/shared/destinationpineconeopenaicompatible.md @@ -7,8 +7,8 @@ Use a service that's compatible with the OpenAI API to embed text. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `base_url` | *str* | :heavy_check_mark: | The base URL for your OpenAI-compatible service | https://your-service-name.com | | `dimensions` | *int* | :heavy_check_mark: | The number of dimensions the embedding model is generating | 1536 | +| `api_key` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `mode` | [Optional[shared.DestinationPineconeSchemasEmbeddingEmbedding5Mode]](../../models/shared/destinationpineconeschemasembeddingembedding5mode.md) | :heavy_minus_sign: | N/A | | | `model_name` | *Optional[str]* | :heavy_minus_sign: | The name of the model to use for embedding | text-embedding-ada-002 | \ No newline at end of file diff --git a/docs/models/shared/destinationpineconeprocessingconfigmodel.md b/docs/models/shared/destinationpineconeprocessingconfigmodel.md index 49ae8a3c..6467c0fe 100644 --- a/docs/models/shared/destinationpineconeprocessingconfigmodel.md +++ b/docs/models/shared/destinationpineconeprocessingconfigmodel.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chunk_overlap` | *Optional[int]* | :heavy_minus_sign: | Size of overlap between chunks in tokens to store in vector store to better capture relevant context | | | `chunk_size` | *int* | :heavy_check_mark: | Size of chunks in tokens to store in vector store (make sure it is not too big for the context if your LLM) | | +| `chunk_overlap` | *Optional[int]* | :heavy_minus_sign: | Size of overlap between chunks in tokens to store in vector store to better capture relevant context | | | `field_name_mappings` | List[[shared.DestinationPineconeFieldNameMappingConfigModel](../../models/shared/destinationpineconefieldnamemappingconfigmodel.md)] | :heavy_minus_sign: | List of fields to rename. Not applicable for nested fields, but can be used to rename fields already flattened via dot notation. | | | `metadata_fields` | List[*str*] | :heavy_minus_sign: | List of fields in the record that should be stored as metadata. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered metadata fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. `user.name` will access the `name` field in the `user` object. It's also possible to use wildcards to access all fields in an object, e.g. `users.*.name` will access all `names` fields in all entries of the `users` array. When specifying nested paths, all matching values are flattened into an array set to a field named by the path. | age | | `text_fields` | List[*str*] | :heavy_minus_sign: | List of fields in the record that should be used to calculate the embedding. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered text fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. `user.name` will access the `name` field in the `user` object. It's also possible to use wildcards to access all fields in an object, e.g. `users.*.name` will access all `names` fields in all entries of the `users` array. | text | diff --git a/docs/models/shared/destinationpostgres.md b/docs/models/shared/destinationpostgres.md index bfcf505e..ab8fa136 100644 --- a/docs/models/shared/destinationpostgres.md +++ b/docs/models/shared/destinationpostgres.md @@ -6,12 +6,12 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `database` | *str* | :heavy_check_mark: | Name of the database. | | -| `destination_type` | [shared.Postgres](../../models/shared/postgres.md) | :heavy_check_mark: | N/A | | | `host` | *str* | :heavy_check_mark: | Hostname of the database. | | +| `username` | *str* | :heavy_check_mark: | Username to use to access the database. | | +| `destination_type` | [shared.Postgres](../../models/shared/postgres.md) | :heavy_check_mark: | N/A | | | `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3). | | | `password` | *Optional[str]* | :heavy_minus_sign: | Password associated with the username. | | | `port` | *Optional[int]* | :heavy_minus_sign: | Port of the database. | 5432 | | `schema` | *Optional[str]* | :heavy_minus_sign: | The default schema tables are written to if the source does not specify a namespace. The usual value for this field is "public". | public | | `ssl_mode` | [Optional[Union[shared.Disable, shared.Allow, shared.Prefer, shared.Require, shared.VerifyCa, shared.VerifyFull]]](../../models/shared/sslmodes.md) | :heavy_minus_sign: | SSL connection modes.
disable - Chose this mode to disable encryption of communication between Airbyte and destination database
allow - Chose this mode to enable encryption only when required by the source database
prefer - Chose this mode to allow unencrypted connection only if the source database does not support encryption
require - Chose this mode to always require encryption. If the source database server does not support encryption, connection will fail
verify-ca - Chose this mode to always require encryption and to verify that the source database server has a valid SSL certificate
verify-full - This is the most secure mode. Chose this mode to always require encryption and to verify the identity of the source database server
See more information - in the docs. | | -| `tunnel_method` | [Optional[Union[shared.DestinationPostgresNoTunnel, shared.DestinationPostgresSSHKeyAuthentication, shared.DestinationPostgresPasswordAuthentication]]](../../models/shared/destinationpostgressshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | -| `username` | *str* | :heavy_check_mark: | Username to use to access the database. | | \ No newline at end of file +| `tunnel_method` | [Optional[Union[shared.DestinationPostgresNoTunnel, shared.DestinationPostgresSSHKeyAuthentication, shared.DestinationPostgresPasswordAuthentication]]](../../models/shared/destinationpostgressshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | \ No newline at end of file diff --git a/docs/models/shared/destinationpostgrespasswordauthentication.md b/docs/models/shared/destinationpostgrespasswordauthentication.md index 7bcf82b7..0846d1fd 100644 --- a/docs/models/shared/destinationpostgrespasswordauthentication.md +++ b/docs/models/shared/destinationpostgrespasswordauthentication.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | -| `tunnel_method` | [shared.DestinationPostgresSchemasTunnelMethodTunnelMethod](../../models/shared/destinationpostgresschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | | `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host | | -| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | \ No newline at end of file +| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [shared.DestinationPostgresSchemasTunnelMethodTunnelMethod](../../models/shared/destinationpostgresschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/destinationpostgressshkeyauthentication.md b/docs/models/shared/destinationpostgressshkeyauthentication.md index 4d6b2324..11cb2422 100644 --- a/docs/models/shared/destinationpostgressshkeyauthentication.md +++ b/docs/models/shared/destinationpostgressshkeyauthentication.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `ssh_key` | *str* | :heavy_check_mark: | OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa ) | | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | +| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | | `tunnel_method` | [shared.DestinationPostgresSchemasTunnelMethod](../../models/shared/destinationpostgresschemastunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and ssh key | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | -| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | \ No newline at end of file +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/destinationpubsub.md b/docs/models/shared/destinationpubsub.md index cf1df16a..8dfff8b2 100644 --- a/docs/models/shared/destinationpubsub.md +++ b/docs/models/shared/destinationpubsub.md @@ -5,12 +5,12 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `credentials_json` | *str* | :heavy_check_mark: | The contents of the JSON service account key. Check out the docs if you need help generating this key. | +| `project_id` | *str* | :heavy_check_mark: | The GCP project ID for the project containing the target PubSub. | +| `topic_id` | *str* | :heavy_check_mark: | The PubSub topic ID in the given GCP project ID. | | `batching_delay_threshold` | *Optional[int]* | :heavy_minus_sign: | Number of ms before the buffer is flushed | | `batching_element_count_threshold` | *Optional[int]* | :heavy_minus_sign: | Number of messages before the buffer is flushed | | `batching_enabled` | *Optional[bool]* | :heavy_minus_sign: | If TRUE messages will be buffered instead of sending them one by one | | `batching_request_bytes_threshold` | *Optional[int]* | :heavy_minus_sign: | Number of bytes before the buffer is flushed | -| `credentials_json` | *str* | :heavy_check_mark: | The contents of the JSON service account key. Check out the docs if you need help generating this key. | | `destination_type` | [shared.Pubsub](../../models/shared/pubsub.md) | :heavy_check_mark: | N/A | -| `ordering_enabled` | *Optional[bool]* | :heavy_minus_sign: | If TRUE PubSub publisher will have message ordering enabled. Every message will have an ordering key of stream | -| `project_id` | *str* | :heavy_check_mark: | The GCP project ID for the project containing the target PubSub. | -| `topic_id` | *str* | :heavy_check_mark: | The PubSub topic ID in the given GCP project ID. | \ No newline at end of file +| `ordering_enabled` | *Optional[bool]* | :heavy_minus_sign: | If TRUE PubSub publisher will have message ordering enabled. Every message will have an ordering key of stream | \ No newline at end of file diff --git a/docs/models/shared/destinationqdrant.md b/docs/models/shared/destinationqdrant.md index 2312f6bd..cd26e528 100644 --- a/docs/models/shared/destinationqdrant.md +++ b/docs/models/shared/destinationqdrant.md @@ -16,8 +16,8 @@ Processing, embedding and advanced configuration are provided by this base class | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `destination_type` | [shared.Qdrant](../../models/shared/qdrant.md) | :heavy_check_mark: | N/A | | `embedding` | [Union[shared.DestinationQdrantOpenAI, shared.DestinationQdrantCohere, shared.DestinationQdrantFake, shared.DestinationQdrantAzureOpenAI, shared.DestinationQdrantOpenAICompatible]](../../models/shared/destinationqdrantembedding.md) | :heavy_check_mark: | Embedding configuration | | `indexing` | [shared.DestinationQdrantIndexing](../../models/shared/destinationqdrantindexing.md) | :heavy_check_mark: | Indexing configuration | -| `omit_raw_text` | *Optional[bool]* | :heavy_minus_sign: | Do not store the text that gets embedded along with the vector and the metadata in the destination. If set to true, only the vector and the metadata will be stored - in this case raw text for LLM use cases needs to be retrieved from another source. | -| `processing` | [shared.DestinationQdrantProcessingConfigModel](../../models/shared/destinationqdrantprocessingconfigmodel.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `processing` | [shared.DestinationQdrantProcessingConfigModel](../../models/shared/destinationqdrantprocessingconfigmodel.md) | :heavy_check_mark: | N/A | +| `destination_type` | [shared.Qdrant](../../models/shared/qdrant.md) | :heavy_check_mark: | N/A | +| `omit_raw_text` | *Optional[bool]* | :heavy_minus_sign: | Do not store the text that gets embedded along with the vector and the metadata in the destination. If set to true, only the vector and the metadata will be stored - in this case raw text for LLM use cases needs to be retrieved from another source. | \ No newline at end of file diff --git a/docs/models/shared/destinationqdrantazureopenai.md b/docs/models/shared/destinationqdrantazureopenai.md index c1fe4416..f79fec13 100644 --- a/docs/models/shared/destinationqdrantazureopenai.md +++ b/docs/models/shared/destinationqdrantazureopenai.md @@ -9,5 +9,5 @@ Use the Azure-hosted OpenAI API to embed text. This option is using the text-emb | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `api_base` | *str* | :heavy_check_mark: | The base URL for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource | https://your-resource-name.openai.azure.com | | `deployment` | *str* | :heavy_check_mark: | The deployment for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource | your-resource-name | -| `mode` | [Optional[shared.DestinationQdrantSchemasEmbeddingEmbeddingMode]](../../models/shared/destinationqdrantschemasembeddingembeddingmode.md) | :heavy_minus_sign: | N/A | | -| `openai_key` | *str* | :heavy_check_mark: | The API key for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource | | \ No newline at end of file +| `openai_key` | *str* | :heavy_check_mark: | The API key for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource | | +| `mode` | [Optional[shared.DestinationQdrantSchemasEmbeddingEmbeddingMode]](../../models/shared/destinationqdrantschemasembeddingembeddingmode.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/destinationqdrantindexing.md b/docs/models/shared/destinationqdrantindexing.md index e6b68222..63c36443 100644 --- a/docs/models/shared/destinationqdrantindexing.md +++ b/docs/models/shared/destinationqdrantindexing.md @@ -7,9 +7,9 @@ Indexing configuration | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `auth_method` | [Optional[Union[shared.APIKeyAuth, shared.DestinationQdrantNoAuth]]](../../models/shared/destinationqdrantauthenticationmethod.md) | :heavy_minus_sign: | Method to authenticate with the Qdrant Instance | | `collection` | *str* | :heavy_check_mark: | The collection to load data into | +| `url` | *str* | :heavy_check_mark: | Public Endpoint of the Qdrant cluser | +| `auth_method` | [Optional[Union[shared.APIKeyAuth, shared.DestinationQdrantNoAuth]]](../../models/shared/destinationqdrantauthenticationmethod.md) | :heavy_minus_sign: | Method to authenticate with the Qdrant Instance | | `distance_metric` | [Optional[shared.DistanceMetric]](../../models/shared/distancemetric.md) | :heavy_minus_sign: | The Distance metric used to measure similarities among vectors. This field is only used if the collection defined in the does not exist yet and is created automatically by the connector. | | `prefer_grpc` | *Optional[bool]* | :heavy_minus_sign: | Whether to prefer gRPC over HTTP. Set to true for Qdrant cloud clusters | -| `text_field` | *Optional[str]* | :heavy_minus_sign: | The field in the payload that contains the embedded text | -| `url` | *str* | :heavy_check_mark: | Public Endpoint of the Qdrant cluser | \ No newline at end of file +| `text_field` | *Optional[str]* | :heavy_minus_sign: | The field in the payload that contains the embedded text | \ No newline at end of file diff --git a/docs/models/shared/destinationqdrantopenai.md b/docs/models/shared/destinationqdrantopenai.md index 0fc591f0..3bf95d5b 100644 --- a/docs/models/shared/destinationqdrantopenai.md +++ b/docs/models/shared/destinationqdrantopenai.md @@ -7,5 +7,5 @@ Use the OpenAI API to embed text. This option is using the text-embedding-ada-00 | Field | Type | Required | Description | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationQdrantMode]](../../models/shared/destinationqdrantmode.md) | :heavy_minus_sign: | N/A | -| `openai_key` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `openai_key` | *str* | :heavy_check_mark: | N/A | +| `mode` | [Optional[shared.DestinationQdrantMode]](../../models/shared/destinationqdrantmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationqdrantopenaicompatible.md b/docs/models/shared/destinationqdrantopenaicompatible.md index 929e5bce..93e0b821 100644 --- a/docs/models/shared/destinationqdrantopenaicompatible.md +++ b/docs/models/shared/destinationqdrantopenaicompatible.md @@ -7,8 +7,8 @@ Use a service that's compatible with the OpenAI API to embed text. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `api_key` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `base_url` | *str* | :heavy_check_mark: | The base URL for your OpenAI-compatible service | https://your-service-name.com | | `dimensions` | *int* | :heavy_check_mark: | The number of dimensions the embedding model is generating | 1536 | +| `api_key` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `mode` | [Optional[shared.DestinationQdrantSchemasEmbeddingEmbedding5Mode]](../../models/shared/destinationqdrantschemasembeddingembedding5mode.md) | :heavy_minus_sign: | N/A | | | `model_name` | *Optional[str]* | :heavy_minus_sign: | The name of the model to use for embedding | text-embedding-ada-002 | \ No newline at end of file diff --git a/docs/models/shared/destinationqdrantprocessingconfigmodel.md b/docs/models/shared/destinationqdrantprocessingconfigmodel.md index ee8aa0eb..051196ed 100644 --- a/docs/models/shared/destinationqdrantprocessingconfigmodel.md +++ b/docs/models/shared/destinationqdrantprocessingconfigmodel.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chunk_overlap` | *Optional[int]* | :heavy_minus_sign: | Size of overlap between chunks in tokens to store in vector store to better capture relevant context | | | `chunk_size` | *int* | :heavy_check_mark: | Size of chunks in tokens to store in vector store (make sure it is not too big for the context if your LLM) | | +| `chunk_overlap` | *Optional[int]* | :heavy_minus_sign: | Size of overlap between chunks in tokens to store in vector store to better capture relevant context | | | `field_name_mappings` | List[[shared.DestinationQdrantFieldNameMappingConfigModel](../../models/shared/destinationqdrantfieldnamemappingconfigmodel.md)] | :heavy_minus_sign: | List of fields to rename. Not applicable for nested fields, but can be used to rename fields already flattened via dot notation. | | | `metadata_fields` | List[*str*] | :heavy_minus_sign: | List of fields in the record that should be stored as metadata. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered metadata fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. `user.name` will access the `name` field in the `user` object. It's also possible to use wildcards to access all fields in an object, e.g. `users.*.name` will access all `names` fields in all entries of the `users` array. When specifying nested paths, all matching values are flattened into an array set to a field named by the path. | age | | `text_fields` | List[*str*] | :heavy_minus_sign: | List of fields in the record that should be used to calculate the embedding. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered text fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. `user.name` will access the `name` field in the `user` object. It's also possible to use wildcards to access all fields in an object, e.g. `users.*.name` will access all `names` fields in all entries of the `users` array. | text | diff --git a/docs/models/shared/destinationredis.md b/docs/models/shared/destinationredis.md index f56b88c0..bf53f0f0 100644 --- a/docs/models/shared/destinationredis.md +++ b/docs/models/shared/destinationredis.md @@ -5,12 +5,12 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `host` | *str* | :heavy_check_mark: | Redis host to connect to. | localhost,127.0.0.1 | +| `username` | *str* | :heavy_check_mark: | Username associated with Redis. | | | `cache_type` | [Optional[shared.CacheType]](../../models/shared/cachetype.md) | :heavy_minus_sign: | Redis cache type to store data in. | | | `destination_type` | [shared.Redis](../../models/shared/redis.md) | :heavy_check_mark: | N/A | | -| `host` | *str* | :heavy_check_mark: | Redis host to connect to. | localhost,127.0.0.1 | | `password` | *Optional[str]* | :heavy_minus_sign: | Password associated with Redis. | | | `port` | *Optional[int]* | :heavy_minus_sign: | Port of Redis. | | | `ssl` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether SSL encryption protocol will be used to connect to Redis. It is recommended to use SSL connection if possible. | | | `ssl_mode` | [Optional[Union[shared.DestinationRedisDisable, shared.DestinationRedisVerifyFull]]](../../models/shared/destinationredissslmodes.md) | :heavy_minus_sign: | SSL connection modes.
  • verify-full - This is the most secure mode. Always require encryption and verifies the identity of the source database server | | -| `tunnel_method` | [Optional[Union[shared.DestinationRedisNoTunnel, shared.DestinationRedisSSHKeyAuthentication, shared.DestinationRedisPasswordAuthentication]]](../../models/shared/destinationredissshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | -| `username` | *str* | :heavy_check_mark: | Username associated with Redis. | | \ No newline at end of file +| `tunnel_method` | [Optional[Union[shared.DestinationRedisNoTunnel, shared.DestinationRedisSSHKeyAuthentication, shared.DestinationRedisPasswordAuthentication]]](../../models/shared/destinationredissshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | \ No newline at end of file diff --git a/docs/models/shared/destinationredispasswordauthentication.md b/docs/models/shared/destinationredispasswordauthentication.md index e754cec2..9db91c41 100644 --- a/docs/models/shared/destinationredispasswordauthentication.md +++ b/docs/models/shared/destinationredispasswordauthentication.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | -| `tunnel_method` | [shared.DestinationRedisSchemasTunnelMethodTunnelMethod](../../models/shared/destinationredisschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | | `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host | | -| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | \ No newline at end of file +| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [shared.DestinationRedisSchemasTunnelMethodTunnelMethod](../../models/shared/destinationredisschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/destinationredissshkeyauthentication.md b/docs/models/shared/destinationredissshkeyauthentication.md index cc6f05c4..7757aac3 100644 --- a/docs/models/shared/destinationredissshkeyauthentication.md +++ b/docs/models/shared/destinationredissshkeyauthentication.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `ssh_key` | *str* | :heavy_check_mark: | OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa ) | | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | +| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | | `tunnel_method` | [shared.DestinationRedisSchemasTunnelMethod](../../models/shared/destinationredisschemastunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and ssh key | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | -| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | \ No newline at end of file +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/destinationredshift.md b/docs/models/shared/destinationredshift.md index 995b11f4..d404cbaf 100644 --- a/docs/models/shared/destinationredshift.md +++ b/docs/models/shared/destinationredshift.md @@ -6,16 +6,16 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `database` | *str* | :heavy_check_mark: | Name of the database. | | +| `host` | *str* | :heavy_check_mark: | Host Endpoint of the Redshift Cluster (must include the cluster-id, region and end with .redshift.amazonaws.com) | | +| `password` | *str* | :heavy_check_mark: | Password associated with the username. | | +| `username` | *str* | :heavy_check_mark: | Username to use to access the database. | | | `destination_type` | [shared.Redshift](../../models/shared/redshift.md) | :heavy_check_mark: | N/A | | | `disable_type_dedupe` | *Optional[bool]* | :heavy_minus_sign: | Disable Writing Final Tables. WARNING! The data format in _airbyte_data is likely stable but there are no guarantees that other metadata columns will remain the same in future versions | | | `enable_incremental_final_table_updates` | *Optional[bool]* | :heavy_minus_sign: | When enabled your data will load into your final tables incrementally while your data is still being synced. When Disabled (the default), your data loads into your final tables once at the end of a sync. Note that this option only applies if you elect to create Final tables | | -| `host` | *str* | :heavy_check_mark: | Host Endpoint of the Redshift Cluster (must include the cluster-id, region and end with .redshift.amazonaws.com) | | | `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3). | | -| `password` | *str* | :heavy_check_mark: | Password associated with the username. | | | `port` | *Optional[int]* | :heavy_minus_sign: | Port of the database. | 5439 | | `raw_data_schema` | *Optional[str]* | :heavy_minus_sign: | (Early Access) The schema to write raw tables into | | | `schema` | *Optional[str]* | :heavy_minus_sign: | The default schema tables are written to if the source does not specify a namespace. Unless specifically configured, the usual value for this field is "public". | public | | `tunnel_method` | [Optional[Union[shared.DestinationRedshiftNoTunnel, shared.DestinationRedshiftSSHKeyAuthentication, shared.DestinationRedshiftPasswordAuthentication]]](../../models/shared/destinationredshiftsshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | | `uploading_method` | [Optional[Union[shared.AWSS3Staging, shared.Standard]]](../../models/shared/uploadingmethod.md) | :heavy_minus_sign: | The way data will be uploaded to Redshift. | | -| `use_1s1t_format` | *Optional[bool]* | :heavy_minus_sign: | (Early Access) Use Destinations V2. | | -| `username` | *str* | :heavy_check_mark: | Username to use to access the database. | | \ No newline at end of file +| `use_1s1t_format` | *Optional[bool]* | :heavy_minus_sign: | (Early Access) Use Destinations V2. | | \ No newline at end of file diff --git a/docs/models/shared/destinationredshiftpasswordauthentication.md b/docs/models/shared/destinationredshiftpasswordauthentication.md index 7553aecd..c7735332 100644 --- a/docs/models/shared/destinationredshiftpasswordauthentication.md +++ b/docs/models/shared/destinationredshiftpasswordauthentication.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | -| `tunnel_method` | [shared.DestinationRedshiftSchemasTunnelMethodTunnelMethod](../../models/shared/destinationredshiftschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | | `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host | | -| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | \ No newline at end of file +| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [shared.DestinationRedshiftSchemasTunnelMethodTunnelMethod](../../models/shared/destinationredshiftschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/destinationredshiftsshkeyauthentication.md b/docs/models/shared/destinationredshiftsshkeyauthentication.md index c73f2527..831ef1f7 100644 --- a/docs/models/shared/destinationredshiftsshkeyauthentication.md +++ b/docs/models/shared/destinationredshiftsshkeyauthentication.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `ssh_key` | *str* | :heavy_check_mark: | OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa ) | | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | +| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | | `tunnel_method` | [shared.DestinationRedshiftSchemasTunnelMethod](../../models/shared/destinationredshiftschemastunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and ssh key | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | -| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | \ No newline at end of file +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/destinations3.md b/docs/models/shared/destinations3.md index 70215101..fb6bb074 100644 --- a/docs/models/shared/destinations3.md +++ b/docs/models/shared/destinations3.md @@ -5,12 +5,12 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `access_key_id` | *Optional[str]* | :heavy_minus_sign: | The access key ID to access the S3 bucket. Airbyte requires Read and Write permissions to the given bucket. Read more here. | A012345678910EXAMPLE | -| `destination_type` | [shared.S3](../../models/shared/s3.md) | :heavy_check_mark: | N/A | | -| `file_name_pattern` | *Optional[str]* | :heavy_minus_sign: | The pattern allows you to set the file-name format for the S3 staging file(s) | {date} | | `format` | [Union[shared.DestinationS3CSVCommaSeparatedValues, shared.DestinationS3JSONLinesNewlineDelimitedJSON, shared.DestinationS3AvroApacheAvro, shared.DestinationS3ParquetColumnarStorage]](../../models/shared/destinations3outputformat.md) | :heavy_check_mark: | Format of the data output. See here for more details | | | `s3_bucket_name` | *str* | :heavy_check_mark: | The name of the S3 bucket. Read more here. | airbyte_sync | | `s3_bucket_path` | *str* | :heavy_check_mark: | Directory under the S3 bucket where data will be written. Read more here | data_sync/test | +| `access_key_id` | *Optional[str]* | :heavy_minus_sign: | The access key ID to access the S3 bucket. Airbyte requires Read and Write permissions to the given bucket. Read more here. | A012345678910EXAMPLE | +| `destination_type` | [shared.S3](../../models/shared/s3.md) | :heavy_check_mark: | N/A | | +| `file_name_pattern` | *Optional[str]* | :heavy_minus_sign: | The pattern allows you to set the file-name format for the S3 staging file(s) | {date} | | `s3_bucket_region` | [Optional[shared.DestinationS3S3BucketRegion]](../../models/shared/destinations3s3bucketregion.md) | :heavy_minus_sign: | The region of the S3 bucket. See here for all region codes. | | | `s3_endpoint` | *Optional[str]* | :heavy_minus_sign: | Your S3 endpoint url. Read more here | http://localhost:9000 | | `s3_path_format` | *Optional[str]* | :heavy_minus_sign: | Format string on how data will be organized inside the S3 bucket directory. Read more here | ${NAMESPACE}/${STREAM_NAME}/${YEAR}_${MONTH}_${DAY}_${EPOCH}_ | diff --git a/docs/models/shared/destinations3glue.md b/docs/models/shared/destinations3glue.md index 9a2fc674..aa6906af 100644 --- a/docs/models/shared/destinations3glue.md +++ b/docs/models/shared/destinations3glue.md @@ -5,14 +5,14 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `access_key_id` | *Optional[str]* | :heavy_minus_sign: | The access key ID to access the S3 bucket. Airbyte requires Read and Write permissions to the given bucket. Read more here. | A012345678910EXAMPLE | -| `destination_type` | [shared.S3Glue](../../models/shared/s3glue.md) | :heavy_check_mark: | N/A | | -| `file_name_pattern` | *Optional[str]* | :heavy_minus_sign: | The pattern allows you to set the file-name format for the S3 staging file(s) | {date} | | `format` | [Union[shared.DestinationS3GlueJSONLinesNewlineDelimitedJSON]](../../models/shared/destinations3glueoutputformat.md) | :heavy_check_mark: | Format of the data output. See here for more details | | | `glue_database` | *str* | :heavy_check_mark: | Name of the glue database for creating the tables, leave blank if no integration | airbyte_database | -| `glue_serialization_library` | [Optional[shared.SerializationLibrary]](../../models/shared/serializationlibrary.md) | :heavy_minus_sign: | The library that your query engine will use for reading and writing data in your lake. | | | `s3_bucket_name` | *str* | :heavy_check_mark: | The name of the S3 bucket. Read more here. | airbyte_sync | | `s3_bucket_path` | *str* | :heavy_check_mark: | Directory under the S3 bucket where data will be written. Read more here | data_sync/test | +| `access_key_id` | *Optional[str]* | :heavy_minus_sign: | The access key ID to access the S3 bucket. Airbyte requires Read and Write permissions to the given bucket. Read more here. | A012345678910EXAMPLE | +| `destination_type` | [shared.S3Glue](../../models/shared/s3glue.md) | :heavy_check_mark: | N/A | | +| `file_name_pattern` | *Optional[str]* | :heavy_minus_sign: | The pattern allows you to set the file-name format for the S3 staging file(s) | {date} | +| `glue_serialization_library` | [Optional[shared.SerializationLibrary]](../../models/shared/serializationlibrary.md) | :heavy_minus_sign: | The library that your query engine will use for reading and writing data in your lake. | | | `s3_bucket_region` | [Optional[shared.DestinationS3GlueS3BucketRegion]](../../models/shared/destinations3glues3bucketregion.md) | :heavy_minus_sign: | The region of the S3 bucket. See here for all region codes. | | | `s3_endpoint` | *Optional[str]* | :heavy_minus_sign: | Your S3 endpoint url. Read more here | http://localhost:9000 | | `s3_path_format` | *Optional[str]* | :heavy_minus_sign: | Format string on how data will be organized inside the S3 bucket directory. Read more here | ${NAMESPACE}/${STREAM_NAME}/${YEAR}_${MONTH}_${DAY}_${EPOCH}_ | diff --git a/docs/models/shared/destinationsftpjson.md b/docs/models/shared/destinationsftpjson.md index 6285ce39..96753513 100644 --- a/docs/models/shared/destinationsftpjson.md +++ b/docs/models/shared/destinationsftpjson.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `destination_type` | [shared.SftpJSON](../../models/shared/sftpjson.md) | :heavy_check_mark: | N/A | | | `destination_path` | *str* | :heavy_check_mark: | Path to the directory where json files will be written. | /json_data | | `host` | *str* | :heavy_check_mark: | Hostname of the SFTP server. | | | `password` | *str* | :heavy_check_mark: | Password associated with the username. | | -| `port` | *Optional[int]* | :heavy_minus_sign: | Port of the SFTP server. | 22 | -| `username` | *str* | :heavy_check_mark: | Username to use to access the SFTP server. | | \ No newline at end of file +| `username` | *str* | :heavy_check_mark: | Username to use to access the SFTP server. | | +| `destination_type` | [shared.SftpJSON](../../models/shared/sftpjson.md) | :heavy_check_mark: | N/A | | +| `port` | *Optional[int]* | :heavy_minus_sign: | Port of the SFTP server. | 22 | \ No newline at end of file diff --git a/docs/models/shared/destinationsnowflake.md b/docs/models/shared/destinationsnowflake.md index bcb8637e..35ff5580 100644 --- a/docs/models/shared/destinationsnowflake.md +++ b/docs/models/shared/destinationsnowflake.md @@ -5,15 +5,15 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Optional[Union[shared.DestinationSnowflakeOAuth20, shared.KeyPairAuthentication, shared.UsernameAndPassword]]](../../models/shared/authorizationmethod.md) | :heavy_minus_sign: | N/A | | | `database` | *str* | :heavy_check_mark: | Enter the name of the database you want to sync data into | AIRBYTE_DATABASE | -| `destination_type` | [shared.DestinationSnowflakeSnowflake](../../models/shared/destinationsnowflakesnowflake.md) | :heavy_check_mark: | N/A | | -| `disable_type_dedupe` | *Optional[bool]* | :heavy_minus_sign: | Disable Writing Final Tables. WARNING! The data format in _airbyte_data is likely stable but there are no guarantees that other metadata columns will remain the same in future versions | | -| `enable_incremental_final_table_updates` | *Optional[bool]* | :heavy_minus_sign: | When enabled your data will load into your final tables incrementally while your data is still being synced. When Disabled (the default), your data loads into your final tables once at the end of a sync. Note that this option only applies if you elect to create Final tables | | | `host` | *str* | :heavy_check_mark: | Enter your Snowflake account's locator (in the format ...snowflakecomputing.com) | accountname.us-east-2.aws.snowflakecomputing.com | -| `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Enter the additional properties to pass to the JDBC URL string when connecting to the database (formatted as key=value pairs separated by the symbol &). Example: key1=value1&key2=value2&key3=value3 | | -| `raw_data_schema` | *Optional[str]* | :heavy_minus_sign: | The schema to write raw tables into (default: airbyte_internal) | | | `role` | *str* | :heavy_check_mark: | Enter the role that you want to use to access Snowflake | AIRBYTE_ROLE | | `schema` | *str* | :heavy_check_mark: | Enter the name of the default schema | AIRBYTE_SCHEMA | | `username` | *str* | :heavy_check_mark: | Enter the name of the user you want to use to access the database | AIRBYTE_USER | -| `warehouse` | *str* | :heavy_check_mark: | Enter the name of the warehouse that you want to sync data into | AIRBYTE_WAREHOUSE | \ No newline at end of file +| `warehouse` | *str* | :heavy_check_mark: | Enter the name of the warehouse that you want to sync data into | AIRBYTE_WAREHOUSE | +| `credentials` | [Optional[Union[shared.DestinationSnowflakeOAuth20, shared.KeyPairAuthentication, shared.UsernameAndPassword]]](../../models/shared/authorizationmethod.md) | :heavy_minus_sign: | N/A | | +| `destination_type` | [shared.DestinationSnowflakeSnowflake](../../models/shared/destinationsnowflakesnowflake.md) | :heavy_check_mark: | N/A | | +| `disable_type_dedupe` | *Optional[bool]* | :heavy_minus_sign: | Disable Writing Final Tables. WARNING! The data format in _airbyte_data is likely stable but there are no guarantees that other metadata columns will remain the same in future versions | | +| `enable_incremental_final_table_updates` | *Optional[bool]* | :heavy_minus_sign: | When enabled your data will load into your final tables incrementally while your data is still being synced. When Disabled (the default), your data loads into your final tables once at the end of a sync. Note that this option only applies if you elect to create Final tables | | +| `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Enter the additional properties to pass to the JDBC URL string when connecting to the database (formatted as key=value pairs separated by the symbol &). Example: key1=value1&key2=value2&key3=value3 | | +| `raw_data_schema` | *Optional[str]* | :heavy_minus_sign: | The schema to write raw tables into (default: airbyte_internal) | | \ No newline at end of file diff --git a/docs/models/shared/destinationsnowflakeoauth20.md b/docs/models/shared/destinationsnowflakeoauth20.md index 6c53dba9..a4790e6f 100644 --- a/docs/models/shared/destinationsnowflakeoauth20.md +++ b/docs/models/shared/destinationsnowflakeoauth20.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | Enter you application's Access Token | +| `refresh_token` | *str* | :heavy_check_mark: | Enter your application's Refresh Token | | `auth_type` | [Optional[shared.DestinationSnowflakeSchemasCredentialsAuthType]](../../models/shared/destinationsnowflakeschemascredentialsauthtype.md) | :heavy_minus_sign: | N/A | | `client_id` | *Optional[str]* | :heavy_minus_sign: | Enter your application's Client ID | -| `client_secret` | *Optional[str]* | :heavy_minus_sign: | Enter your application's Client secret | -| `refresh_token` | *str* | :heavy_check_mark: | Enter your application's Refresh Token | \ No newline at end of file +| `client_secret` | *Optional[str]* | :heavy_minus_sign: | Enter your application's Client secret | \ No newline at end of file diff --git a/docs/models/shared/destinationtypesense.md b/docs/models/shared/destinationtypesense.md index f54d3043..983766fe 100644 --- a/docs/models/shared/destinationtypesense.md +++ b/docs/models/shared/destinationtypesense.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Typesense API Key | +| `host` | *str* | :heavy_check_mark: | Hostname of the Typesense instance without protocol. | | `batch_size` | *Optional[int]* | :heavy_minus_sign: | How many documents should be imported together. Default 1000 | | `destination_type` | [shared.Typesense](../../models/shared/typesense.md) | :heavy_check_mark: | N/A | -| `host` | *str* | :heavy_check_mark: | Hostname of the Typesense instance without protocol. | | `port` | *Optional[str]* | :heavy_minus_sign: | Port of the Typesense instance. Ex: 8108, 80, 443. Default is 443 | | `protocol` | *Optional[str]* | :heavy_minus_sign: | Protocol of the Typesense instance. Ex: http or https. Default is https | \ No newline at end of file diff --git a/docs/models/shared/destinationvectara.md b/docs/models/shared/destinationvectara.md index 82b9f51e..0c69b1e0 100644 --- a/docs/models/shared/destinationvectara.md +++ b/docs/models/shared/destinationvectara.md @@ -9,8 +9,8 @@ Configuration to connect to the Vectara instance | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `corpus_name` | *str* | :heavy_check_mark: | The Name of Corpus to load data into | | | `customer_id` | *str* | :heavy_check_mark: | Your customer id as it is in the authenticaion url | | +| `oauth2` | [shared.OAuth20Credentials](../../models/shared/oauth20credentials.md) | :heavy_check_mark: | OAuth2.0 credentials used to authenticate admin actions (creating/deleting corpora) | | | `destination_type` | [shared.Vectara](../../models/shared/vectara.md) | :heavy_check_mark: | N/A | | | `metadata_fields` | List[*str*] | :heavy_minus_sign: | List of fields in the record that should be stored as metadata. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered metadata fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. `user.name` will access the `name` field in the `user` object. It's also possible to use wildcards to access all fields in an object, e.g. `users.*.name` will access all `names` fields in all entries of the `users` array. When specifying nested paths, all matching values are flattened into an array set to a field named by the path. | age | -| `oauth2` | [shared.OAuth20Credentials](../../models/shared/oauth20credentials.md) | :heavy_check_mark: | OAuth2.0 credentials used to authenticate admin actions (creating/deleting corpora) | | | `parallelize` | *Optional[bool]* | :heavy_minus_sign: | Parallelize indexing into Vectara with multiple threads | | | `text_fields` | List[*str*] | :heavy_minus_sign: | List of fields in the record that should be in the section of the document. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered text fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. `user.name` will access the `name` field in the `user` object. It's also possible to use wildcards to access all fields in an object, e.g. `users.*.name` will access all `names` fields in all entries of the `users` array. | text | \ No newline at end of file diff --git a/docs/models/shared/destinationvertica.md b/docs/models/shared/destinationvertica.md index f66fa56a..4e0329a7 100644 --- a/docs/models/shared/destinationvertica.md +++ b/docs/models/shared/destinationvertica.md @@ -6,11 +6,11 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `database` | *str* | :heavy_check_mark: | Name of the database. | | -| `destination_type` | [shared.Vertica](../../models/shared/vertica.md) | :heavy_check_mark: | N/A | | | `host` | *str* | :heavy_check_mark: | Hostname of the database. | | +| `schema` | *str* | :heavy_check_mark: | Schema for vertica destination | | +| `username` | *str* | :heavy_check_mark: | Username to use to access the database. | | +| `destination_type` | [shared.Vertica](../../models/shared/vertica.md) | :heavy_check_mark: | N/A | | | `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3). | | | `password` | *Optional[str]* | :heavy_minus_sign: | Password associated with the username. | | | `port` | *Optional[int]* | :heavy_minus_sign: | Port of the database. | 5433 | -| `schema` | *str* | :heavy_check_mark: | Schema for vertica destination | | -| `tunnel_method` | [Optional[Union[shared.DestinationVerticaNoTunnel, shared.DestinationVerticaSSHKeyAuthentication, shared.DestinationVerticaPasswordAuthentication]]](../../models/shared/destinationverticasshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | -| `username` | *str* | :heavy_check_mark: | Username to use to access the database. | | \ No newline at end of file +| `tunnel_method` | [Optional[Union[shared.DestinationVerticaNoTunnel, shared.DestinationVerticaSSHKeyAuthentication, shared.DestinationVerticaPasswordAuthentication]]](../../models/shared/destinationverticasshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | \ No newline at end of file diff --git a/docs/models/shared/destinationverticapasswordauthentication.md b/docs/models/shared/destinationverticapasswordauthentication.md index bf2b7409..1d01cc29 100644 --- a/docs/models/shared/destinationverticapasswordauthentication.md +++ b/docs/models/shared/destinationverticapasswordauthentication.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | -| `tunnel_method` | [shared.DestinationVerticaSchemasTunnelMethodTunnelMethod](../../models/shared/destinationverticaschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | | `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host | | -| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | \ No newline at end of file +| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [shared.DestinationVerticaSchemasTunnelMethodTunnelMethod](../../models/shared/destinationverticaschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/destinationverticasshkeyauthentication.md b/docs/models/shared/destinationverticasshkeyauthentication.md index f67313f6..1f607241 100644 --- a/docs/models/shared/destinationverticasshkeyauthentication.md +++ b/docs/models/shared/destinationverticasshkeyauthentication.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `ssh_key` | *str* | :heavy_check_mark: | OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa ) | | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | +| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | | `tunnel_method` | [shared.DestinationVerticaSchemasTunnelMethod](../../models/shared/destinationverticaschemastunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and ssh key | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | -| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | \ No newline at end of file +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/destinationweaviate.md b/docs/models/shared/destinationweaviate.md index 1a7059d9..7dd836ca 100644 --- a/docs/models/shared/destinationweaviate.md +++ b/docs/models/shared/destinationweaviate.md @@ -16,8 +16,8 @@ Processing, embedding and advanced configuration are provided by this base class | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `destination_type` | [shared.Weaviate](../../models/shared/weaviate.md) | :heavy_check_mark: | N/A | | `embedding` | [Union[shared.NoExternalEmbedding, shared.DestinationWeaviateAzureOpenAI, shared.DestinationWeaviateOpenAI, shared.DestinationWeaviateCohere, shared.FromField, shared.DestinationWeaviateFake, shared.DestinationWeaviateOpenAICompatible]](../../models/shared/destinationweaviateembedding.md) | :heavy_check_mark: | Embedding configuration | | `indexing` | [shared.DestinationWeaviateIndexing](../../models/shared/destinationweaviateindexing.md) | :heavy_check_mark: | Indexing configuration | -| `omit_raw_text` | *Optional[bool]* | :heavy_minus_sign: | Do not store the text that gets embedded along with the vector and the metadata in the destination. If set to true, only the vector and the metadata will be stored - in this case raw text for LLM use cases needs to be retrieved from another source. | -| `processing` | [shared.DestinationWeaviateProcessingConfigModel](../../models/shared/destinationweaviateprocessingconfigmodel.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `processing` | [shared.DestinationWeaviateProcessingConfigModel](../../models/shared/destinationweaviateprocessingconfigmodel.md) | :heavy_check_mark: | N/A | +| `destination_type` | [shared.Weaviate](../../models/shared/weaviate.md) | :heavy_check_mark: | N/A | +| `omit_raw_text` | *Optional[bool]* | :heavy_minus_sign: | Do not store the text that gets embedded along with the vector and the metadata in the destination. If set to true, only the vector and the metadata will be stored - in this case raw text for LLM use cases needs to be retrieved from another source. | \ No newline at end of file diff --git a/docs/models/shared/destinationweaviateapitoken.md b/docs/models/shared/destinationweaviateapitoken.md index fc0d2979..d4bd18b4 100644 --- a/docs/models/shared/destinationweaviateapitoken.md +++ b/docs/models/shared/destinationweaviateapitoken.md @@ -7,5 +7,5 @@ Authenticate using an API token (suitable for Weaviate Cloud) | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | -| `mode` | [Optional[shared.DestinationWeaviateSchemasIndexingMode]](../../models/shared/destinationweaviateschemasindexingmode.md) | :heavy_minus_sign: | N/A | -| `token` | *str* | :heavy_check_mark: | API Token for the Weaviate instance | \ No newline at end of file +| `token` | *str* | :heavy_check_mark: | API Token for the Weaviate instance | +| `mode` | [Optional[shared.DestinationWeaviateSchemasIndexingMode]](../../models/shared/destinationweaviateschemasindexingmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationweaviateazureopenai.md b/docs/models/shared/destinationweaviateazureopenai.md index 06cc2a2d..1fba92ad 100644 --- a/docs/models/shared/destinationweaviateazureopenai.md +++ b/docs/models/shared/destinationweaviateazureopenai.md @@ -9,5 +9,5 @@ Use the Azure-hosted OpenAI API to embed text. This option is using the text-emb | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | `api_base` | *str* | :heavy_check_mark: | The base URL for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource | https://your-resource-name.openai.azure.com | | `deployment` | *str* | :heavy_check_mark: | The deployment for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource | your-resource-name | -| `mode` | [Optional[shared.DestinationWeaviateSchemasMode]](../../models/shared/destinationweaviateschemasmode.md) | :heavy_minus_sign: | N/A | | -| `openai_key` | *str* | :heavy_check_mark: | The API key for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource | | \ No newline at end of file +| `openai_key` | *str* | :heavy_check_mark: | The API key for your Azure OpenAI resource. You can find this in the Azure portal under your Azure OpenAI resource | | +| `mode` | [Optional[shared.DestinationWeaviateSchemasMode]](../../models/shared/destinationweaviateschemasmode.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/destinationweaviateindexing.md b/docs/models/shared/destinationweaviateindexing.md index a2433a19..224a6c8b 100644 --- a/docs/models/shared/destinationweaviateindexing.md +++ b/docs/models/shared/destinationweaviateindexing.md @@ -7,9 +7,9 @@ Indexing configuration | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `additional_headers` | List[[shared.Header](../../models/shared/header.md)] | :heavy_minus_sign: | Additional HTTP headers to send with every request. | {"header_key":"X-OpenAI-Api-Key","value":"my-openai-api-key"} | | `auth` | [Union[shared.DestinationWeaviateAPIToken, shared.DestinationWeaviateUsernamePassword, shared.NoAuthentication]](../../models/shared/destinationweaviateauthentication.md) | :heavy_check_mark: | Authentication method | | +| `host` | *str* | :heavy_check_mark: | The public endpoint of the Weaviate cluster. | https://my-cluster.weaviate.network | +| `additional_headers` | List[[shared.Header](../../models/shared/header.md)] | :heavy_minus_sign: | Additional HTTP headers to send with every request. | {"header_key":"X-OpenAI-Api-Key","value":"my-openai-api-key"} | | `batch_size` | *Optional[int]* | :heavy_minus_sign: | The number of records to send to Weaviate in each batch | | | `default_vectorizer` | [Optional[shared.DefaultVectorizer]](../../models/shared/defaultvectorizer.md) | :heavy_minus_sign: | The vectorizer to use if new classes need to be created | | -| `host` | *str* | :heavy_check_mark: | The public endpoint of the Weaviate cluster. | https://my-cluster.weaviate.network | | `text_field` | *Optional[str]* | :heavy_minus_sign: | The field in the object that contains the embedded text | | \ No newline at end of file diff --git a/docs/models/shared/destinationweaviateopenai.md b/docs/models/shared/destinationweaviateopenai.md index 3f34d8ac..535349dc 100644 --- a/docs/models/shared/destinationweaviateopenai.md +++ b/docs/models/shared/destinationweaviateopenai.md @@ -7,5 +7,5 @@ Use the OpenAI API to embed text. This option is using the text-embedding-ada-00 | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationWeaviateSchemasEmbeddingMode]](../../models/shared/destinationweaviateschemasembeddingmode.md) | :heavy_minus_sign: | N/A | -| `openai_key` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `openai_key` | *str* | :heavy_check_mark: | N/A | +| `mode` | [Optional[shared.DestinationWeaviateSchemasEmbeddingMode]](../../models/shared/destinationweaviateschemasembeddingmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/destinationweaviateopenaicompatible.md b/docs/models/shared/destinationweaviateopenaicompatible.md index ec66ba2b..9831a5ff 100644 --- a/docs/models/shared/destinationweaviateopenaicompatible.md +++ b/docs/models/shared/destinationweaviateopenaicompatible.md @@ -7,8 +7,8 @@ Use a service that's compatible with the OpenAI API to embed text. | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `base_url` | *str* | :heavy_check_mark: | The base URL for your OpenAI-compatible service | https://your-service-name.com | | `dimensions` | *int* | :heavy_check_mark: | The number of dimensions the embedding model is generating | 1536 | +| `api_key` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `mode` | [Optional[shared.DestinationWeaviateSchemasEmbeddingEmbedding7Mode]](../../models/shared/destinationweaviateschemasembeddingembedding7mode.md) | :heavy_minus_sign: | N/A | | | `model_name` | *Optional[str]* | :heavy_minus_sign: | The name of the model to use for embedding | text-embedding-ada-002 | \ No newline at end of file diff --git a/docs/models/shared/destinationweaviateprocessingconfigmodel.md b/docs/models/shared/destinationweaviateprocessingconfigmodel.md index 520f03c1..2450c349 100644 --- a/docs/models/shared/destinationweaviateprocessingconfigmodel.md +++ b/docs/models/shared/destinationweaviateprocessingconfigmodel.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chunk_overlap` | *Optional[int]* | :heavy_minus_sign: | Size of overlap between chunks in tokens to store in vector store to better capture relevant context | | | `chunk_size` | *int* | :heavy_check_mark: | Size of chunks in tokens to store in vector store (make sure it is not too big for the context if your LLM) | | +| `chunk_overlap` | *Optional[int]* | :heavy_minus_sign: | Size of overlap between chunks in tokens to store in vector store to better capture relevant context | | | `field_name_mappings` | List[[shared.DestinationWeaviateFieldNameMappingConfigModel](../../models/shared/destinationweaviatefieldnamemappingconfigmodel.md)] | :heavy_minus_sign: | List of fields to rename. Not applicable for nested fields, but can be used to rename fields already flattened via dot notation. | | | `metadata_fields` | List[*str*] | :heavy_minus_sign: | List of fields in the record that should be stored as metadata. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered metadata fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. `user.name` will access the `name` field in the `user` object. It's also possible to use wildcards to access all fields in an object, e.g. `users.*.name` will access all `names` fields in all entries of the `users` array. When specifying nested paths, all matching values are flattened into an array set to a field named by the path. | age | | `text_fields` | List[*str*] | :heavy_minus_sign: | List of fields in the record that should be used to calculate the embedding. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered text fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. `user.name` will access the `name` field in the `user` object. It's also possible to use wildcards to access all fields in an object, e.g. `users.*.name` will access all `names` fields in all entries of the `users` array. | text | diff --git a/docs/models/shared/destinationweaviateusernamepassword.md b/docs/models/shared/destinationweaviateusernamepassword.md index 124cf18d..57e1c1e1 100644 --- a/docs/models/shared/destinationweaviateusernamepassword.md +++ b/docs/models/shared/destinationweaviateusernamepassword.md @@ -7,6 +7,6 @@ Authenticate using username and password (suitable for self-managed Weaviate clu | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationWeaviateSchemasIndexingAuthMode]](../../models/shared/destinationweaviateschemasindexingauthmode.md) | :heavy_minus_sign: | N/A | | `password` | *str* | :heavy_check_mark: | Password for the Weaviate cluster | -| `username` | *str* | :heavy_check_mark: | Username for the Weaviate cluster | \ No newline at end of file +| `username` | *str* | :heavy_check_mark: | Username for the Weaviate cluster | +| `mode` | [Optional[shared.DestinationWeaviateSchemasIndexingAuthMode]](../../models/shared/destinationweaviateschemasindexingauthmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/externaltablevias3.md b/docs/models/shared/externaltablevias3.md index e442e222..647d1393 100644 --- a/docs/models/shared/externaltablevias3.md +++ b/docs/models/shared/externaltablevias3.md @@ -7,6 +7,6 @@ | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | `aws_key_id` | *str* | :heavy_check_mark: | AWS access key granting read and write access to S3. | | | `aws_key_secret` | *str* | :heavy_check_mark: | Corresponding secret part of the AWS Key | | -| `method` | [shared.DestinationFireboltSchemasMethod](../../models/shared/destinationfireboltschemasmethod.md) | :heavy_check_mark: | N/A | | | `s3_bucket` | *str* | :heavy_check_mark: | The name of the S3 bucket. | | -| `s3_region` | *str* | :heavy_check_mark: | Region name of the S3 bucket. | us-east-1 | \ No newline at end of file +| `s3_region` | *str* | :heavy_check_mark: | Region name of the S3 bucket. | us-east-1 | +| `method` | [shared.DestinationFireboltSchemasMethod](../../models/shared/destinationfireboltschemasmethod.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/filebasedstreamconfig.md b/docs/models/shared/filebasedstreamconfig.md index ec2787cf..2f15a413 100644 --- a/docs/models/shared/filebasedstreamconfig.md +++ b/docs/models/shared/filebasedstreamconfig.md @@ -5,12 +5,12 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `days_to_sync_if_history_is_full` | *Optional[int]* | :heavy_minus_sign: | When the state history of the file store is full, syncs will only read files that were last modified in the provided day range. | | `format` | [Union[shared.AvroFormat, shared.CSVFormat, shared.JsonlFormat, shared.ParquetFormat, shared.DocumentFileTypeFormatExperimental]](../../models/shared/format.md) | :heavy_check_mark: | The configuration options that are used to alter how to read incoming files that deviate from the standard formatting. | +| `name` | *str* | :heavy_check_mark: | The name of the stream. | +| `days_to_sync_if_history_is_full` | *Optional[int]* | :heavy_minus_sign: | When the state history of the file store is full, syncs will only read files that were last modified in the provided day range. | | `globs` | List[*str*] | :heavy_minus_sign: | The pattern used to specify which files should be selected from the file system. For more information on glob pattern matching look here. | | `input_schema` | *Optional[str]* | :heavy_minus_sign: | The schema that will be used to validate records extracted from the file. This will override the stream schema that is auto-detected from incoming files. | | `legacy_prefix` | *Optional[str]* | :heavy_minus_sign: | The path prefix configured in v3 versions of the S3 connector. This option is deprecated in favor of a single glob. | -| `name` | *str* | :heavy_check_mark: | The name of the stream. | | `primary_key` | *Optional[str]* | :heavy_minus_sign: | The column or columns (for a composite key) that serves as the unique identifier of a record. If empty, the primary key will default to the parser's default primary key. | | `schemaless` | *Optional[bool]* | :heavy_minus_sign: | When enabled, syncs will not validate or structure records against the stream's schema. | | `validation_policy` | [Optional[shared.ValidationPolicy]](../../models/shared/validationpolicy.md) | :heavy_minus_sign: | The name of the validation policy that dictates sync behavior when a record does not adhere to the stream schema. | \ No newline at end of file diff --git a/docs/models/shared/googlecredentials.md b/docs/models/shared/googlecredentials.md index df83b25e..0d6f5661 100644 --- a/docs/models/shared/googlecredentials.md +++ b/docs/models/shared/googlecredentials.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `access_token` | *Optional[str]* | :heavy_minus_sign: | The Access Token for making authenticated requests. For detailed instructions on finding this value, refer to our documentation. | | `client_id` | *str* | :heavy_check_mark: | The Client ID of your Google Ads developer application. For detailed instructions on finding this value, refer to our documentation. | | `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your Google Ads developer application. For detailed instructions on finding this value, refer to our documentation. | | `developer_token` | *str* | :heavy_check_mark: | The Developer Token granted by Google to use their APIs. For detailed instructions on finding this value, refer to our documentation. | -| `refresh_token` | *str* | :heavy_check_mark: | The token used to obtain a new Access Token. For detailed instructions on finding this value, refer to our documentation. | \ No newline at end of file +| `refresh_token` | *str* | :heavy_check_mark: | The token used to obtain a new Access Token. For detailed instructions on finding this value, refer to our documentation. | +| `access_token` | *Optional[str]* | :heavy_minus_sign: | The Access Token for making authenticated requests. For detailed instructions on finding this value, refer to our documentation. | \ No newline at end of file diff --git a/docs/models/shared/hmackey.md b/docs/models/shared/hmackey.md index 16c8076c..ace3b3af 100644 --- a/docs/models/shared/hmackey.md +++ b/docs/models/shared/hmackey.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `credential_type` | [Optional[shared.CredentialType]](../../models/shared/credentialtype.md) | :heavy_minus_sign: | N/A | | | `hmac_key_access_id` | *str* | :heavy_check_mark: | When linked to a service account, this ID is 61 characters long; when linked to a user account, it is 24 characters long. Read more here. | 1234567890abcdefghij1234 | -| `hmac_key_secret` | *str* | :heavy_check_mark: | The corresponding secret for the access ID. It is a 40-character base-64 encoded string. Read more here. | 1234567890abcdefghij1234567890ABCDEFGHIJ | \ No newline at end of file +| `hmac_key_secret` | *str* | :heavy_check_mark: | The corresponding secret for the access ID. It is a 40-character base-64 encoded string. Read more here. | 1234567890abcdefghij1234567890ABCDEFGHIJ | +| `credential_type` | [Optional[shared.CredentialType]](../../models/shared/credentialtype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/iamrole.md b/docs/models/shared/iamrole.md index dc944368..335a0e39 100644 --- a/docs/models/shared/iamrole.md +++ b/docs/models/shared/iamrole.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| `credentials_title` | [Optional[shared.CredentialsTitle]](../../models/shared/credentialstitle.md) | :heavy_minus_sign: | Name of the credentials | -| `role_arn` | *str* | :heavy_check_mark: | Will assume this role to write data to s3 | \ No newline at end of file +| `role_arn` | *str* | :heavy_check_mark: | Will assume this role to write data to s3 | +| `credentials_title` | [Optional[shared.CredentialsTitle]](../../models/shared/credentialstitle.md) | :heavy_minus_sign: | Name of the credentials | \ No newline at end of file diff --git a/docs/models/shared/initiateoauthrequest.md b/docs/models/shared/initiateoauthrequest.md index 82dbf61d..e4540a59 100644 --- a/docs/models/shared/initiateoauthrequest.md +++ b/docs/models/shared/initiateoauthrequest.md @@ -7,7 +7,7 @@ POST body for initiating OAuth via the public API | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `o_auth_input_configuration` | [Optional[shared.OAuthInputConfiguration]](../../models/shared/oauthinputconfiguration.md) | :heavy_minus_sign: | Arbitrary vars to pass for OAuth depending on what the source/destination spec requires. | | `redirect_url` | *str* | :heavy_check_mark: | The URL to redirect the user to with the OAuth secret stored in the secret_id query string parameter after authentication is complete. | | `source_type` | [shared.OAuthActorNames](../../models/shared/oauthactornames.md) | :heavy_check_mark: | N/A | -| `workspace_id` | *str* | :heavy_check_mark: | The workspace to create the secret and eventually the full source. | \ No newline at end of file +| `workspace_id` | *str* | :heavy_check_mark: | The workspace to create the secret and eventually the full source. | +| `o_auth_input_configuration` | [Optional[shared.OAuthInputConfiguration]](../../models/shared/oauthinputconfiguration.md) | :heavy_minus_sign: | Arbitrary vars to pass for OAuth depending on what the source/destination spec requires. | \ No newline at end of file diff --git a/docs/models/shared/inlistfilter.md b/docs/models/shared/inlistfilter.md index 12a0cd23..297a796d 100644 --- a/docs/models/shared/inlistfilter.md +++ b/docs/models/shared/inlistfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `values` | List[*str*] | :heavy_check_mark: | N/A | | `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPIFilterName](../../models/shared/sourcegoogleanalyticsdataapifiltername.md) | :heavy_check_mark: | N/A | -| `values` | List[*str*] | :heavy_check_mark: | N/A | \ No newline at end of file +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPIFilterName](../../models/shared/sourcegoogleanalyticsdataapifiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/insightconfig.md b/docs/models/shared/insightconfig.md index d29df4a4..3b854e34 100644 --- a/docs/models/shared/insightconfig.md +++ b/docs/models/shared/insightconfig.md @@ -7,6 +7,7 @@ Config for custom insights | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `name` | *str* | :heavy_check_mark: | The name value of insight | | | `action_breakdowns` | List[[shared.ValidActionBreakdowns](../../models/shared/validactionbreakdowns.md)] | :heavy_minus_sign: | A list of chosen action_breakdowns for action_breakdowns | | | `action_report_time` | [Optional[shared.ActionReportTime]](../../models/shared/actionreporttime.md) | :heavy_minus_sign: | Determines the report time of action stats. For example, if a person saw the ad on Jan 1st but converted on Jan 2nd, when you query the API with action_report_time=impression, you see a conversion on Jan 1st. When you query the API with action_report_time=conversion, you see a conversion on Jan 2nd. | | | `breakdowns` | List[[shared.ValidBreakdowns](../../models/shared/validbreakdowns.md)] | :heavy_minus_sign: | A list of chosen breakdowns for breakdowns | | @@ -15,6 +16,5 @@ Config for custom insights | `insights_job_timeout` | *Optional[int]* | :heavy_minus_sign: | The insights job timeout | | | `insights_lookback_window` | *Optional[int]* | :heavy_minus_sign: | The attribution window | | | `level` | [Optional[shared.Level]](../../models/shared/level.md) | :heavy_minus_sign: | Chosen level for API | | -| `name` | *str* | :heavy_check_mark: | The name value of insight | | | `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The date from which you'd like to replicate data for this stream, in the format YYYY-MM-DDT00:00:00Z. | 2017-01-25T00:00:00Z | | `time_increment` | *Optional[int]* | :heavy_minus_sign: | Time window in days by which to aggregate statistics. The sync will be chunked into N day intervals, where N is the number of days you specified. For example, if you set this value to 7, then all statistics will be reported as 7-day aggregates by starting from the start_date. If the start and end dates are October 1st and October 30th, then the connector will output 5 records: 01 - 06, 07 - 13, 14 - 20, 21 - 27, and 28 - 30 (3 days only). | | \ No newline at end of file diff --git a/docs/models/shared/jobresponse.md b/docs/models/shared/jobresponse.md index 56567bf8..d024f76b 100644 --- a/docs/models/shared/jobresponse.md +++ b/docs/models/shared/jobresponse.md @@ -7,12 +7,12 @@ Provides details of a single job. | Field | Type | Required | Description | | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| `bytes_synced` | *Optional[int]* | :heavy_minus_sign: | N/A | | `connection_id` | *str* | :heavy_check_mark: | N/A | -| `duration` | *Optional[str]* | :heavy_minus_sign: | Duration of a sync in ISO_8601 format | | `job_id` | *int* | :heavy_check_mark: | N/A | | `job_type` | [shared.JobTypeEnum](../../models/shared/jobtypeenum.md) | :heavy_check_mark: | Enum that describes the different types of jobs that the platform runs. | -| `last_updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `rows_synced` | *Optional[int]* | :heavy_minus_sign: | N/A | | `start_time` | *str* | :heavy_check_mark: | N/A | -| `status` | [shared.JobStatusEnum](../../models/shared/jobstatusenum.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `status` | [shared.JobStatusEnum](../../models/shared/jobstatusenum.md) | :heavy_check_mark: | N/A | +| `bytes_synced` | *Optional[int]* | :heavy_minus_sign: | N/A | +| `duration` | *Optional[str]* | :heavy_minus_sign: | Duration of a sync in ISO_8601 format | +| `last_updated_at` | *Optional[str]* | :heavy_minus_sign: | N/A | +| `rows_synced` | *Optional[int]* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/keypairauthentication.md b/docs/models/shared/keypairauthentication.md index aa5e4a1c..a6eb3657 100644 --- a/docs/models/shared/keypairauthentication.md +++ b/docs/models/shared/keypairauthentication.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth_type` | [Optional[shared.DestinationSnowflakeAuthType]](../../models/shared/destinationsnowflakeauthtype.md) | :heavy_minus_sign: | N/A | | `private_key` | *str* | :heavy_check_mark: | RSA Private key to use for Snowflake connection. See the docs for more information on how to obtain this key. | +| `auth_type` | [Optional[shared.DestinationSnowflakeAuthType]](../../models/shared/destinationsnowflakeauthtype.md) | :heavy_minus_sign: | N/A | | `private_key_password` | *Optional[str]* | :heavy_minus_sign: | Passphrase for private key | \ No newline at end of file diff --git a/docs/models/shared/logicalreplicationcdc.md b/docs/models/shared/logicalreplicationcdc.md index b7a6be85..f6005030 100644 --- a/docs/models/shared/logicalreplicationcdc.md +++ b/docs/models/shared/logicalreplicationcdc.md @@ -7,11 +7,11 @@ Logical replication uses the Postgres write-ahead log (WAL) to detect inserts, u | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `publication` | *str* | :heavy_check_mark: | A Postgres publication used for consuming changes. Read about publications and replication identities. | +| `replication_slot` | *str* | :heavy_check_mark: | A plugin logical replication slot. Read about replication slots. | | `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `initial_waiting_seconds` | *Optional[int]* | :heavy_minus_sign: | The amount of time the connector will wait when it launches to determine if there is new data to sync or not. Defaults to 300 seconds. Valid range: 120 seconds to 1200 seconds. Read about initial waiting time. | | `lsn_commit_behaviour` | [Optional[shared.LSNCommitBehaviour]](../../models/shared/lsncommitbehaviour.md) | :heavy_minus_sign: | Determines when Airbtye should flush the LSN of processed WAL logs in the source database. `After loading Data in the destination` is default. If `While reading Data` is selected, in case of a downstream failure (while loading data into the destination), next sync would result in a full sync. | | `method` | [shared.SourceAlloydbSchemasMethod](../../models/shared/sourcealloydbschemasmethod.md) | :heavy_check_mark: | N/A | | `plugin` | [Optional[shared.Plugin]](../../models/shared/plugin.md) | :heavy_minus_sign: | A logical decoding plugin installed on the PostgreSQL server. | -| `publication` | *str* | :heavy_check_mark: | A Postgres publication used for consuming changes. Read about publications and replication identities. | -| `queue_size` | *Optional[int]* | :heavy_minus_sign: | The size of the internal queue. This may interfere with memory consumption and efficiency of the connector, please be careful. | -| `replication_slot` | *str* | :heavy_check_mark: | A plugin logical replication slot. Read about replication slots. | \ No newline at end of file +| `queue_size` | *Optional[int]* | :heavy_minus_sign: | The size of the internal queue. This may interfere with memory consumption and efficiency of the connector, please be careful. | \ No newline at end of file diff --git a/docs/models/shared/loginpassword.md b/docs/models/shared/loginpassword.md index ae6e4cd7..350694e2 100644 --- a/docs/models/shared/loginpassword.md +++ b/docs/models/shared/loginpassword.md @@ -7,6 +7,6 @@ Login/Password. | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `authorization` | [shared.DestinationMongodbAuthorization](../../models/shared/destinationmongodbauthorization.md) | :heavy_check_mark: | N/A | | `password` | *str* | :heavy_check_mark: | Password associated with the username. | -| `username` | *str* | :heavy_check_mark: | Username to use to access the database. | \ No newline at end of file +| `username` | *str* | :heavy_check_mark: | Username to use to access the database. | +| `authorization` | [shared.DestinationMongodbAuthorization](../../models/shared/destinationmongodbauthorization.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/mongodbatlasreplicaset.md b/docs/models/shared/mongodbatlasreplicaset.md index 717ef2fd..d60bd4b3 100644 --- a/docs/models/shared/mongodbatlasreplicaset.md +++ b/docs/models/shared/mongodbatlasreplicaset.md @@ -7,11 +7,11 @@ MongoDB Atlas-hosted cluster configured as a replica set | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | -| `auth_source` | *Optional[str]* | :heavy_minus_sign: | The authentication source where the user information is stored. See https://www.mongodb.com/docs/manual/reference/connection-string/#mongodb-urioption-urioption.authSource for more details. | admin | -| `cluster_type` | [shared.SourceMongodbV2ClusterType](../../models/shared/sourcemongodbv2clustertype.md) | :heavy_check_mark: | N/A | | | `connection_string` | *str* | :heavy_check_mark: | The connection string of the cluster that you want to replicate. | mongodb+srv://cluster0.abcd1.mongodb.net/ | | `database` | *str* | :heavy_check_mark: | The name of the MongoDB database that contains the collection(s) to replicate. | | | `password` | *str* | :heavy_check_mark: | The password associated with this username. | | -| `schema_enforced` | *Optional[bool]* | :heavy_minus_sign: | When enabled, syncs will validate and structure records against the stream's schema. | | -| `username` | *str* | :heavy_check_mark: | The username which is used to access the database. | | \ No newline at end of file +| `username` | *str* | :heavy_check_mark: | The username which is used to access the database. | | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | +| `auth_source` | *Optional[str]* | :heavy_minus_sign: | The authentication source where the user information is stored. See https://www.mongodb.com/docs/manual/reference/connection-string/#mongodb-urioption-urioption.authSource for more details. | admin | +| `cluster_type` | [shared.SourceMongodbV2ClusterType](../../models/shared/sourcemongodbv2clustertype.md) | :heavy_check_mark: | N/A | | +| `schema_enforced` | *Optional[bool]* | :heavy_minus_sign: | When enabled, syncs will validate and structure records against the stream's schema. | | \ No newline at end of file diff --git a/docs/models/shared/numericfilter.md b/docs/models/shared/numericfilter.md index 3aff8fc4..2bcd1381 100644 --- a/docs/models/shared/numericfilter.md +++ b/docs/models/shared/numericfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasFilterName](../../models/shared/sourcegoogleanalyticsdataapischemasfiltername.md) | :heavy_check_mark: | N/A | | `operation` | List[[shared.SourceGoogleAnalyticsDataAPISchemasValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemasvalidenums.md)] | :heavy_check_mark: | N/A | -| `value` | [Union[shared.Int64Value, shared.DoubleValue]](../../models/shared/value.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `value` | [Union[shared.Int64Value, shared.DoubleValue]](../../models/shared/value.md) | :heavy_check_mark: | N/A | +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasFilterName](../../models/shared/sourcegoogleanalyticsdataapischemasfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/oauth20.md b/docs/models/shared/oauth20.md index 020467f3..8b4bcd92 100644 --- a/docs/models/shared/oauth20.md +++ b/docs/models/shared/oauth20.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `auth_method` | [shared.SourcePinterestAuthMethod](../../models/shared/sourcepinterestauthmethod.md) | :heavy_check_mark: | N/A | | `client_id` | *str* | :heavy_check_mark: | The Client ID of your OAuth application | | `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your OAuth application. | -| `refresh_token` | *str* | :heavy_check_mark: | Refresh Token to obtain new Access Token, when it's expired. | \ No newline at end of file +| `refresh_token` | *str* | :heavy_check_mark: | Refresh Token to obtain new Access Token, when it's expired. | +| `auth_method` | [shared.SourcePinterestAuthMethod](../../models/shared/sourcepinterestauthmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/oauth2confidentialapplication.md b/docs/models/shared/oauth2confidentialapplication.md index ebb58307..18b3c675 100644 --- a/docs/models/shared/oauth2confidentialapplication.md +++ b/docs/models/shared/oauth2confidentialapplication.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `audience` | *str* | :heavy_check_mark: | The audience for the token, which is your API. You can find this in the Identifier field on your API's settings tab | https://dev-yourOrg.us.auth0.com/api/v2/ | -| `auth_type` | [shared.SourceAuth0SchemasAuthenticationMethod](../../models/shared/sourceauth0schemasauthenticationmethod.md) | :heavy_check_mark: | N/A | | | `client_id` | *str* | :heavy_check_mark: | Your application's Client ID. You can find this value on the application's settings tab after you login the admin portal. | Client_ID | -| `client_secret` | *str* | :heavy_check_mark: | Your application's Client Secret. You can find this value on the application's settings tab after you login the admin portal. | Client_Secret | \ No newline at end of file +| `client_secret` | *str* | :heavy_check_mark: | Your application's Client Secret. You can find this value on the application's settings tab after you login the admin portal. | Client_Secret | +| `auth_type` | [shared.SourceAuth0SchemasAuthenticationMethod](../../models/shared/sourceauth0schemasauthenticationmethod.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/oauthauthentication.md b/docs/models/shared/oauthauthentication.md index f39a30f0..8d66cf8b 100644 --- a/docs/models/shared/oauthauthentication.md +++ b/docs/models/shared/oauthauthentication.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `auth_type` | [shared.SourceSquareAuthType](../../models/shared/sourcesquareauthtype.md) | :heavy_check_mark: | N/A | | `client_id` | *str* | :heavy_check_mark: | The Square-issued ID of your application | | `client_secret` | *str* | :heavy_check_mark: | The Square-issued application secret for your application | -| `refresh_token` | *str* | :heavy_check_mark: | A refresh token generated using the above client ID and secret | \ No newline at end of file +| `refresh_token` | *str* | :heavy_check_mark: | A refresh token generated using the above client ID and secret | +| `auth_type` | [shared.SourceSquareAuthType](../../models/shared/sourcesquareauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/openai.md b/docs/models/shared/openai.md index 458441ad..581f4308 100644 --- a/docs/models/shared/openai.md +++ b/docs/models/shared/openai.md @@ -7,5 +7,5 @@ Use the OpenAI API to embed text. This option is using the text-embedding-ada-00 | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `mode` | [Optional[shared.DestinationLangchainSchemasEmbeddingMode]](../../models/shared/destinationlangchainschemasembeddingmode.md) | :heavy_minus_sign: | N/A | -| `openai_key` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `openai_key` | *str* | :heavy_check_mark: | N/A | +| `mode` | [Optional[shared.DestinationLangchainSchemasEmbeddingMode]](../../models/shared/destinationlangchainschemasembeddingmode.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/openaicompatible.md b/docs/models/shared/openaicompatible.md index 8dbf64df..1f605f8e 100644 --- a/docs/models/shared/openaicompatible.md +++ b/docs/models/shared/openaicompatible.md @@ -7,8 +7,8 @@ Use a service that's compatible with the OpenAI API to embed text. | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `api_key` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `base_url` | *str* | :heavy_check_mark: | The base URL for your OpenAI-compatible service | https://your-service-name.com | | `dimensions` | *int* | :heavy_check_mark: | The number of dimensions the embedding model is generating | 1536 | +| `api_key` | *Optional[str]* | :heavy_minus_sign: | N/A | | | `mode` | [Optional[shared.DestinationMilvusSchemasEmbeddingEmbedding5Mode]](../../models/shared/destinationmilvusschemasembeddingembedding5mode.md) | :heavy_minus_sign: | N/A | | | `model_name` | *Optional[str]* | :heavy_minus_sign: | The name of the model to use for embedding | text-embedding-ada-002 | \ No newline at end of file diff --git a/docs/models/shared/passwordauthentication.md b/docs/models/shared/passwordauthentication.md index 657ef623..b77537af 100644 --- a/docs/models/shared/passwordauthentication.md +++ b/docs/models/shared/passwordauthentication.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | -| `tunnel_method` | [shared.DestinationClickhouseSchemasTunnelMethod](../../models/shared/destinationclickhouseschemastunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | | `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host | | -| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | \ No newline at end of file +| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [shared.DestinationClickhouseSchemasTunnelMethod](../../models/shared/destinationclickhouseschemastunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/processingconfigmodel.md b/docs/models/shared/processingconfigmodel.md index 30e39ba4..de51289e 100644 --- a/docs/models/shared/processingconfigmodel.md +++ b/docs/models/shared/processingconfigmodel.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `chunk_overlap` | *Optional[int]* | :heavy_minus_sign: | Size of overlap between chunks in tokens to store in vector store to better capture relevant context | | | `chunk_size` | *int* | :heavy_check_mark: | Size of chunks in tokens to store in vector store (make sure it is not too big for the context if your LLM) | | -| `text_fields` | List[*str*] | :heavy_check_mark: | List of fields in the record that should be used to calculate the embedding. All other fields are passed along as meta fields. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered text fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. `user.name` will access the `name` field in the `user` object. It's also possible to use wildcards to access all fields in an object, e.g. `users.*.name` will access all `names` fields in all entries of the `users` array. | text | \ No newline at end of file +| `text_fields` | List[*str*] | :heavy_check_mark: | List of fields in the record that should be used to calculate the embedding. All other fields are passed along as meta fields. The field list is applied to all streams in the same way and non-existing fields are ignored. If none are defined, all fields are considered text fields. When specifying text fields, you can access nested fields in the record by using dot notation, e.g. `user.name` will access the `name` field in the `user` object. It's also possible to use wildcards to access all fields in an object, e.g. `users.*.name` will access all `names` fields in all entries of the `users` array. | text | +| `chunk_overlap` | *Optional[int]* | :heavy_minus_sign: | Size of overlap between chunks in tokens to store in vector store to better capture relevant context | | \ No newline at end of file diff --git a/docs/models/shared/readchangesusingwriteaheadlogcdc.md b/docs/models/shared/readchangesusingwriteaheadlogcdc.md index f03954de..b89cd56a 100644 --- a/docs/models/shared/readchangesusingwriteaheadlogcdc.md +++ b/docs/models/shared/readchangesusingwriteaheadlogcdc.md @@ -7,11 +7,11 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `publication` | *str* | :heavy_check_mark: | A Postgres publication used for consuming changes. Read about publications and replication identities. | +| `replication_slot` | *str* | :heavy_check_mark: | A plugin logical replication slot. Read about replication slots. | | `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `initial_waiting_seconds` | *Optional[int]* | :heavy_minus_sign: | The amount of time the connector will wait when it launches to determine if there is new data to sync or not. Defaults to 1200 seconds. Valid range: 120 seconds to 2400 seconds. Read about initial waiting time. | | `lsn_commit_behaviour` | [Optional[shared.SourcePostgresLSNCommitBehaviour]](../../models/shared/sourcepostgreslsncommitbehaviour.md) | :heavy_minus_sign: | Determines when Airbyte should flush the LSN of processed WAL logs in the source database. `After loading Data in the destination` is default. If `While reading Data` is selected, in case of a downstream failure (while loading data into the destination), next sync would result in a full sync. | | `method` | [shared.SourcePostgresMethod](../../models/shared/sourcepostgresmethod.md) | :heavy_check_mark: | N/A | | `plugin` | [Optional[shared.SourcePostgresPlugin]](../../models/shared/sourcepostgresplugin.md) | :heavy_minus_sign: | A logical decoding plugin installed on the PostgreSQL server. | -| `publication` | *str* | :heavy_check_mark: | A Postgres publication used for consuming changes. Read about publications and replication identities. | -| `queue_size` | *Optional[int]* | :heavy_minus_sign: | The size of the internal queue. This may interfere with memory consumption and efficiency of the connector, please be careful. | -| `replication_slot` | *str* | :heavy_check_mark: | A plugin logical replication slot. Read about replication slots. | \ No newline at end of file +| `queue_size` | *Optional[int]* | :heavy_minus_sign: | The size of the internal queue. This may interfere with memory consumption and efficiency of the connector, please be careful. | \ No newline at end of file diff --git a/docs/models/shared/replicaset.md b/docs/models/shared/replicaset.md index 59f1b528..42548a6a 100644 --- a/docs/models/shared/replicaset.md +++ b/docs/models/shared/replicaset.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | +| `server_addresses` | *str* | :heavy_check_mark: | The members of a replica set. Please specify `host`:`port` of each member seperated by comma. | host1:27017,host2:27017,host3:27017 | | `instance` | [Optional[shared.DestinationMongodbInstance]](../../models/shared/destinationmongodbinstance.md) | :heavy_minus_sign: | N/A | | -| `replica_set` | *Optional[str]* | :heavy_minus_sign: | A replica set name. | | -| `server_addresses` | *str* | :heavy_check_mark: | The members of a replica set. Please specify `host`:`port` of each member seperated by comma. | host1:27017,host2:27017,host3:27017 | \ No newline at end of file +| `replica_set` | *Optional[str]* | :heavy_minus_sign: | A replica set name. | | \ No newline at end of file diff --git a/docs/models/shared/reportconfig.md b/docs/models/shared/reportconfig.md index fc8e6a98..840f342b 100644 --- a/docs/models/shared/reportconfig.md +++ b/docs/models/shared/reportconfig.md @@ -7,13 +7,13 @@ Config for custom report | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `columns` | List[[shared.SourcePinterestSchemasValidEnums](../../models/shared/sourcepinterestschemasvalidenums.md)] | :heavy_check_mark: | A list of chosen columns | | +| `name` | *str* | :heavy_check_mark: | The name value of report | | | `attribution_types` | List[[shared.SourcePinterestValidEnums](../../models/shared/sourcepinterestvalidenums.md)] | :heavy_minus_sign: | List of types of attribution for the conversion report | | | `click_window_days` | [Optional[shared.ClickWindowDays]](../../models/shared/clickwindowdays.md) | :heavy_minus_sign: | Number of days to use as the conversion attribution window for a pin click action. | | -| `columns` | List[[shared.SourcePinterestSchemasValidEnums](../../models/shared/sourcepinterestschemasvalidenums.md)] | :heavy_check_mark: | A list of chosen columns | | | `conversion_report_time` | [Optional[shared.ConversionReportTime]](../../models/shared/conversionreporttime.md) | :heavy_minus_sign: | The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event.. | | | `engagement_window_days` | [Optional[shared.EngagementWindowDays]](../../models/shared/engagementwindowdays.md) | :heavy_minus_sign: | Number of days to use as the conversion attribution window for an engagement action. | | | `granularity` | [Optional[shared.Granularity]](../../models/shared/granularity.md) | :heavy_minus_sign: | Chosen granularity for API | | | `level` | [Optional[shared.SourcePinterestLevel]](../../models/shared/sourcepinterestlevel.md) | :heavy_minus_sign: | Chosen level for API | | -| `name` | *str* | :heavy_check_mark: | The name value of report | | | `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | A date in the format YYYY-MM-DD. If you have not set a date, it would be defaulted to latest allowed date by report api (913 days from today). | 2022-07-28 | | `view_window_days` | [Optional[shared.ViewWindowDays]](../../models/shared/viewwindowdays.md) | :heavy_minus_sign: | Number of days to use as the conversion attribution window for a view action. | | \ No newline at end of file diff --git a/docs/models/shared/scpsecurecopyprotocol.md b/docs/models/shared/scpsecurecopyprotocol.md index 51e24023..747e727c 100644 --- a/docs/models/shared/scpsecurecopyprotocol.md +++ b/docs/models/shared/scpsecurecopyprotocol.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `host` | *str* | :heavy_check_mark: | N/A | +| `user` | *str* | :heavy_check_mark: | N/A | | `password` | *Optional[str]* | :heavy_minus_sign: | N/A | | `port` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `storage` | [shared.SourceFileSchemasProviderStorageProvider6Storage](../../models/shared/sourcefileschemasproviderstorageprovider6storage.md) | :heavy_check_mark: | N/A | -| `user` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `storage` | [shared.SourceFileSchemasProviderStorageProvider6Storage](../../models/shared/sourcefileschemasproviderstorageprovider6storage.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/selfmanagedreplicaset.md b/docs/models/shared/selfmanagedreplicaset.md index bbf84b93..18682afa 100644 --- a/docs/models/shared/selfmanagedreplicaset.md +++ b/docs/models/shared/selfmanagedreplicaset.md @@ -7,11 +7,11 @@ MongoDB self-hosted cluster configured as a replica set | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `connection_string` | *str* | :heavy_check_mark: | The connection string of the cluster that you want to replicate. https://www.mongodb.com/docs/manual/reference/connection-string/#find-your-self-hosted-deployment-s-connection-string for more information. | mongodb://example1.host.com:27017,example2.host.com:27017,example3.host.com:27017/ | +| `database` | *str* | :heavy_check_mark: | The name of the MongoDB database that contains the collection(s) to replicate. | | | `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | | `auth_source` | *Optional[str]* | :heavy_minus_sign: | The authentication source where the user information is stored. | admin | | `cluster_type` | [shared.SourceMongodbV2SchemasClusterType](../../models/shared/sourcemongodbv2schemasclustertype.md) | :heavy_check_mark: | N/A | | -| `connection_string` | *str* | :heavy_check_mark: | The connection string of the cluster that you want to replicate. https://www.mongodb.com/docs/manual/reference/connection-string/#find-your-self-hosted-deployment-s-connection-string for more information. | mongodb://example1.host.com:27017,example2.host.com:27017,example3.host.com:27017/ | -| `database` | *str* | :heavy_check_mark: | The name of the MongoDB database that contains the collection(s) to replicate. | | | `password` | *Optional[str]* | :heavy_minus_sign: | The password associated with this username. | | | `schema_enforced` | *Optional[bool]* | :heavy_minus_sign: | When enabled, syncs will validate and structure records against the stream's schema. | | | `username` | *Optional[str]* | :heavy_minus_sign: | The username which is used to access the database. | | \ No newline at end of file diff --git a/docs/models/shared/serviceaccount.md b/docs/models/shared/serviceaccount.md index 56bccf98..9415a753 100644 --- a/docs/models/shared/serviceaccount.md +++ b/docs/models/shared/serviceaccount.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `option_title` | [Optional[shared.SourceMixpanelOptionTitle]](../../models/shared/sourcemixpaneloptiontitle.md) | :heavy_minus_sign: | N/A | | `project_id` | *int* | :heavy_check_mark: | Your project ID number. See the docs for more information on how to obtain this. | | `secret` | *str* | :heavy_check_mark: | Mixpanel Service Account Secret. See the docs for more information on how to obtain this. | -| `username` | *str* | :heavy_check_mark: | Mixpanel Service Account Username. See the docs for more information on how to obtain this. | \ No newline at end of file +| `username` | *str* | :heavy_check_mark: | Mixpanel Service Account Username. See the docs for more information on how to obtain this. | +| `option_title` | [Optional[shared.SourceMixpanelOptionTitle]](../../models/shared/sourcemixpaneloptiontitle.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/serviceaccountkey.md b/docs/models/shared/serviceaccountkey.md index 6a13c3ab..4ead0f7f 100644 --- a/docs/models/shared/serviceaccountkey.md +++ b/docs/models/shared/serviceaccountkey.md @@ -8,5 +8,5 @@ For these scenario user should obtain service account's credentials from the Goo | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `credentials_json` | *str* | :heavy_check_mark: | The contents of the JSON service account key. See the docs for more information on how to generate this key. | -| `credentials_title` | [Optional[shared.SourceGoogleDirectorySchemasCredentialsTitle]](../../models/shared/sourcegoogledirectoryschemascredentialstitle.md) | :heavy_minus_sign: | Authentication Scenario | -| `email` | *str* | :heavy_check_mark: | The email of the user, which has permissions to access the Google Workspace Admin APIs. | \ No newline at end of file +| `email` | *str* | :heavy_check_mark: | The email of the user, which has permissions to access the Google Workspace Admin APIs. | +| `credentials_title` | [Optional[shared.SourceGoogleDirectorySchemasCredentialsTitle]](../../models/shared/sourcegoogledirectoryschemascredentialstitle.md) | :heavy_minus_sign: | Authentication Scenario | \ No newline at end of file diff --git a/docs/models/shared/serviceaccountkeyauthentication.md b/docs/models/shared/serviceaccountkeyauthentication.md index 94580591..38f56040 100644 --- a/docs/models/shared/serviceaccountkeyauthentication.md +++ b/docs/models/shared/serviceaccountkeyauthentication.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth_type` | [Optional[shared.SourceGoogleAnalyticsDataAPISchemasAuthType]](../../models/shared/sourcegoogleanalyticsdataapischemasauthtype.md) | :heavy_minus_sign: | N/A | | -| `credentials_json` | *str* | :heavy_check_mark: | The JSON key linked to the service account used for authorization. For steps on obtaining this key, refer to the setup guide. | { "type": "service_account", "project_id": YOUR_PROJECT_ID, "private_key_id": YOUR_PRIVATE_KEY, ... } | \ No newline at end of file +| `credentials_json` | *str* | :heavy_check_mark: | The JSON key linked to the service account used for authorization. For steps on obtaining this key, refer to the setup guide. | { "type": "service_account", "project_id": YOUR_PROJECT_ID, "private_key_id": YOUR_PRIVATE_KEY, ... } | +| `auth_type` | [Optional[shared.SourceGoogleAnalyticsDataAPISchemasAuthType]](../../models/shared/sourcegoogleanalyticsdataapischemasauthtype.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/servicename.md b/docs/models/shared/servicename.md index 462def00..6e35c4c3 100644 --- a/docs/models/shared/servicename.md +++ b/docs/models/shared/servicename.md @@ -7,5 +7,5 @@ Use service name | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `connection_type` | [Optional[shared.ConnectionType]](../../models/shared/connectiontype.md) | :heavy_minus_sign: | N/A | -| `service_name` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `service_name` | *str* | :heavy_check_mark: | N/A | +| `connection_type` | [Optional[shared.ConnectionType]](../../models/shared/connectiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sftpsecurefiletransferprotocol.md b/docs/models/shared/sftpsecurefiletransferprotocol.md index d6d2f21d..c1dbb0c7 100644 --- a/docs/models/shared/sftpsecurefiletransferprotocol.md +++ b/docs/models/shared/sftpsecurefiletransferprotocol.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `host` | *str* | :heavy_check_mark: | N/A | +| `user` | *str* | :heavy_check_mark: | N/A | | `password` | *Optional[str]* | :heavy_minus_sign: | N/A | | `port` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `storage` | [shared.SourceFileSchemasProviderStorageProvider7Storage](../../models/shared/sourcefileschemasproviderstorageprovider7storage.md) | :heavy_check_mark: | N/A | -| `user` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `storage` | [shared.SourceFileSchemasProviderStorageProvider7Storage](../../models/shared/sourcefileschemasproviderstorageprovider7storage.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/signinviagoogleoauth.md b/docs/models/shared/signinviagoogleoauth.md index 195851c5..c752c0f7 100644 --- a/docs/models/shared/signinviagoogleoauth.md +++ b/docs/models/shared/signinviagoogleoauth.md @@ -9,5 +9,5 @@ For these scenario user only needs to give permission to read Google Directory d | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | `client_id` | *str* | :heavy_check_mark: | The Client ID of the developer application. | | `client_secret` | *str* | :heavy_check_mark: | The Client Secret of the developer application. | -| `credentials_title` | [Optional[shared.SourceGoogleDirectoryCredentialsTitle]](../../models/shared/sourcegoogledirectorycredentialstitle.md) | :heavy_minus_sign: | Authentication Scenario | -| `refresh_token` | *str* | :heavy_check_mark: | The Token for obtaining a new access token. | \ No newline at end of file +| `refresh_token` | *str* | :heavy_check_mark: | The Token for obtaining a new access token. | +| `credentials_title` | [Optional[shared.SourceGoogleDirectoryCredentialsTitle]](../../models/shared/sourcegoogledirectorycredentialstitle.md) | :heavy_minus_sign: | Authentication Scenario | \ No newline at end of file diff --git a/docs/models/shared/singlestoreaccesstoken.md b/docs/models/shared/singlestoreaccesstoken.md index 30cef839..ae58f6cb 100644 --- a/docs/models/shared/singlestoreaccesstoken.md +++ b/docs/models/shared/singlestoreaccesstoken.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | -| `auth_type` | [shared.SourceCartSchemasAuthType](../../models/shared/sourcecartschemasauthtype.md) | :heavy_check_mark: | N/A | -| `store_name` | *str* | :heavy_check_mark: | The name of Cart.com Online Store. All API URLs start with https://[mystorename.com]/api/v1/, where [mystorename.com] is the domain name of your store. | \ No newline at end of file +| `store_name` | *str* | :heavy_check_mark: | The name of Cart.com Online Store. All API URLs start with https://[mystorename.com]/api/v1/, where [mystorename.com] is the domain name of your store. | +| `auth_type` | [shared.SourceCartSchemasAuthType](../../models/shared/sourcecartschemasauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceaha.md b/docs/models/shared/sourceaha.md index 4eb8da2e..04dfae38 100644 --- a/docs/models/shared/sourceaha.md +++ b/docs/models/shared/sourceaha.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | API Key | -| `source_type` | [shared.Aha](../../models/shared/aha.md) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | URL | \ No newline at end of file +| `url` | *str* | :heavy_check_mark: | URL | +| `source_type` | [shared.Aha](../../models/shared/aha.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceaircall.md b/docs/models/shared/sourceaircall.md index baf301ac..f6b55284 100644 --- a/docs/models/shared/sourceaircall.md +++ b/docs/models/shared/sourceaircall.md @@ -7,5 +7,5 @@ | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `api_id` | *str* | :heavy_check_mark: | App ID found at settings https://dashboard.aircall.io/integrations/api-keys | | | `api_token` | *str* | :heavy_check_mark: | App token found at settings (Ref- https://dashboard.aircall.io/integrations/api-keys) | | -| `source_type` | [shared.Aircall](../../models/shared/aircall.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Date time filter for incremental filter, Specify which date to extract from. | 2022-03-01T00:00:00.000Z | \ No newline at end of file +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Date time filter for incremental filter, Specify which date to extract from. | 2022-03-01T00:00:00.000Z | +| `source_type` | [shared.Aircall](../../models/shared/aircall.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceairtableoauth20.md b/docs/models/shared/sourceairtableoauth20.md index 48bb59be..d72b521d 100644 --- a/docs/models/shared/sourceairtableoauth20.md +++ b/docs/models/shared/sourceairtableoauth20.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `access_token` | *Optional[str]* | :heavy_minus_sign: | Access Token for making authenticated requests. | -| `auth_method` | [Optional[shared.SourceAirtableSchemasAuthMethod]](../../models/shared/sourceairtableschemasauthmethod.md) | :heavy_minus_sign: | N/A | | `client_id` | *str* | :heavy_check_mark: | The client ID of the Airtable developer application. | | `client_secret` | *str* | :heavy_check_mark: | The client secret the Airtable developer application. | | `refresh_token` | *str* | :heavy_check_mark: | The key to refresh the expired access token. | +| `access_token` | *Optional[str]* | :heavy_minus_sign: | Access Token for making authenticated requests. | +| `auth_method` | [Optional[shared.SourceAirtableSchemasAuthMethod]](../../models/shared/sourceairtableschemasauthmethod.md) | :heavy_minus_sign: | N/A | | `token_expiry_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The date-time when the access token should be refreshed. | \ No newline at end of file diff --git a/docs/models/shared/sourcealloydb.md b/docs/models/shared/sourcealloydb.md index be216b5b..8c379606 100644 --- a/docs/models/shared/sourcealloydb.md +++ b/docs/models/shared/sourcealloydb.md @@ -7,6 +7,7 @@ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `database` | *str* | :heavy_check_mark: | Name of the database. | | | `host` | *str* | :heavy_check_mark: | Hostname of the database. | | +| `username` | *str* | :heavy_check_mark: | Username to access the database. | | | `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (Eg. key1=value1&key2=value2&key3=value3). For more information read about JDBC URL parameters. | | | `password` | *Optional[str]* | :heavy_minus_sign: | Password associated with the username. | | | `port` | *Optional[int]* | :heavy_minus_sign: | Port of the database. | 5432 | @@ -14,5 +15,4 @@ | `schemas` | List[*str*] | :heavy_minus_sign: | The list of schemas (case sensitive) to sync from. Defaults to public. | | | `source_type` | [shared.Alloydb](../../models/shared/alloydb.md) | :heavy_check_mark: | N/A | | | `ssl_mode` | [Optional[Union[shared.SourceAlloydbDisable, shared.SourceAlloydbAllow, shared.SourceAlloydbPrefer, shared.SourceAlloydbRequire, shared.SourceAlloydbVerifyCa, shared.SourceAlloydbVerifyFull]]](../../models/shared/sourcealloydbsslmodes.md) | :heavy_minus_sign: | SSL connection modes.
    Read more in the docs. | | -| `tunnel_method` | [Optional[Union[shared.SourceAlloydbNoTunnel, shared.SourceAlloydbSSHKeyAuthentication, shared.SourceAlloydbPasswordAuthentication]]](../../models/shared/sourcealloydbsshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | -| `username` | *str* | :heavy_check_mark: | Username to access the database. | | \ No newline at end of file +| `tunnel_method` | [Optional[Union[shared.SourceAlloydbNoTunnel, shared.SourceAlloydbSSHKeyAuthentication, shared.SourceAlloydbPasswordAuthentication]]](../../models/shared/sourcealloydbsshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | \ No newline at end of file diff --git a/docs/models/shared/sourcealloydbpasswordauthentication.md b/docs/models/shared/sourcealloydbpasswordauthentication.md index bc539389..517bd10f 100644 --- a/docs/models/shared/sourcealloydbpasswordauthentication.md +++ b/docs/models/shared/sourcealloydbpasswordauthentication.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | -| `tunnel_method` | [shared.SourceAlloydbSchemasTunnelMethodTunnelMethod](../../models/shared/sourcealloydbschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | | `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host | | -| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | \ No newline at end of file +| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [shared.SourceAlloydbSchemasTunnelMethodTunnelMethod](../../models/shared/sourcealloydbschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/sourcealloydbsshkeyauthentication.md b/docs/models/shared/sourcealloydbsshkeyauthentication.md index 1e737aec..b7d3c77c 100644 --- a/docs/models/shared/sourcealloydbsshkeyauthentication.md +++ b/docs/models/shared/sourcealloydbsshkeyauthentication.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `ssh_key` | *str* | :heavy_check_mark: | OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa ) | | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | +| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | | `tunnel_method` | [shared.SourceAlloydbSchemasTunnelMethod](../../models/shared/sourcealloydbschemastunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and ssh key | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | -| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | \ No newline at end of file +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/sourcealloydbverifyca.md b/docs/models/shared/sourcealloydbverifyca.md index 0223029d..b344b3cb 100644 --- a/docs/models/shared/sourcealloydbverifyca.md +++ b/docs/models/shared/sourcealloydbverifyca.md @@ -7,8 +7,8 @@ Always require encryption and verifies that the source database server has a val | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `ca_certificate` | *str* | :heavy_check_mark: | CA certificate | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `client_certificate` | *Optional[str]* | :heavy_minus_sign: | Client certificate | | `client_key` | *Optional[str]* | :heavy_minus_sign: | Client key | | `client_key_password` | *Optional[str]* | :heavy_minus_sign: | Password for keystorage. If you do not add it - the password will be generated automatically. | diff --git a/docs/models/shared/sourcealloydbverifyfull.md b/docs/models/shared/sourcealloydbverifyfull.md index 9ffd1c84..cc9bd7dd 100644 --- a/docs/models/shared/sourcealloydbverifyfull.md +++ b/docs/models/shared/sourcealloydbverifyfull.md @@ -7,8 +7,8 @@ This is the most secure mode. Always require encryption and verifies the identit | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `ca_certificate` | *str* | :heavy_check_mark: | CA certificate | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `client_certificate` | *Optional[str]* | :heavy_minus_sign: | Client certificate | | `client_key` | *Optional[str]* | :heavy_minus_sign: | Client key | | `client_key_password` | *Optional[str]* | :heavy_minus_sign: | Password for keystorage. If you do not add it - the password will be generated automatically. | diff --git a/docs/models/shared/sourceamazonads.md b/docs/models/shared/sourceamazonads.md index e903dd99..25a40821 100644 --- a/docs/models/shared/sourceamazonads.md +++ b/docs/models/shared/sourceamazonads.md @@ -5,13 +5,13 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth_type` | [Optional[shared.SourceAmazonAdsAuthType]](../../models/shared/sourceamazonadsauthtype.md) | :heavy_minus_sign: | N/A | | | `client_id` | *str* | :heavy_check_mark: | The client ID of your Amazon Ads developer application. See the docs for more information. | | | `client_secret` | *str* | :heavy_check_mark: | The client secret of your Amazon Ads developer application. See the docs for more information. | | +| `refresh_token` | *str* | :heavy_check_mark: | Amazon Ads refresh token. See the docs for more information on how to obtain this token. | | +| `auth_type` | [Optional[shared.SourceAmazonAdsAuthType]](../../models/shared/sourceamazonadsauthtype.md) | :heavy_minus_sign: | N/A | | | `look_back_window` | *Optional[int]* | :heavy_minus_sign: | The amount of days to go back in time to get the updated data from Amazon Ads | 3 | | `marketplace_ids` | List[*str*] | :heavy_minus_sign: | Marketplace IDs you want to fetch data for. Note: If Profile IDs are also selected, profiles will be selected if they match the Profile ID OR the Marketplace ID. | | | `profiles` | List[*int*] | :heavy_minus_sign: | Profile IDs you want to fetch data for. See docs for more details. Note: If Marketplace IDs are also selected, profiles will be selected if they match the Profile ID OR the Marketplace ID. | | -| `refresh_token` | *str* | :heavy_check_mark: | Amazon Ads refresh token. See the docs for more information on how to obtain this token. | | | `region` | [Optional[shared.Region]](../../models/shared/region.md) | :heavy_minus_sign: | Region to pull data from (EU/NA/FE). See docs for more details. | | | `report_record_types` | List[[shared.ReportRecordTypes](../../models/shared/reportrecordtypes.md)] | :heavy_minus_sign: | Optional configuration which accepts an array of string of record types. Leave blank for default behaviour to pull all report types. Use this config option only if you want to pull specific report type(s). See docs for more details | | | `source_type` | [shared.SourceAmazonAdsAmazonAds](../../models/shared/sourceamazonadsamazonads.md) | :heavy_check_mark: | N/A | | diff --git a/docs/models/shared/sourceamazonsellerpartner.md b/docs/models/shared/sourceamazonsellerpartner.md index 24f62eab..d8f802b5 100644 --- a/docs/models/shared/sourceamazonsellerpartner.md +++ b/docs/models/shared/sourceamazonsellerpartner.md @@ -5,13 +5,13 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `lwa_app_id` | *str* | :heavy_check_mark: | Your Login with Amazon Client ID. | | +| `lwa_client_secret` | *str* | :heavy_check_mark: | Your Login with Amazon Client Secret. | | +| `refresh_token` | *str* | :heavy_check_mark: | The Refresh Token obtained via OAuth flow authorization. | | | `account_type` | [Optional[shared.AWSSellerPartnerAccountType]](../../models/shared/awssellerpartneraccounttype.md) | :heavy_minus_sign: | Type of the Account you're going to authorize the Airbyte application by | | | `auth_type` | [Optional[shared.SourceAmazonSellerPartnerAuthType]](../../models/shared/sourceamazonsellerpartnerauthtype.md) | :heavy_minus_sign: | N/A | | | `aws_environment` | [Optional[shared.AWSEnvironment]](../../models/shared/awsenvironment.md) | :heavy_minus_sign: | Select the AWS Environment. | | -| `lwa_app_id` | *str* | :heavy_check_mark: | Your Login with Amazon Client ID. | | -| `lwa_client_secret` | *str* | :heavy_check_mark: | Your Login with Amazon Client Secret. | | | `period_in_days` | *Optional[int]* | :heavy_minus_sign: | For syncs spanning a large date range, this option is used to request data in a smaller fixed window to improve sync reliability. This time window can be configured granularly by day. | | -| `refresh_token` | *str* | :heavy_check_mark: | The Refresh Token obtained via OAuth flow authorization. | | | `region` | [Optional[shared.AWSRegion]](../../models/shared/awsregion.md) | :heavy_minus_sign: | Select the AWS Region. | | | `replication_end_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data after this date will not be replicated. | 2017-01-25T00:00:00Z | | `replication_start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. If start date is not provided, the date 2 years ago from today will be used. | 2017-01-25T00:00:00Z | diff --git a/docs/models/shared/sourceamazonsqs.md b/docs/models/shared/sourceamazonsqs.md index df752233..b9f95a15 100644 --- a/docs/models/shared/sourceamazonsqs.md +++ b/docs/models/shared/sourceamazonsqs.md @@ -5,13 +5,13 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `queue_url` | *str* | :heavy_check_mark: | URL of the SQS Queue | https://sqs.eu-west-1.amazonaws.com/1234567890/my-example-queue | +| `region` | [shared.SourceAmazonSqsAWSRegion](../../models/shared/sourceamazonsqsawsregion.md) | :heavy_check_mark: | AWS Region of the SQS Queue | | | `access_key` | *Optional[str]* | :heavy_minus_sign: | The Access Key ID of the AWS IAM Role to use for pulling messages | xxxxxHRNxxx3TBxxxxxx | | `attributes_to_return` | *Optional[str]* | :heavy_minus_sign: | Comma separated list of Mesage Attribute names to return | attr1,attr2 | | `delete_messages` | *Optional[bool]* | :heavy_minus_sign: | If Enabled, messages will be deleted from the SQS Queue after being read. If Disabled, messages are left in the queue and can be read more than once. WARNING: Enabling this option can result in data loss in cases of failure, use with caution, see documentation for more detail. | | | `max_batch_size` | *Optional[int]* | :heavy_minus_sign: | Max amount of messages to get in one batch (10 max) | 5 | | `max_wait_time` | *Optional[int]* | :heavy_minus_sign: | Max amount of time in seconds to wait for messages in a single poll (20 max) | 5 | -| `queue_url` | *str* | :heavy_check_mark: | URL of the SQS Queue | https://sqs.eu-west-1.amazonaws.com/1234567890/my-example-queue | -| `region` | [shared.SourceAmazonSqsAWSRegion](../../models/shared/sourceamazonsqsawsregion.md) | :heavy_check_mark: | AWS Region of the SQS Queue | | | `secret_key` | *Optional[str]* | :heavy_minus_sign: | The Secret Key of the AWS IAM Role to use for pulling messages | hu+qE5exxxxT6o/ZrKsxxxxxxBhxxXLexxxxxVKz | | `source_type` | [shared.AmazonSqs](../../models/shared/amazonsqs.md) | :heavy_check_mark: | N/A | | | `visibility_timeout` | *Optional[int]* | :heavy_minus_sign: | Modify the Visibility Timeout of the individual message from the Queue's default (seconds). | 15 | \ No newline at end of file diff --git a/docs/models/shared/sourceamplitude.md b/docs/models/shared/sourceamplitude.md index 6a4708a7..de0602df 100644 --- a/docs/models/shared/sourceamplitude.md +++ b/docs/models/shared/sourceamplitude.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Amplitude API Key. See the setup guide for more information on how to obtain this key. | | +| `secret_key` | *str* | :heavy_check_mark: | Amplitude Secret Key. See the setup guide for more information on how to obtain this key. | | +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated. | 2021-01-25T00:00:00Z | | `data_region` | [Optional[shared.DataRegion]](../../models/shared/dataregion.md) | :heavy_minus_sign: | Amplitude data region server | | | `request_time_range` | *Optional[int]* | :heavy_minus_sign: | According to Considerations too big time range in request can cause a timeout error. In this case, set shorter time interval in hours. | | -| `secret_key` | *str* | :heavy_check_mark: | Amplitude Secret Key. See the setup guide for more information on how to obtain this key. | | -| `source_type` | [shared.Amplitude](../../models/shared/amplitude.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated. | 2021-01-25T00:00:00Z | \ No newline at end of file +| `source_type` | [shared.Amplitude](../../models/shared/amplitude.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceapifydataset.md b/docs/models/shared/sourceapifydataset.md index 01fb14ef..e68ec127 100644 --- a/docs/models/shared/sourceapifydataset.md +++ b/docs/models/shared/sourceapifydataset.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `dataset_id` | *str* | :heavy_check_mark: | ID of the dataset you would like to load to Airbyte. In Apify Console, you can view your datasets in the Storage section under the Datasets tab after you login. See the Apify Docs for more information. | rHuMdwm6xCFt6WiGU | -| `source_type` | [shared.ApifyDataset](../../models/shared/apifydataset.md) | :heavy_check_mark: | N/A | | -| `token` | *str* | :heavy_check_mark: | Personal API token of your Apify account. In Apify Console, you can find your API token in the Settings section under the Integrations tab after you login. See the Apify Docs for more information. | apify_api_PbVwb1cBbuvbfg2jRmAIHZKgx3NQyfEMG7uk | \ No newline at end of file +| `token` | *str* | :heavy_check_mark: | Personal API token of your Apify account. In Apify Console, you can find your API token in the Settings section under the Integrations tab after you login. See the Apify Docs for more information. | apify_api_PbVwb1cBbuvbfg2jRmAIHZKgx3NQyfEMG7uk | +| `source_type` | [shared.ApifyDataset](../../models/shared/apifydataset.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceazureblobstorage.md b/docs/models/shared/sourceazureblobstorage.md index 0ddc897f..d8407a60 100644 --- a/docs/models/shared/sourceazureblobstorage.md +++ b/docs/models/shared/sourceazureblobstorage.md @@ -11,7 +11,7 @@ because it is responsible for converting legacy Azure Blob Storage v0 configs in | `azure_blob_storage_account_key` | *str* | :heavy_check_mark: | The Azure blob storage account key. | Z8ZkZpteggFx394vm+PJHnGTvdRncaYS+JhLKdj789YNmD+iyGTnG+PV+POiuYNhBg/ACS+LKjd%4FG3FHGN12Nd== | | `azure_blob_storage_account_name` | *str* | :heavy_check_mark: | The account's name of the Azure Blob Storage. | airbyte5storage | | `azure_blob_storage_container_name` | *str* | :heavy_check_mark: | The name of the Azure blob storage container. | airbytetescontainername | +| `streams` | List[[shared.FileBasedStreamConfig](../../models/shared/filebasedstreamconfig.md)] | :heavy_check_mark: | Each instance of this configuration defines a stream. Use this to define which files belong in the stream, their format, and how they should be parsed and validated. When sending data to warehouse destination such as Snowflake or BigQuery, each stream is a separate table. | | | `azure_blob_storage_endpoint` | *Optional[str]* | :heavy_minus_sign: | This is Azure Blob Storage endpoint domain name. Leave default value (or leave it empty if run container from command line) to use Microsoft native from example. | blob.core.windows.net | | `source_type` | [shared.SourceAzureBlobStorageAzureBlobStorage](../../models/shared/sourceazureblobstorageazureblobstorage.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | UTC date and time in the format 2017-01-25T00:00:00.000000Z. Any file modified before this date will not be replicated. | 2021-01-01T00:00:00.000000Z | -| `streams` | List[[shared.FileBasedStreamConfig](../../models/shared/filebasedstreamconfig.md)] | :heavy_check_mark: | Each instance of this configuration defines a stream. Use this to define which files belong in the stream, their format, and how they should be parsed and validated. When sending data to warehouse destination such as Snowflake or BigQuery, each stream is a separate table. | | \ No newline at end of file +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | UTC date and time in the format 2017-01-25T00:00:00.000000Z. Any file modified before this date will not be replicated. | 2021-01-01T00:00:00.000000Z | \ No newline at end of file diff --git a/docs/models/shared/sourceazuretable.md b/docs/models/shared/sourceazuretable.md index 2218c138..49ff7ded 100644 --- a/docs/models/shared/sourceazuretable.md +++ b/docs/models/shared/sourceazuretable.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `source_type` | [shared.AzureTable](../../models/shared/azuretable.md) | :heavy_check_mark: | N/A | | | `storage_access_key` | *str* | :heavy_check_mark: | Azure Table Storage Access Key. See the docs for more information on how to obtain this key. | | | `storage_account_name` | *str* | :heavy_check_mark: | The name of your storage account. | | +| `source_type` | [shared.AzureTable](../../models/shared/azuretable.md) | :heavy_check_mark: | N/A | | | `storage_endpoint_suffix` | *Optional[str]* | :heavy_minus_sign: | Azure Table Storage service account URL suffix. See the docs for more information on how to obtain endpoint suffix | core.windows.net | \ No newline at end of file diff --git a/docs/models/shared/sourcebamboohr.md b/docs/models/shared/sourcebamboohr.md index 51c5ce39..c2381cb3 100644 --- a/docs/models/shared/sourcebamboohr.md +++ b/docs/models/shared/sourcebamboohr.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Api key of bamboo hr | +| `subdomain` | *str* | :heavy_check_mark: | Sub Domain of bamboo hr | | `custom_reports_fields` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of fields to include in custom reports. | | `custom_reports_include_default_fields` | *Optional[bool]* | :heavy_minus_sign: | If true, the custom reports endpoint will include the default fields defined here: https://documentation.bamboohr.com/docs/list-of-field-names. | -| `source_type` | [shared.BambooHr](../../models/shared/bamboohr.md) | :heavy_check_mark: | N/A | -| `subdomain` | *str* | :heavy_check_mark: | Sub Domain of bamboo hr | \ No newline at end of file +| `source_type` | [shared.BambooHr](../../models/shared/bamboohr.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcebigquery.md b/docs/models/shared/sourcebigquery.md index d4e65c20..542225cb 100644 --- a/docs/models/shared/sourcebigquery.md +++ b/docs/models/shared/sourcebigquery.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `credentials_json` | *str* | :heavy_check_mark: | The contents of your Service Account Key JSON file. See the docs for more information on how to obtain this key. | -| `dataset_id` | *Optional[str]* | :heavy_minus_sign: | The dataset ID to search for tables and views. If you are only loading data from one dataset, setting this option could result in much faster schema discovery. | | `project_id` | *str* | :heavy_check_mark: | The GCP project ID for the project containing the target BigQuery dataset. | +| `dataset_id` | *Optional[str]* | :heavy_minus_sign: | The dataset ID to search for tables and views. If you are only loading data from one dataset, setting this option could result in much faster schema discovery. | | `source_type` | [shared.SourceBigqueryBigquery](../../models/shared/sourcebigquerybigquery.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcebingads.md b/docs/models/shared/sourcebingads.md index 64b7359b..c7ce408b 100644 --- a/docs/models/shared/sourcebingads.md +++ b/docs/models/shared/sourcebingads.md @@ -5,14 +5,14 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `client_id` | *str* | :heavy_check_mark: | The Client ID of your Microsoft Advertising developer application. | +| `developer_token` | *str* | :heavy_check_mark: | Developer token associated with user. See more info in the docs. | +| `refresh_token` | *str* | :heavy_check_mark: | Refresh Token to renew the expired Access Token. | | `account_names` | List[[shared.AccountNames](../../models/shared/accountnames.md)] | :heavy_minus_sign: | Predicates that will be used to sync data by specific accounts. | | `auth_method` | [Optional[shared.AuthMethod]](../../models/shared/authmethod.md) | :heavy_minus_sign: | N/A | -| `client_id` | *str* | :heavy_check_mark: | The Client ID of your Microsoft Advertising developer application. | | `client_secret` | *Optional[str]* | :heavy_minus_sign: | The Client Secret of your Microsoft Advertising developer application. | | `custom_reports` | List[[shared.CustomReportConfig](../../models/shared/customreportconfig.md)] | :heavy_minus_sign: | You can add your Custom Bing Ads report by creating one. | -| `developer_token` | *str* | :heavy_check_mark: | Developer token associated with user. See more info in the docs. | | `lookback_window` | *Optional[int]* | :heavy_minus_sign: | Also known as attribution or conversion window. How far into the past to look for records (in days). If your conversion window has an hours/minutes granularity, round it up to the number of days exceeding. Used only for performance report streams in incremental mode without specified Reports Start Date. | -| `refresh_token` | *str* | :heavy_check_mark: | Refresh Token to renew the expired Access Token. | | `reports_start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The start date from which to begin replicating report data. Any data generated before this date will not be replicated in reports. This is a UTC date in YYYY-MM-DD format. If not set, data from previous and current calendar year will be replicated. | | `source_type` | [shared.SourceBingAdsBingAds](../../models/shared/sourcebingadsbingads.md) | :heavy_check_mark: | N/A | | `tenant_id` | *Optional[str]* | :heavy_minus_sign: | The Tenant ID of your Microsoft Advertising developer application. Set this to "common" unless you know you need a different value. | \ No newline at end of file diff --git a/docs/models/shared/sourcebraze.md b/docs/models/shared/sourcebraze.md index 15a56fa9..932e1c41 100644 --- a/docs/models/shared/sourcebraze.md +++ b/docs/models/shared/sourcebraze.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Braze REST API key | -| `source_type` | [shared.Braze](../../models/shared/braze.md) | :heavy_check_mark: | N/A | | `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | Rows after this date will be synced | -| `url` | *str* | :heavy_check_mark: | Braze REST API endpoint | \ No newline at end of file +| `url` | *str* | :heavy_check_mark: | Braze REST API endpoint | +| `source_type` | [shared.Braze](../../models/shared/braze.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcecart.md b/docs/models/shared/sourcecart.md index 323d8c84..b589c35f 100644 --- a/docs/models/shared/sourcecart.md +++ b/docs/models/shared/sourcecart.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| `start_date` | *str* | :heavy_check_mark: | The date from which you'd like to replicate the data | 2021-01-01T00:00:00Z | | `credentials` | [Optional[Union[shared.CentralAPIRouter, shared.SingleStoreAccessToken]]](../../models/shared/sourcecartauthorizationmethod.md) | :heavy_minus_sign: | N/A | | -| `source_type` | [shared.Cart](../../models/shared/cart.md) | :heavy_check_mark: | N/A | | -| `start_date` | *str* | :heavy_check_mark: | The date from which you'd like to replicate the data | 2021-01-01T00:00:00Z | \ No newline at end of file +| `source_type` | [shared.Cart](../../models/shared/cart.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcechargebee.md b/docs/models/shared/sourcechargebee.md index 132a8ba0..742a6339 100644 --- a/docs/models/shared/sourcechargebee.md +++ b/docs/models/shared/sourcechargebee.md @@ -8,5 +8,5 @@ | `product_catalog` | [shared.ProductCatalog](../../models/shared/productcatalog.md) | :heavy_check_mark: | Product Catalog version of your Chargebee site. Instructions on how to find your version you may find here under `API Version` section. | | | `site` | *str* | :heavy_check_mark: | The site prefix for your Chargebee instance. | airbyte-test | | `site_api_key` | *str* | :heavy_check_mark: | Chargebee API Key. See the docs for more information on how to obtain this key. | | -| `source_type` | [shared.Chargebee](../../models/shared/chargebee.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated. | 2021-01-25T00:00:00Z | \ No newline at end of file +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated. | 2021-01-25T00:00:00Z | +| `source_type` | [shared.Chargebee](../../models/shared/chargebee.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcechartmogul.md b/docs/models/shared/sourcechartmogul.md index 2f8b73bd..b5984106 100644 --- a/docs/models/shared/sourcechartmogul.md +++ b/docs/models/shared/sourcechartmogul.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Your Chartmogul API key. See the docs for info on how to obtain this. | | -| `source_type` | [shared.Chartmogul](../../models/shared/chartmogul.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. When feasible, any data before this date will not be replicated. | 2017-01-25T00:00:00Z | \ No newline at end of file +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. When feasible, any data before this date will not be replicated. | 2017-01-25T00:00:00Z | +| `source_type` | [shared.Chartmogul](../../models/shared/chartmogul.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceclickhouse.md b/docs/models/shared/sourceclickhouse.md index 0183d347..73bc687a 100644 --- a/docs/models/shared/sourceclickhouse.md +++ b/docs/models/shared/sourceclickhouse.md @@ -7,9 +7,9 @@ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `database` | *str* | :heavy_check_mark: | The name of the database. | default | | `host` | *str* | :heavy_check_mark: | The host endpoint of the Clickhouse cluster. | | +| `username` | *str* | :heavy_check_mark: | The username which is used to access the database. | | | `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (Eg. key1=value1&key2=value2&key3=value3). For more information read about JDBC URL parameters. | | | `password` | *Optional[str]* | :heavy_minus_sign: | The password associated with this username. | | | `port` | *Optional[int]* | :heavy_minus_sign: | The port of the database. | 8123 | | `source_type` | [shared.SourceClickhouseClickhouse](../../models/shared/sourceclickhouseclickhouse.md) | :heavy_check_mark: | N/A | | -| `tunnel_method` | [Optional[Union[shared.SourceClickhouseNoTunnel, shared.SourceClickhouseSSHKeyAuthentication, shared.SourceClickhousePasswordAuthentication]]](../../models/shared/sourceclickhousesshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | -| `username` | *str* | :heavy_check_mark: | The username which is used to access the database. | | \ No newline at end of file +| `tunnel_method` | [Optional[Union[shared.SourceClickhouseNoTunnel, shared.SourceClickhouseSSHKeyAuthentication, shared.SourceClickhousePasswordAuthentication]]](../../models/shared/sourceclickhousesshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | \ No newline at end of file diff --git a/docs/models/shared/sourceclickhousepasswordauthentication.md b/docs/models/shared/sourceclickhousepasswordauthentication.md index 262cd961..30db4460 100644 --- a/docs/models/shared/sourceclickhousepasswordauthentication.md +++ b/docs/models/shared/sourceclickhousepasswordauthentication.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | -| `tunnel_method` | [shared.SourceClickhouseSchemasTunnelMethodTunnelMethod](../../models/shared/sourceclickhouseschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | | `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host | | -| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | \ No newline at end of file +| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [shared.SourceClickhouseSchemasTunnelMethodTunnelMethod](../../models/shared/sourceclickhouseschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/sourceclickhousesshkeyauthentication.md b/docs/models/shared/sourceclickhousesshkeyauthentication.md index b50f8283..eb5ae078 100644 --- a/docs/models/shared/sourceclickhousesshkeyauthentication.md +++ b/docs/models/shared/sourceclickhousesshkeyauthentication.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `ssh_key` | *str* | :heavy_check_mark: | OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa ) | | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | +| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | | `tunnel_method` | [shared.SourceClickhouseSchemasTunnelMethod](../../models/shared/sourceclickhouseschemastunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and ssh key | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | -| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | \ No newline at end of file +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/sourceclockify.md b/docs/models/shared/sourceclockify.md index a07edee2..a3fad4fc 100644 --- a/docs/models/shared/sourceclockify.md +++ b/docs/models/shared/sourceclockify.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | You can get your api access_key here This API is Case Sensitive. | +| `workspace_id` | *str* | :heavy_check_mark: | WorkSpace Id | | `api_url` | *Optional[str]* | :heavy_minus_sign: | The URL for the Clockify API. This should only need to be modified if connecting to an enterprise version of Clockify. | -| `source_type` | [shared.Clockify](../../models/shared/clockify.md) | :heavy_check_mark: | N/A | -| `workspace_id` | *str* | :heavy_check_mark: | WorkSpace Id | \ No newline at end of file +| `source_type` | [shared.Clockify](../../models/shared/clockify.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcecoinapi.md b/docs/models/shared/sourcecoinapi.md index 9d256e0a..98a2527c 100644 --- a/docs/models/shared/sourcecoinapi.md +++ b/docs/models/shared/sourcecoinapi.md @@ -6,10 +6,10 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | API Key | | +| `period` | *str* | :heavy_check_mark: | The period to use. See the documentation for a list. https://docs.coinapi.io/#list-all-periods-get | 5SEC | +| `start_date` | *str* | :heavy_check_mark: | The start date in ISO 8601 format. | 2019-01-01T00:00:00 | +| `symbol_id` | *str* | :heavy_check_mark: | The symbol ID to use. See the documentation for a list.
    https://docs.coinapi.io/#list-all-symbols-get
    | | | `end_date` | *Optional[str]* | :heavy_minus_sign: | The end date in ISO 8601 format. If not supplied, data will be returned
    from the start date to the current time, or when the count of result
    elements reaches its limit.
    | 2019-01-01T00:00:00 | | `environment` | [Optional[shared.Environment]](../../models/shared/environment.md) | :heavy_minus_sign: | The environment to use. Either sandbox or production.
    | | | `limit` | *Optional[int]* | :heavy_minus_sign: | The maximum number of elements to return. If not supplied, the default
    is 100. For numbers larger than 100, each 100 items is counted as one
    request for pricing purposes. Maximum value is 100000.
    | | -| `period` | *str* | :heavy_check_mark: | The period to use. See the documentation for a list. https://docs.coinapi.io/#list-all-periods-get | 5SEC | -| `source_type` | [shared.CoinAPI](../../models/shared/coinapi.md) | :heavy_check_mark: | N/A | | -| `start_date` | *str* | :heavy_check_mark: | The start date in ISO 8601 format. | 2019-01-01T00:00:00 | -| `symbol_id` | *str* | :heavy_check_mark: | The symbol ID to use. See the documentation for a list.
    https://docs.coinapi.io/#list-all-symbols-get
    | | \ No newline at end of file +| `source_type` | [shared.CoinAPI](../../models/shared/coinapi.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceconfigcat.md b/docs/models/shared/sourceconfigcat.md index 5db5dcdb..262387ed 100644 --- a/docs/models/shared/sourceconfigcat.md +++ b/docs/models/shared/sourceconfigcat.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `password` | *str* | :heavy_check_mark: | Basic auth password. See here. | -| `source_type` | [shared.Configcat](../../models/shared/configcat.md) | :heavy_check_mark: | N/A | -| `username` | *str* | :heavy_check_mark: | Basic auth user name. See here. | \ No newline at end of file +| `username` | *str* | :heavy_check_mark: | Basic auth user name. See here. | +| `source_type` | [shared.Configcat](../../models/shared/configcat.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcecreaterequest.md b/docs/models/shared/sourcecreaterequest.md index 55757852..1114863a 100644 --- a/docs/models/shared/sourcecreaterequest.md +++ b/docs/models/shared/sourcecreaterequest.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `configuration` | [Union[shared.SourceAha, shared.SourceAircall, shared.SourceAirtable, shared.SourceAlloydb, shared.SourceAmazonAds, shared.SourceAmazonSellerPartner, shared.SourceAmazonSqs, shared.SourceAmplitude, shared.SourceApifyDataset, shared.SourceAppfollow, shared.SourceAsana, shared.SourceAuth0, shared.SourceAwsCloudtrail, shared.SourceAzureBlobStorage, shared.SourceAzureTable, shared.SourceBambooHr, shared.SourceBigquery, shared.SourceBingAds, shared.SourceBraintree, shared.SourceBraze, shared.SourceCart, shared.SourceChargebee, shared.SourceChartmogul, shared.SourceClickhouse, shared.SourceClickupAPI, shared.SourceClockify, shared.SourceCloseCom, shared.SourceCoda, shared.SourceCoinAPI, shared.SourceCoinmarketcap, shared.SourceConfigcat, shared.SourceConfluence, shared.SourceConvex, shared.SourceDatascope, shared.SourceDelighted, shared.SourceDixa, shared.SourceDockerhub, shared.SourceDremio, shared.SourceDynamodb, Union[shared.ContinuousFeed], shared.SourceEmailoctopus, shared.SourceExchangeRates, shared.SourceFacebookMarketing, shared.SourceFaker, shared.SourceFauna, shared.SourceFile, shared.SourceFirebolt, shared.SourceFreshcaller, shared.SourceFreshdesk, shared.SourceFreshsales, shared.SourceGainsightPx, shared.SourceGcs, shared.SourceGetlago, shared.SourceGithub, shared.SourceGitlab, shared.SourceGlassfrog, shared.SourceGnews, shared.SourceGoogleAds, shared.SourceGoogleAnalyticsDataAPI, shared.SourceGoogleDirectory, shared.SourceGoogleDrive, shared.SourceGooglePagespeedInsights, shared.SourceGoogleSearchConsole, shared.SourceGoogleSheets, shared.SourceGoogleWebfonts, shared.SourceGoogleWorkspaceAdminReports, shared.SourceGreenhouse, shared.SourceGridly, shared.SourceHarvest, shared.SourceHubplanner, shared.SourceHubspot, shared.SourceInsightly, shared.SourceInstagram, shared.SourceInstatus, shared.SourceIntercom, shared.SourceIp2whois, shared.SourceIterable, shared.SourceJira, shared.SourceK6Cloud, shared.SourceKlarna, shared.SourceKlaviyo, shared.SourceKustomerSinger, shared.SourceKyve, shared.SourceLaunchdarkly, shared.SourceLemlist, shared.SourceLeverHiring, shared.SourceLinkedinAds, shared.SourceLinkedinPages, shared.SourceLinnworks, shared.SourceLokalise, shared.SourceMailchimp, shared.SourceMailgun, shared.SourceMailjetSms, shared.SourceMarketo, shared.SourceMetabase, shared.SourceMicrosoftTeams, shared.SourceMixpanel, shared.SourceMonday, shared.SourceMongodbInternalPoc, shared.SourceMongodbV2, shared.SourceMssql, shared.SourceMyHours, shared.SourceMysql, shared.SourceNetsuite, shared.SourceNotion, shared.SourceNytimes, shared.SourceOkta, shared.SourceOmnisend, shared.SourceOnesignal, shared.SourceOracle, shared.SourceOrb, shared.SourceOrbit, shared.SourceOutbrainAmplify, shared.SourceOutreach, shared.SourcePaypalTransaction, shared.SourcePaystack, shared.SourcePendo, shared.SourcePersistiq, shared.SourcePexelsAPI, shared.SourcePinterest, shared.SourcePipedrive, shared.SourcePocket, shared.SourcePokeapi, shared.SourcePolygonStockAPI, shared.SourcePostgres, shared.SourcePosthog, shared.SourcePostmarkapp, shared.SourcePrestashop, shared.SourcePunkAPI, shared.SourcePypi, shared.SourceQualaroo, shared.SourceQuickbooks, shared.SourceRailz, shared.SourceRecharge, shared.SourceRecreation, shared.SourceRecruitee, shared.SourceRecurly, shared.SourceRedshift, shared.SourceRetently, shared.SourceRkiCovid, shared.SourceRss, shared.SourceS3, shared.SourceSalesforce, shared.SourceSalesloft, shared.SourceSapFieldglass, shared.SourceSecoda, shared.SourceSendgrid, shared.SourceSendinblue, shared.SourceSenseforce, shared.SourceSentry, shared.SourceSftp, shared.SourceSftpBulk, shared.SourceShopify, shared.SourceShortio, shared.SourceSlack, shared.SourceSmaily, shared.SourceSmartengage, shared.SourceSmartsheets, shared.SourceSnapchatMarketing, shared.SourceSnowflake, shared.SourceSonarCloud, shared.SourceSpacexAPI, shared.SourceSquare, shared.SourceStrava, shared.SourceStripe, shared.SourceSurveySparrow, shared.SourceSurveymonkey, shared.SourceTempo, shared.SourceTheGuardianAPI, shared.SourceTiktokMarketing, shared.SourceTrello, shared.SourceTrustpilot, shared.SourceTvmazeSchedule, shared.SourceTwilio, shared.SourceTwilioTaskrouter, shared.SourceTwitter, shared.SourceTypeform, shared.SourceUsCensus, shared.SourceVantage, shared.SourceWebflow, shared.SourceWhiskyHunter, shared.SourceWikipediaPageviews, shared.SourceWoocommerce, shared.SourceXkcd, shared.SourceYandexMetrica, shared.SourceYotpo, shared.SourceYoutubeAnalytics, shared.SourceZendeskChat, shared.SourceZendeskSell, shared.SourceZendeskSunshine, shared.SourceZendeskSupport, shared.SourceZendeskTalk, shared.SourceZenloop, shared.SourceZohoCrm, shared.SourceZoom, shared.SourceZuora]](../../models/shared/sourceconfiguration.md) | :heavy_check_mark: | The values required to configure the source. | {"user":"charles"} | -| `definition_id` | *Optional[str]* | :heavy_minus_sign: | The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. | | | `name` | *str* | :heavy_check_mark: | Name of the source e.g. dev-mysql-instance. | | -| `secret_id` | *Optional[str]* | :heavy_minus_sign: | Optional secretID obtained through the public API OAuth redirect flow. | | -| `workspace_id` | *str* | :heavy_check_mark: | N/A | | \ No newline at end of file +| `workspace_id` | *str* | :heavy_check_mark: | N/A | | +| `definition_id` | *Optional[str]* | :heavy_minus_sign: | The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. | | +| `secret_id` | *Optional[str]* | :heavy_minus_sign: | Optional secretID obtained through the public API OAuth redirect flow. | | \ No newline at end of file diff --git a/docs/models/shared/sourcedatascope.md b/docs/models/shared/sourcedatascope.md index 1c73efff..bb036bbd 100644 --- a/docs/models/shared/sourcedatascope.md +++ b/docs/models/shared/sourcedatascope.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | API Key | | -| `source_type` | [shared.Datascope](../../models/shared/datascope.md) | :heavy_check_mark: | N/A | | -| `start_date` | *str* | :heavy_check_mark: | Start date for the data to be replicated | dd/mm/YYYY HH:MM | \ No newline at end of file +| `start_date` | *str* | :heavy_check_mark: | Start date for the data to be replicated | dd/mm/YYYY HH:MM | +| `source_type` | [shared.Datascope](../../models/shared/datascope.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcedixa.md b/docs/models/shared/sourcedixa.md index 76b7e9af..a7c19df1 100644 --- a/docs/models/shared/sourcedixa.md +++ b/docs/models/shared/sourcedixa.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | `api_token` | *str* | :heavy_check_mark: | Dixa API token | | +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The connector pulls records updated from this date onwards. | YYYY-MM-DD | | `batch_size` | *Optional[int]* | :heavy_minus_sign: | Number of days to batch into one request. Max 31. | 1 | -| `source_type` | [shared.Dixa](../../models/shared/dixa.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The connector pulls records updated from this date onwards. | YYYY-MM-DD | \ No newline at end of file +| `source_type` | [shared.Dixa](../../models/shared/dixa.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcedynamodb.md b/docs/models/shared/sourcedynamodb.md index 262c5d89..8fa9aece 100644 --- a/docs/models/shared/sourcedynamodb.md +++ b/docs/models/shared/sourcedynamodb.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | | `access_key_id` | *str* | :heavy_check_mark: | The access key id to access Dynamodb. Airbyte requires read permissions to the database | A012345678910EXAMPLE | +| `secret_access_key` | *str* | :heavy_check_mark: | The corresponding secret to the access key id. | a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY | | `endpoint` | *Optional[str]* | :heavy_minus_sign: | the URL of the Dynamodb database | https://{aws_dynamo_db_url}.com | | `region` | [Optional[shared.SourceDynamodbDynamodbRegion]](../../models/shared/sourcedynamodbdynamodbregion.md) | :heavy_minus_sign: | The region of the Dynamodb database | | | `reserved_attribute_names` | *Optional[str]* | :heavy_minus_sign: | Comma separated reserved attribute names present in your tables | name, field_name, field-name | -| `secret_access_key` | *str* | :heavy_check_mark: | The corresponding secret to the access key id. | a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY | | `source_type` | [shared.SourceDynamodbDynamodb](../../models/shared/sourcedynamodbdynamodb.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceexchangerates.md b/docs/models/shared/sourceexchangerates.md index d8637a7c..97b6aa55 100644 --- a/docs/models/shared/sourceexchangerates.md +++ b/docs/models/shared/sourceexchangerates.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `access_key` | *str* | :heavy_check_mark: | Your API Key. See here. The key is case sensitive. | | +| `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | Start getting data from that date. | YYYY-MM-DD | | `base` | *Optional[str]* | :heavy_minus_sign: | ISO reference currency. See here. Free plan doesn't support Source Currency Switching, default base currency is EUR | EUR | | `ignore_weekends` | *Optional[bool]* | :heavy_minus_sign: | Ignore weekends? (Exchanges don't run on weekends) | | -| `source_type` | [shared.ExchangeRates](../../models/shared/exchangerates.md) | :heavy_check_mark: | N/A | | -| `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | Start getting data from that date. | YYYY-MM-DD | \ No newline at end of file +| `source_type` | [shared.ExchangeRates](../../models/shared/exchangerates.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcefauna.md b/docs/models/shared/sourcefauna.md index 2d83fedd..5d1e9cf9 100644 --- a/docs/models/shared/sourcefauna.md +++ b/docs/models/shared/sourcefauna.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `secret` | *str* | :heavy_check_mark: | Fauna secret, used when authenticating with the database. | | `collection` | [Optional[shared.Collection]](../../models/shared/collection.md) | :heavy_minus_sign: | Settings for the Fauna Collection. | | `domain` | *Optional[str]* | :heavy_minus_sign: | Domain of Fauna to query. Defaults db.fauna.com. See the docs. | | `port` | *Optional[int]* | :heavy_minus_sign: | Endpoint port. | | `scheme` | *Optional[str]* | :heavy_minus_sign: | URL scheme. | -| `secret` | *str* | :heavy_check_mark: | Fauna secret, used when authenticating with the database. | | `source_type` | [shared.Fauna](../../models/shared/fauna.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcefile.md b/docs/models/shared/sourcefile.md index ba323e45..08e4ca3a 100644 --- a/docs/models/shared/sourcefile.md +++ b/docs/models/shared/sourcefile.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `dataset_name` | *str* | :heavy_check_mark: | The Name of the final table to replicate this file into (should include letters, numbers dash and underscores only). | | -| `format` | [Optional[shared.FileFormat]](../../models/shared/fileformat.md) | :heavy_minus_sign: | The Format of the file which should be replicated (Warning: some formats may be experimental, please refer to the docs). | | | `provider` | [Union[shared.HTTPSPublicWeb, shared.GCSGoogleCloudStorage, shared.SourceFileS3AmazonWebServices, shared.AzBlobAzureBlobStorage, shared.SSHSecureShell, shared.SCPSecureCopyProtocol, shared.SFTPSecureFileTransferProtocol]](../../models/shared/storageprovider.md) | :heavy_check_mark: | The storage Provider or Location of the file(s) which should be replicated. | | +| `url` | *str* | :heavy_check_mark: | The URL path to access the file which should be replicated. | https://storage.googleapis.com/covid19-open-data/v2/latest/epidemiology.csv | +| `format` | [Optional[shared.FileFormat]](../../models/shared/fileformat.md) | :heavy_minus_sign: | The Format of the file which should be replicated (Warning: some formats may be experimental, please refer to the docs). | | | `reader_options` | *Optional[str]* | :heavy_minus_sign: | This should be a string in JSON format. It depends on the chosen file format to provide additional options and tune its behavior. | {} | -| `source_type` | [shared.File](../../models/shared/file.md) | :heavy_check_mark: | N/A | | -| `url` | *str* | :heavy_check_mark: | The URL path to access the file which should be replicated. | https://storage.googleapis.com/covid19-open-data/v2/latest/epidemiology.csv | \ No newline at end of file +| `source_type` | [shared.File](../../models/shared/file.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcefirebolt.md b/docs/models/shared/sourcefirebolt.md index 7e911345..cffa4c2f 100644 --- a/docs/models/shared/sourcefirebolt.md +++ b/docs/models/shared/sourcefirebolt.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| `account` | *Optional[str]* | :heavy_minus_sign: | Firebolt account to login. | | | `database` | *str* | :heavy_check_mark: | The database to connect to. | | +| `password` | *str* | :heavy_check_mark: | Firebolt password. | | +| `username` | *str* | :heavy_check_mark: | Firebolt email address you use to login. | username@email.com | +| `account` | *Optional[str]* | :heavy_minus_sign: | Firebolt account to login. | | | `engine` | *Optional[str]* | :heavy_minus_sign: | Engine name or url to connect to. | | | `host` | *Optional[str]* | :heavy_minus_sign: | The host name of your Firebolt database. | api.app.firebolt.io | -| `password` | *str* | :heavy_check_mark: | Firebolt password. | | -| `source_type` | [shared.SourceFireboltFirebolt](../../models/shared/sourcefireboltfirebolt.md) | :heavy_check_mark: | N/A | | -| `username` | *str* | :heavy_check_mark: | Firebolt email address you use to login. | username@email.com | \ No newline at end of file +| `source_type` | [shared.SourceFireboltFirebolt](../../models/shared/sourcefireboltfirebolt.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcegcs.md b/docs/models/shared/sourcegcs.md index 6be046c9..7b24d138 100644 --- a/docs/models/shared/sourcegcs.md +++ b/docs/models/shared/sourcegcs.md @@ -11,6 +11,6 @@ legacy GCS configs into file based configs using the File-Based CDK. | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `bucket` | *str* | :heavy_check_mark: | Name of the GCS bucket where the file(s) exist. | | | `service_account` | *str* | :heavy_check_mark: | Enter your Google Cloud service account key in JSON format | | +| `streams` | List[[shared.SourceGCSStreamConfig](../../models/shared/sourcegcsstreamconfig.md)] | :heavy_check_mark: | Each instance of this configuration defines a stream. Use this to define which files belong in the stream, their format, and how they should be parsed and validated. When sending data to warehouse destination such as Snowflake or BigQuery, each stream is a separate table. | | | `source_type` | [shared.SourceGcsGcs](../../models/shared/sourcegcsgcs.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | UTC date and time in the format 2017-01-25T00:00:00.000000Z. Any file modified before this date will not be replicated. | 2021-01-01T00:00:00.000000Z | -| `streams` | List[[shared.SourceGCSStreamConfig](../../models/shared/sourcegcsstreamconfig.md)] | :heavy_check_mark: | Each instance of this configuration defines a stream. Use this to define which files belong in the stream, their format, and how they should be parsed and validated. When sending data to warehouse destination such as Snowflake or BigQuery, each stream is a separate table. | | \ No newline at end of file +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | UTC date and time in the format 2017-01-25T00:00:00.000000Z. Any file modified before this date will not be replicated. | 2021-01-01T00:00:00.000000Z | \ No newline at end of file diff --git a/docs/models/shared/sourcegcsstreamconfig.md b/docs/models/shared/sourcegcsstreamconfig.md index 825a4cba..63c59da2 100644 --- a/docs/models/shared/sourcegcsstreamconfig.md +++ b/docs/models/shared/sourcegcsstreamconfig.md @@ -5,12 +5,12 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `days_to_sync_if_history_is_full` | *Optional[int]* | :heavy_minus_sign: | When the state history of the file store is full, syncs will only read files that were last modified in the provided day range. | | `format` | [Union[shared.SourceGcsCSVFormat]](../../models/shared/sourcegcsformat.md) | :heavy_check_mark: | The configuration options that are used to alter how to read incoming files that deviate from the standard formatting. | +| `name` | *str* | :heavy_check_mark: | The name of the stream. | +| `days_to_sync_if_history_is_full` | *Optional[int]* | :heavy_minus_sign: | When the state history of the file store is full, syncs will only read files that were last modified in the provided day range. | | `globs` | List[*str*] | :heavy_minus_sign: | The pattern used to specify which files should be selected from the file system. For more information on glob pattern matching look here. | | `input_schema` | *Optional[str]* | :heavy_minus_sign: | The schema that will be used to validate records extracted from the file. This will override the stream schema that is auto-detected from incoming files. | | `legacy_prefix` | *Optional[str]* | :heavy_minus_sign: | The path prefix configured in previous versions of the GCS connector. This option is deprecated in favor of a single glob. | -| `name` | *str* | :heavy_check_mark: | The name of the stream. | | `primary_key` | *Optional[str]* | :heavy_minus_sign: | The column or columns (for a composite key) that serves as the unique identifier of a record. If empty, the primary key will default to the parser's default primary key. | | `schemaless` | *Optional[bool]* | :heavy_minus_sign: | When enabled, syncs will not validate or structure records against the stream's schema. | | `validation_policy` | [Optional[shared.SourceGcsValidationPolicy]](../../models/shared/sourcegcsvalidationpolicy.md) | :heavy_minus_sign: | The name of the validation policy that dictates sync behavior when a record does not adhere to the stream schema. | \ No newline at end of file diff --git a/docs/models/shared/sourcegithub.md b/docs/models/shared/sourcegithub.md index f595143e..1c798b50 100644 --- a/docs/models/shared/sourcegithub.md +++ b/docs/models/shared/sourcegithub.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `credentials` | [Union[shared.OAuth, shared.SourceGithubPersonalAccessToken]](../../models/shared/sourcegithubauthentication.md) | :heavy_check_mark: | Choose how to authenticate to GitHub | | +| `repositories` | List[*str*] | :heavy_check_mark: | List of GitHub organizations/repositories, e.g. `airbytehq/airbyte` for single repository, `airbytehq/*` for get all repositories from organization and `airbytehq/airbyte airbytehq/another-repo` for multiple repositories. | airbytehq/airbyte airbytehq/another-repo | | `api_url` | *Optional[str]* | :heavy_minus_sign: | Please enter your basic URL from self-hosted GitHub instance or leave it empty to use GitHub. | https://github.com | | `branch` | *Optional[str]* | :heavy_minus_sign: | (DEPRCATED) Space-delimited list of GitHub repository branches to pull commits for, e.g. `airbytehq/airbyte/master`. If no branches are specified for a repository, the default branch will be pulled. | airbytehq/airbyte/master airbytehq/airbyte/my-branch | | `branches` | List[*str*] | :heavy_minus_sign: | List of GitHub repository branches to pull commits for, e.g. `airbytehq/airbyte/master`. If no branches are specified for a repository, the default branch will be pulled. | airbytehq/airbyte/master airbytehq/airbyte/my-branch | -| `credentials` | [Union[shared.OAuth, shared.SourceGithubPersonalAccessToken]](../../models/shared/sourcegithubauthentication.md) | :heavy_check_mark: | Choose how to authenticate to GitHub | | -| `repositories` | List[*str*] | :heavy_check_mark: | List of GitHub organizations/repositories, e.g. `airbytehq/airbyte` for single repository, `airbytehq/*` for get all repositories from organization and `airbytehq/airbyte airbytehq/another-repo` for multiple repositories. | airbytehq/airbyte airbytehq/another-repo | | `repository` | *Optional[str]* | :heavy_minus_sign: | (DEPRCATED) Space-delimited list of GitHub organizations/repositories, e.g. `airbytehq/airbyte` for single repository, `airbytehq/*` for get all repositories from organization and `airbytehq/airbyte airbytehq/another-repo` for multiple repositories. | airbytehq/airbyte airbytehq/another-repo | | `requests_per_hour` | *Optional[int]* | :heavy_minus_sign: | The GitHub API allows for a maximum of 5000 requests per hour (15000 for Github Enterprise). You can specify a lower value to limit your use of the API quota. | | | `source_type` | [shared.SourceGithubGithub](../../models/shared/sourcegithubgithub.md) | :heavy_check_mark: | N/A | | diff --git a/docs/models/shared/sourcegithubpersonalaccesstoken.md b/docs/models/shared/sourcegithubpersonalaccesstoken.md index 4cc62ce3..7e01d9ed 100644 --- a/docs/models/shared/sourcegithubpersonalaccesstoken.md +++ b/docs/models/shared/sourcegithubpersonalaccesstoken.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `option_title` | [Optional[shared.SourceGithubOptionTitle]](../../models/shared/sourcegithuboptiontitle.md) | :heavy_minus_sign: | N/A | -| `personal_access_token` | *str* | :heavy_check_mark: | Log into GitHub and then generate a personal access token. To load balance your API quota consumption across multiple API tokens, input multiple tokens separated with "," | \ No newline at end of file +| `personal_access_token` | *str* | :heavy_check_mark: | Log into GitHub and then generate a personal access token. To load balance your API quota consumption across multiple API tokens, input multiple tokens separated with "," | +| `option_title` | [Optional[shared.SourceGithubOptionTitle]](../../models/shared/sourcegithuboptiontitle.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegitlab.md b/docs/models/shared/sourcegitlab.md index 5e3a5b16..00e9b9e4 100644 --- a/docs/models/shared/sourcegitlab.md +++ b/docs/models/shared/sourcegitlab.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_url` | *Optional[str]* | :heavy_minus_sign: | Please enter your basic URL from GitLab instance. | gitlab.com | | `credentials` | [Union[shared.SourceGitlabOAuth20, shared.PrivateToken]](../../models/shared/sourcegitlabauthorizationmethod.md) | :heavy_check_mark: | N/A | | +| `api_url` | *Optional[str]* | :heavy_minus_sign: | Please enter your basic URL from GitLab instance. | gitlab.com | | `groups` | *Optional[str]* | :heavy_minus_sign: | [DEPRECATED] Space-delimited list of groups. e.g. airbyte.io. | airbyte.io | | `groups_list` | List[*str*] | :heavy_minus_sign: | List of groups. e.g. airbyte.io. | airbyte.io | | `projects` | *Optional[str]* | :heavy_minus_sign: | [DEPRECATED] Space-delimited list of projects. e.g. airbyte.io/documentation meltano/tap-gitlab. | airbyte.io/documentation | diff --git a/docs/models/shared/sourcegitlaboauth20.md b/docs/models/shared/sourcegitlaboauth20.md index d30d4bc9..9db495d3 100644 --- a/docs/models/shared/sourcegitlaboauth20.md +++ b/docs/models/shared/sourcegitlaboauth20.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | -| `auth_type` | [Optional[shared.SourceGitlabAuthType]](../../models/shared/sourcegitlabauthtype.md) | :heavy_minus_sign: | N/A | | `client_id` | *str* | :heavy_check_mark: | The API ID of the Gitlab developer application. | | `client_secret` | *str* | :heavy_check_mark: | The API Secret the Gitlab developer application. | | `refresh_token` | *str* | :heavy_check_mark: | The key to refresh the expired access_token. | -| `token_expiry_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date-time when the access token should be refreshed. | \ No newline at end of file +| `token_expiry_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date-time when the access token should be refreshed. | +| `auth_type` | [Optional[shared.SourceGitlabAuthType]](../../models/shared/sourcegitlabauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegnews.md b/docs/models/shared/sourcegnews.md index db943d63..a98386f7 100644 --- a/docs/models/shared/sourcegnews.md +++ b/docs/models/shared/sourcegnews.md @@ -6,12 +6,12 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | API Key | | +| `query` | *str* | :heavy_check_mark: | This parameter allows you to specify your search keywords to find the news articles you are looking for. The keywords will be used to return the most relevant articles. It is possible to use logical operators with keywords. - Phrase Search Operator: This operator allows you to make an exact search. Keywords surrounded by
    quotation marks are used to search for articles with the exact same keyword sequence.
    For example the query: "Apple iPhone" will return articles matching at least once this sequence of keywords.
    - Logical AND Operator: This operator allows you to make sure that several keywords are all used in the article
    search. By default the space character acts as an AND operator, it is possible to replace the space character
    by AND to obtain the same result. For example the query: Apple Microsoft is equivalent to Apple AND Microsoft
    - Logical OR Operator: This operator allows you to retrieve articles matching the keyword a or the keyword b.
    It is important to note that this operator has a higher precedence than the AND operator. For example the
    query: Apple OR Microsoft will return all articles matching the keyword Apple as well as all articles matching
    the keyword Microsoft
    - Logical NOT Operator: This operator allows you to remove from the results the articles corresponding to the
    specified keywords. To use it, you need to add NOT in front of each word or phrase surrounded by quotes.
    For example the query: Apple NOT iPhone will return all articles matching the keyword Apple but not the keyword
    iPhone | Microsoft Windows 10 | | `country` | [Optional[shared.Country]](../../models/shared/country.md) | :heavy_minus_sign: | This parameter allows you to specify the country where the news articles returned by the API were published, the contents of the articles are not necessarily related to the specified country. You have to set as value the 2 letters code of the country you want to filter. | | | `end_date` | *Optional[str]* | :heavy_minus_sign: | This parameter allows you to filter the articles that have a publication date smaller than or equal to the specified value. The date must respect the following format: YYYY-MM-DD hh:mm:ss (in UTC) | 2022-08-21 16:27:09 | | `in_` | List[[shared.In](../../models/shared/in_.md)] | :heavy_minus_sign: | This parameter allows you to choose in which attributes the keywords are searched. The attributes that can be set are title, description and content. It is possible to combine several attributes. | | | `language` | [Optional[shared.Language]](../../models/shared/language.md) | :heavy_minus_sign: | N/A | | | `nullable` | List[[shared.Nullable](../../models/shared/nullable.md)] | :heavy_minus_sign: | This parameter allows you to specify the attributes that you allow to return null values. The attributes that can be set are title, description and content. It is possible to combine several attributes | | -| `query` | *str* | :heavy_check_mark: | This parameter allows you to specify your search keywords to find the news articles you are looking for. The keywords will be used to return the most relevant articles. It is possible to use logical operators with keywords. - Phrase Search Operator: This operator allows you to make an exact search. Keywords surrounded by
    quotation marks are used to search for articles with the exact same keyword sequence.
    For example the query: "Apple iPhone" will return articles matching at least once this sequence of keywords.
    - Logical AND Operator: This operator allows you to make sure that several keywords are all used in the article
    search. By default the space character acts as an AND operator, it is possible to replace the space character
    by AND to obtain the same result. For example the query: Apple Microsoft is equivalent to Apple AND Microsoft
    - Logical OR Operator: This operator allows you to retrieve articles matching the keyword a or the keyword b.
    It is important to note that this operator has a higher precedence than the AND operator. For example the
    query: Apple OR Microsoft will return all articles matching the keyword Apple as well as all articles matching
    the keyword Microsoft
    - Logical NOT Operator: This operator allows you to remove from the results the articles corresponding to the
    specified keywords. To use it, you need to add NOT in front of each word or phrase surrounded by quotes.
    For example the query: Apple NOT iPhone will return all articles matching the keyword Apple but not the keyword
    iPhone | Microsoft Windows 10 | | `sortby` | [Optional[shared.SortBy]](../../models/shared/sortby.md) | :heavy_minus_sign: | This parameter allows you to choose with which type of sorting the articles should be returned. Two values are possible:
    - publishedAt = sort by publication date, the articles with the most recent publication date are returned first
    - relevance = sort by best match to keywords, the articles with the best match are returned first | | | `source_type` | [shared.Gnews](../../models/shared/gnews.md) | :heavy_check_mark: | N/A | | | `start_date` | *Optional[str]* | :heavy_minus_sign: | This parameter allows you to filter the articles that have a publication date greater than or equal to the specified value. The date must respect the following format: YYYY-MM-DD hh:mm:ss (in UTC) | 2022-08-21 16:27:09 | diff --git a/docs/models/shared/sourcegoogleads.md b/docs/models/shared/sourcegoogleads.md index ceca2473..92260c05 100644 --- a/docs/models/shared/sourcegoogleads.md +++ b/docs/models/shared/sourcegoogleads.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `conversion_window_days` | *Optional[int]* | :heavy_minus_sign: | A conversion window is the number of days after an ad interaction (such as an ad click or video view) during which a conversion, such as a purchase, is recorded in Google Ads. For more information, see Google's documentation. | 14 | | `credentials` | [shared.GoogleCredentials](../../models/shared/googlecredentials.md) | :heavy_check_mark: | N/A | | +| `conversion_window_days` | *Optional[int]* | :heavy_minus_sign: | A conversion window is the number of days after an ad interaction (such as an ad click or video view) during which a conversion, such as a purchase, is recorded in Google Ads. For more information, see Google's documentation. | 14 | | `custom_queries_array` | List[[shared.CustomQueriesArray](../../models/shared/customqueriesarray.md)] | :heavy_minus_sign: | N/A | | | `customer_id` | *Optional[str]* | :heavy_minus_sign: | Comma-separated list of (client) customer IDs. Each customer ID must be specified as a 10-digit number without dashes. For detailed instructions on finding this value, refer to our documentation. | 6783948572,5839201945 | | `customer_status_filter` | List[[shared.CustomerStatus](../../models/shared/customerstatus.md)] | :heavy_minus_sign: | A list of customer statuses to filter on. For detailed info about what each status mean refer to Google Ads documentation. | | diff --git a/docs/models/shared/sourcegoogleanalyticsdataapi.md b/docs/models/shared/sourcegoogleanalyticsdataapi.md index 27d1dbce..edb6e214 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapi.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapi.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `property_ids` | List[*str*] | :heavy_check_mark: | A list of your Property IDs. The Property ID is a unique number assigned to each property in Google Analytics, found in your GA4 property URL. This ID allows the connector to track the specific events associated with your property. Refer to the Google Analytics documentation to locate your property ID. | ["1738294","5729978930"] | | `credentials` | [Optional[Union[shared.AuthenticateViaGoogleOauth, shared.ServiceAccountKeyAuthentication]]](../../models/shared/sourcegoogleanalyticsdataapicredentials.md) | :heavy_minus_sign: | Credentials for the service | | | `custom_reports_array` | List[[shared.SourceGoogleAnalyticsDataAPICustomReportConfig](../../models/shared/sourcegoogleanalyticsdataapicustomreportconfig.md)] | :heavy_minus_sign: | You can add your Custom Analytics report by creating one. | | | `date_ranges_start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The start date from which to replicate report data in the format YYYY-MM-DD. Data generated before this date will not be included in the report. Not applied to custom Cohort reports. | 2021-01-01 | | `keep_empty_rows` | *Optional[bool]* | :heavy_minus_sign: | If false, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. More information is available in the documentation. | | -| `property_ids` | List[*str*] | :heavy_check_mark: | A list of your Property IDs. The Property ID is a unique number assigned to each property in Google Analytics, found in your GA4 property URL. This ID allows the connector to track the specific events associated with your property. Refer to the Google Analytics documentation to locate your property ID. | ["1738294","5729978930"] | | `source_type` | [shared.SourceGoogleAnalyticsDataAPIGoogleAnalyticsDataAPI](../../models/shared/sourcegoogleanalyticsdataapigoogleanalyticsdataapi.md) | :heavy_check_mark: | N/A | | | `window_in_days` | *Optional[int]* | :heavy_minus_sign: | The interval in days for each data request made to the Google Analytics API. A larger value speeds up data sync, but increases the chance of data sampling, which may result in inaccuracies. We recommend a value of 1 to minimize sampling, unless speed is an absolute priority over accuracy. Acceptable values range from 1 to 364. Does not apply to custom Cohort reports. More information is available in the documentation. | 30 | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapibetweenfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapibetweenfilter.md index 02dcaa1d..8d959fe1 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapibetweenfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapibetweenfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfiltername.md) | :heavy_check_mark: | N/A | | `from_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapifromvalue.md) | :heavy_check_mark: | N/A | -| `to_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapitovalue.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `to_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapitovalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapicustomreportconfig.md b/docs/models/shared/sourcegoogleanalyticsdataapicustomreportconfig.md index 70a1be78..3da1cde4 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapicustomreportconfig.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapicustomreportconfig.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cohort_spec` | [Optional[Union[shared.SourceGoogleAnalyticsDataAPIDisabled, shared.SourceGoogleAnalyticsDataAPISchemasEnabled]]](../../models/shared/cohortreports.md) | :heavy_minus_sign: | Cohort reports creates a time series of user retention for the cohort. | -| `dimension_filter` | [Optional[Union[shared.AndGroup, shared.OrGroup, shared.NotExpression, shared.Filter]]](../../models/shared/dimensionsfilter.md) | :heavy_minus_sign: | Dimensions filter | | `dimensions` | List[*str*] | :heavy_check_mark: | A list of dimensions. | -| `metric_filter` | [Optional[Union[shared.SourceGoogleAnalyticsDataAPIAndGroup, shared.SourceGoogleAnalyticsDataAPIOrGroup, shared.SourceGoogleAnalyticsDataAPINotExpression, shared.SourceGoogleAnalyticsDataAPIFilter]]](../../models/shared/metricsfilter.md) | :heavy_minus_sign: | Metrics filter | | `metrics` | List[*str*] | :heavy_check_mark: | A list of metrics. | -| `name` | *str* | :heavy_check_mark: | The name of the custom report, this name would be used as stream name. | \ No newline at end of file +| `name` | *str* | :heavy_check_mark: | The name of the custom report, this name would be used as stream name. | +| `cohort_spec` | [Optional[Union[shared.SourceGoogleAnalyticsDataAPIDisabled, shared.SourceGoogleAnalyticsDataAPISchemasEnabled]]](../../models/shared/cohortreports.md) | :heavy_minus_sign: | Cohort reports creates a time series of user retention for the cohort. | +| `dimension_filter` | [Optional[Union[shared.AndGroup, shared.OrGroup, shared.NotExpression, shared.Filter]]](../../models/shared/dimensionsfilter.md) | :heavy_minus_sign: | Dimensions filter | +| `metric_filter` | [Optional[Union[shared.SourceGoogleAnalyticsDataAPIAndGroup, shared.SourceGoogleAnalyticsDataAPIOrGroup, shared.SourceGoogleAnalyticsDataAPINotExpression, shared.SourceGoogleAnalyticsDataAPIFilter]]](../../models/shared/metricsfilter.md) | :heavy_minus_sign: | Metrics filter | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapiinlistfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapiinlistfilter.md index a95c6e6f..51beb7aa 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapiinlistfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapiinlistfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `values` | List[*str*] | :heavy_check_mark: | N/A | | `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfiltername.md) | :heavy_check_mark: | N/A | -| `values` | List[*str*] | :heavy_check_mark: | N/A | \ No newline at end of file +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapinumericfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapinumericfilter.md index 3106f49d..8317f4fd 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapinumericfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapinumericfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtername.md) | :heavy_check_mark: | N/A | | `operation` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalidenums.md)] | :heavy_check_mark: | N/A | -| `value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapivalue.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapivalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter4FilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter4filtername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemasbetweenfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemasbetweenfilter.md index 4f62ec99..85d4a1f5 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemasbetweenfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemasbetweenfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilterfiltername.md) | :heavy_check_mark: | N/A | | `from_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemasfromvalue.md) | :heavy_check_mark: | N/A | -| `to_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemastovalue.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `to_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemastovalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraybetweenfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraybetweenfilter.md index 81311b25..8fd027a6 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraybetweenfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraybetweenfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilterfiltername.md) | :heavy_check_mark: | N/A | | `from_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayfromvalue.md) | :heavy_check_mark: | N/A | -| `to_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraytovalue.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `to_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraytovalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterbetweenfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterbetweenfilter.md index 50f62452..c26df207 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterbetweenfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterbetweenfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfiltername.md) | :heavy_check_mark: | N/A | | `from_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfromvalue.md) | :heavy_check_mark: | N/A | -| `to_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltertovalue.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `to_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltertovalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ExpressionsFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2expressionsfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterinlistfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterinlistfilter.md index ac648520..e338d373 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterinlistfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterinlistfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `values` | List[*str*] | :heavy_check_mark: | N/A | | `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfiltername.md) | :heavy_check_mark: | N/A | -| `values` | List[*str*] | :heavy_check_mark: | N/A | \ No newline at end of file +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilternumericfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilternumericfilter.md index 6000c3b8..38a10acc 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilternumericfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilternumericfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2FilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2filtername.md) | :heavy_check_mark: | N/A | | `operation` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalidenums.md)] | :heavy_check_mark: | N/A | -| `value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2Int64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2DoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalue.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2Int64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2DoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfiltervalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2FilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2filtername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterstringfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterstringfilter.md index efcbc484..dfa91657 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterstringfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterstringfilter.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | | `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterfiltername.md) | :heavy_check_mark: | N/A | -| `match_type` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2validenums.md)] | :heavy_minus_sign: | N/A | -| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `match_type` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter2validenums.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayinlistfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayinlistfilter.md index ec2626cc..9cb6652d 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayinlistfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayinlistfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `values` | List[*str*] | :heavy_check_mark: | N/A | | `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfiltername.md) | :heavy_check_mark: | N/A | -| `values` | List[*str*] | :heavy_check_mark: | N/A | \ No newline at end of file +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterbetweenfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterbetweenfilter.md index 45602df0..aed7f559 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterbetweenfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterbetweenfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfiltername.md) | :heavy_check_mark: | N/A | | `from_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfromvalue.md) | :heavy_check_mark: | N/A | -| `to_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1Int64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1DoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltertovalue.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `to_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1Int64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1DoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltertovalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterinlistfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterinlistfilter.md index 97d6b4a4..fc3f47e2 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterinlistfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterinlistfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `values` | List[*str*] | :heavy_check_mark: | N/A | | `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilterfiltername.md) | :heavy_check_mark: | N/A | -| `values` | List[*str*] | :heavy_check_mark: | N/A | \ No newline at end of file +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3betweenfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3betweenfilter.md index 0284fdbc..e5bdba57 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3betweenfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3betweenfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilterfiltername.md) | :heavy_check_mark: | N/A | | `from_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3fromvalue.md) | :heavy_check_mark: | N/A | -| `to_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3tovalue.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `to_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3tovalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3inlistfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3inlistfilter.md index dfbe7166..5d2b55b9 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3inlistfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3inlistfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `values` | List[*str*] | :heavy_check_mark: | N/A | | `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfiltername.md) | :heavy_check_mark: | N/A | -| `values` | List[*str*] | :heavy_check_mark: | N/A | \ No newline at end of file +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3numericfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3numericfilter.md index e947f80d..01dca394 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3numericfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3numericfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfiltername.md) | :heavy_check_mark: | N/A | | `operation` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionvalidenums.md)] | :heavy_check_mark: | N/A | -| `value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Int64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3DoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3value.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3Int64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3DoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3value.md) | :heavy_check_mark: | N/A | +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3expressionfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3stringfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3stringfilter.md index 937b9596..72fa6018 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3stringfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3stringfilter.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | | `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3FilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3filtername.md) | :heavy_check_mark: | N/A | -| `match_type` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3validenums.md)] | :heavy_minus_sign: | N/A | -| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `match_type` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter3validenums.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterbetweenfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterbetweenfilter.md index e380b600..88377e96 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterbetweenfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterbetweenfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilterfiltername.md) | :heavy_check_mark: | N/A | | `from_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterfromvalue.md) | :heavy_check_mark: | N/A | -| `to_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltertovalue.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `to_value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltertovalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterinlistfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterinlistfilter.md index 12549ba6..dca63eb3 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterinlistfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterinlistfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `values` | List[*str*] | :heavy_check_mark: | N/A | | `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfiltername.md) | :heavy_check_mark: | N/A | -| `values` | List[*str*] | :heavy_check_mark: | N/A | \ No newline at end of file +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilternumericfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilternumericfilter.md index 1acfa860..06bf6cb1 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilternumericfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilternumericfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfiltername.md) | :heavy_check_mark: | N/A | | `operation` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsvalidenums.md)] | :heavy_check_mark: | N/A | -| `value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2Int64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2DoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalue.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2Int64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2DoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2expressionsfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterstringfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterstringfilter.md index 9d9c05e0..42c81164 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterstringfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilterstringfilter.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | | `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2FilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2filtername.md) | :heavy_check_mark: | N/A | -| `match_type` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2validenums.md)] | :heavy_minus_sign: | N/A | -| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `match_type` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter2validenums.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilternumericfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilternumericfilter.md index 7ba5eca3..4cb5a664 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilternumericfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilternumericfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1FilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1filtername.md) | :heavy_check_mark: | N/A | | `operation` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfiltervalidenums.md)] | :heavy_check_mark: | N/A | -| `value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalue.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsInt64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsDoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltervalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1FilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1filtername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterstringfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterstringfilter.md index 57142910..8e2ee3f3 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterstringfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterstringfilter.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | | `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1expressionsfilterfiltername.md) | :heavy_check_mark: | N/A | -| `match_type` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1validenums.md)] | :heavy_minus_sign: | N/A | -| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `match_type` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfiltermetricsfilter1validenums.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraynumericfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraynumericfilter.md index 5c54fe7b..7edfe2e1 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraynumericfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraynumericfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfiltername.md) | :heavy_check_mark: | N/A | | `operation` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsvalidenums.md)] | :heavy_check_mark: | N/A | -| `value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Int64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1DoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayvalue.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1Int64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1DoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayvalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1expressionsfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraystringfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraystringfilter.md index 2964fadc..a4373d9f 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraystringfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraystringfilter.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | | `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1FilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1filtername.md) | :heavy_check_mark: | N/A | -| `match_type` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1validenums.md)] | :heavy_minus_sign: | N/A | -| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `match_type` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter1validenums.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemasinlistfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemasinlistfilter.md index 1e4152b6..99a30c7d 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemasinlistfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemasinlistfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `values` | List[*str*] | :heavy_check_mark: | N/A | | `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfiltername.md) | :heavy_check_mark: | N/A | -| `values` | List[*str*] | :heavy_check_mark: | N/A | \ No newline at end of file +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemasnumericfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemasnumericfilter.md index 0e8e9549..7d80a74a 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemasnumericfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemasnumericfilter.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfiltername.md) | :heavy_check_mark: | N/A | | `operation` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3validenums.md)] | :heavy_check_mark: | N/A | -| `value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3Int64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3DoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemasvalue.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| `value` | [Union[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3Int64Value, shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3DoubleValue]](../../models/shared/sourcegoogleanalyticsdataapischemasvalue.md) | :heavy_check_mark: | N/A | +| `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3expressionfilterfiltername.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapischemasstringfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapischemasstringfilter.md index 28b7cf83..bbbb0ef4 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapischemasstringfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapischemasstringfilter.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `value` | *str* | :heavy_check_mark: | N/A | | `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3FilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfilter3filtername.md) | :heavy_check_mark: | N/A | -| `match_type` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfiltervalidenums.md)] | :heavy_minus_sign: | N/A | -| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `match_type` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraydimensionfilterdimensionsfiltervalidenums.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogleanalyticsdataapistringfilter.md b/docs/models/shared/sourcegoogleanalyticsdataapistringfilter.md index a80e9137..fe335564 100644 --- a/docs/models/shared/sourcegoogleanalyticsdataapistringfilter.md +++ b/docs/models/shared/sourcegoogleanalyticsdataapistringfilter.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | | `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `filter_name` | [shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilterName](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarraymetricfilterfiltername.md) | :heavy_check_mark: | N/A | -| `match_type` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayvalidenums.md)] | :heavy_minus_sign: | N/A | -| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `match_type` | List[[shared.SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayValidEnums](../../models/shared/sourcegoogleanalyticsdataapischemascustomreportsarrayvalidenums.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogledrive.md b/docs/models/shared/sourcegoogledrive.md index f45a3da9..92ee5d68 100644 --- a/docs/models/shared/sourcegoogledrive.md +++ b/docs/models/shared/sourcegoogledrive.md @@ -10,6 +10,6 @@ that are needed when users configure a file-based source. | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `credentials` | [Union[shared.SourceGoogleDriveAuthenticateViaGoogleOAuth, shared.SourceGoogleDriveServiceAccountKeyAuthentication]](../../models/shared/sourcegoogledriveauthentication.md) | :heavy_check_mark: | Credentials for connecting to the Google Drive API | | | `folder_url` | *str* | :heavy_check_mark: | URL for the folder you want to sync. Using individual streams and glob patterns, it's possible to only sync a subset of all files located in the folder. | https://drive.google.com/drive/folders/1Xaz0vXXXX2enKnNYU5qSt9NS70gvMyYn | +| `streams` | List[[shared.SourceGoogleDriveFileBasedStreamConfig](../../models/shared/sourcegoogledrivefilebasedstreamconfig.md)] | :heavy_check_mark: | Each instance of this configuration defines a stream. Use this to define which files belong in the stream, their format, and how they should be parsed and validated. When sending data to warehouse destination such as Snowflake or BigQuery, each stream is a separate table. | | | `source_type` | [shared.SourceGoogleDriveGoogleDrive](../../models/shared/sourcegoogledrivegoogledrive.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | UTC date and time in the format 2017-01-25T00:00:00.000000Z. Any file modified before this date will not be replicated. | 2021-01-01T00:00:00.000000Z | -| `streams` | List[[shared.SourceGoogleDriveFileBasedStreamConfig](../../models/shared/sourcegoogledrivefilebasedstreamconfig.md)] | :heavy_check_mark: | Each instance of this configuration defines a stream. Use this to define which files belong in the stream, their format, and how they should be parsed and validated. When sending data to warehouse destination such as Snowflake or BigQuery, each stream is a separate table. | | \ No newline at end of file +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | UTC date and time in the format 2017-01-25T00:00:00.000000Z. Any file modified before this date will not be replicated. | 2021-01-01T00:00:00.000000Z | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogledriveauthenticateviagoogleoauth.md b/docs/models/shared/sourcegoogledriveauthenticateviagoogleoauth.md index 38a4ac9e..5b5047bf 100644 --- a/docs/models/shared/sourcegoogledriveauthenticateviagoogleoauth.md +++ b/docs/models/shared/sourcegoogledriveauthenticateviagoogleoauth.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `auth_type` | [Optional[shared.SourceGoogleDriveAuthType]](../../models/shared/sourcegoogledriveauthtype.md) | :heavy_minus_sign: | N/A | | `client_id` | *str* | :heavy_check_mark: | Client ID for the Google Drive API | | `client_secret` | *str* | :heavy_check_mark: | Client Secret for the Google Drive API | -| `refresh_token` | *str* | :heavy_check_mark: | Refresh Token for the Google Drive API | \ No newline at end of file +| `refresh_token` | *str* | :heavy_check_mark: | Refresh Token for the Google Drive API | +| `auth_type` | [Optional[shared.SourceGoogleDriveAuthType]](../../models/shared/sourcegoogledriveauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogledrivefilebasedstreamconfig.md b/docs/models/shared/sourcegoogledrivefilebasedstreamconfig.md index d79f7469..f865dd4e 100644 --- a/docs/models/shared/sourcegoogledrivefilebasedstreamconfig.md +++ b/docs/models/shared/sourcegoogledrivefilebasedstreamconfig.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `days_to_sync_if_history_is_full` | *Optional[int]* | :heavy_minus_sign: | When the state history of the file store is full, syncs will only read files that were last modified in the provided day range. | | `format` | [Union[shared.SourceGoogleDriveAvroFormat, shared.SourceGoogleDriveCSVFormat, shared.SourceGoogleDriveJsonlFormat, shared.SourceGoogleDriveParquetFormat, shared.SourceGoogleDriveDocumentFileTypeFormatExperimental]](../../models/shared/sourcegoogledriveformat.md) | :heavy_check_mark: | The configuration options that are used to alter how to read incoming files that deviate from the standard formatting. | +| `name` | *str* | :heavy_check_mark: | The name of the stream. | +| `days_to_sync_if_history_is_full` | *Optional[int]* | :heavy_minus_sign: | When the state history of the file store is full, syncs will only read files that were last modified in the provided day range. | | `globs` | List[*str*] | :heavy_minus_sign: | The pattern used to specify which files should be selected from the file system. For more information on glob pattern matching look here. | | `input_schema` | *Optional[str]* | :heavy_minus_sign: | The schema that will be used to validate records extracted from the file. This will override the stream schema that is auto-detected from incoming files. | -| `name` | *str* | :heavy_check_mark: | The name of the stream. | | `primary_key` | *Optional[str]* | :heavy_minus_sign: | The column or columns (for a composite key) that serves as the unique identifier of a record. If empty, the primary key will default to the parser's default primary key. | | `schemaless` | *Optional[bool]* | :heavy_minus_sign: | When enabled, syncs will not validate or structure records against the stream's schema. | | `validation_policy` | [Optional[shared.SourceGoogleDriveValidationPolicy]](../../models/shared/sourcegoogledrivevalidationpolicy.md) | :heavy_minus_sign: | The name of the validation policy that dictates sync behavior when a record does not adhere to the stream schema. | \ No newline at end of file diff --git a/docs/models/shared/sourcegoogledriveserviceaccountkeyauthentication.md b/docs/models/shared/sourcegoogledriveserviceaccountkeyauthentication.md index ff9d209d..0331a63e 100644 --- a/docs/models/shared/sourcegoogledriveserviceaccountkeyauthentication.md +++ b/docs/models/shared/sourcegoogledriveserviceaccountkeyauthentication.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth_type` | [Optional[shared.SourceGoogleDriveSchemasAuthType]](../../models/shared/sourcegoogledriveschemasauthtype.md) | :heavy_minus_sign: | N/A | -| `service_account_info` | *str* | :heavy_check_mark: | The JSON key of the service account to use for authorization. Read more here. | \ No newline at end of file +| `service_account_info` | *str* | :heavy_check_mark: | The JSON key of the service account to use for authorization. Read more here. | +| `auth_type` | [Optional[shared.SourceGoogleDriveSchemasAuthType]](../../models/shared/sourcegoogledriveschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegooglepagespeedinsights.md b/docs/models/shared/sourcegooglepagespeedinsights.md index d58564b9..2200faa2 100644 --- a/docs/models/shared/sourcegooglepagespeedinsights.md +++ b/docs/models/shared/sourcegooglepagespeedinsights.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `api_key` | *Optional[str]* | :heavy_minus_sign: | Google PageSpeed API Key. See here. The key is optional - however the API is heavily rate limited when using without API Key. Creating and using the API key therefore is recommended. The key is case sensitive. | | | `categories` | List[[shared.Categories](../../models/shared/categories.md)] | :heavy_check_mark: | Defines which Lighthouse category to run. One or many of: "accessibility", "best-practices", "performance", "pwa", "seo". | | -| `source_type` | [shared.GooglePagespeedInsights](../../models/shared/googlepagespeedinsights.md) | :heavy_check_mark: | N/A | | | `strategies` | List[[shared.Strategies](../../models/shared/strategies.md)] | :heavy_check_mark: | The analyses strategy to use. Either "desktop" or "mobile". | | -| `urls` | List[*str*] | :heavy_check_mark: | The URLs to retrieve pagespeed information from. The connector will attempt to sync PageSpeed reports for all the defined URLs. Format: https://(www.)url.domain | https://example.com | \ No newline at end of file +| `urls` | List[*str*] | :heavy_check_mark: | The URLs to retrieve pagespeed information from. The connector will attempt to sync PageSpeed reports for all the defined URLs. Format: https://(www.)url.domain | https://example.com | +| `api_key` | *Optional[str]* | :heavy_minus_sign: | Google PageSpeed API Key. See here. The key is optional - however the API is heavily rate limited when using without API Key. Creating and using the API key therefore is recommended. The key is case sensitive. | | +| `source_type` | [shared.GooglePagespeedInsights](../../models/shared/googlepagespeedinsights.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcegooglesearchconsole.md b/docs/models/shared/sourcegooglesearchconsole.md index 4db27f5f..b7024410 100644 --- a/docs/models/shared/sourcegooglesearchconsole.md +++ b/docs/models/shared/sourcegooglesearchconsole.md @@ -6,10 +6,10 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `authorization` | [Union[shared.SourceGoogleSearchConsoleOAuth, shared.SourceGoogleSearchConsoleServiceAccountKeyAuthentication]](../../models/shared/authenticationtype.md) | :heavy_check_mark: | N/A | | +| `site_urls` | List[*str*] | :heavy_check_mark: | The URLs of the website property attached to your GSC account. Learn more about properties here. | https://example1.com/ | | `custom_reports` | *Optional[str]* | :heavy_minus_sign: | (DEPRCATED) A JSON array describing the custom reports you want to sync from Google Search Console. See our documentation for more information on formulating custom reports. | | | `custom_reports_array` | List[[shared.SourceGoogleSearchConsoleCustomReportConfig](../../models/shared/sourcegooglesearchconsolecustomreportconfig.md)] | :heavy_minus_sign: | You can add your Custom Analytics report by creating one. | | | `data_state` | [Optional[shared.DataFreshness]](../../models/shared/datafreshness.md) | :heavy_minus_sign: | If set to 'final', the returned data will include only finalized, stable data. If set to 'all', fresh data will be included. When using Incremental sync mode, we do not recommend setting this parameter to 'all' as it may cause data loss. More information can be found in our full documentation. | final | | `end_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | UTC date in the format YYYY-MM-DD. Any data created after this date will not be replicated. Must be greater or equal to the start date field. Leaving this field blank will replicate all data from the start date onward. | 2021-12-12 | -| `site_urls` | List[*str*] | :heavy_check_mark: | The URLs of the website property attached to your GSC account. Learn more about properties here. | https://example1.com/ | | `source_type` | [shared.SourceGoogleSearchConsoleGoogleSearchConsole](../../models/shared/sourcegooglesearchconsolegooglesearchconsole.md) | :heavy_check_mark: | N/A | | | `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. | | \ No newline at end of file diff --git a/docs/models/shared/sourcegooglesearchconsoleoauth.md b/docs/models/shared/sourcegooglesearchconsoleoauth.md index 33e3ae0b..a85ad8af 100644 --- a/docs/models/shared/sourcegooglesearchconsoleoauth.md +++ b/docs/models/shared/sourcegooglesearchconsoleoauth.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `access_token` | *Optional[str]* | :heavy_minus_sign: | Access token for making authenticated requests. Read more here. | -| `auth_type` | [shared.SourceGoogleSearchConsoleAuthType](../../models/shared/sourcegooglesearchconsoleauthtype.md) | :heavy_check_mark: | N/A | | `client_id` | *str* | :heavy_check_mark: | The client ID of your Google Search Console developer application. Read more here. | | `client_secret` | *str* | :heavy_check_mark: | The client secret of your Google Search Console developer application. Read more here. | -| `refresh_token` | *str* | :heavy_check_mark: | The token for obtaining a new access token. Read more here. | \ No newline at end of file +| `refresh_token` | *str* | :heavy_check_mark: | The token for obtaining a new access token. Read more here. | +| `access_token` | *Optional[str]* | :heavy_minus_sign: | Access token for making authenticated requests. Read more here. | +| `auth_type` | [shared.SourceGoogleSearchConsoleAuthType](../../models/shared/sourcegooglesearchconsoleauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegooglesearchconsoleserviceaccountkeyauthentication.md b/docs/models/shared/sourcegooglesearchconsoleserviceaccountkeyauthentication.md index b582a29f..baf92e46 100644 --- a/docs/models/shared/sourcegooglesearchconsoleserviceaccountkeyauthentication.md +++ b/docs/models/shared/sourcegooglesearchconsoleserviceaccountkeyauthentication.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth_type` | [shared.SourceGoogleSearchConsoleSchemasAuthType](../../models/shared/sourcegooglesearchconsoleschemasauthtype.md) | :heavy_check_mark: | N/A | | | `email` | *str* | :heavy_check_mark: | The email of the user which has permissions to access the Google Workspace Admin APIs. | | -| `service_account_info` | *str* | :heavy_check_mark: | The JSON key of the service account to use for authorization. Read more here. | { "type": "service_account", "project_id": YOUR_PROJECT_ID, "private_key_id": YOUR_PRIVATE_KEY, ... } | \ No newline at end of file +| `service_account_info` | *str* | :heavy_check_mark: | The JSON key of the service account to use for authorization. Read more here. | { "type": "service_account", "project_id": YOUR_PROJECT_ID, "private_key_id": YOUR_PRIVATE_KEY, ... } | +| `auth_type` | [shared.SourceGoogleSearchConsoleSchemasAuthType](../../models/shared/sourcegooglesearchconsoleschemasauthtype.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcegooglesheets.md b/docs/models/shared/sourcegooglesheets.md index a02abb66..38a19671 100644 --- a/docs/models/shared/sourcegooglesheets.md +++ b/docs/models/shared/sourcegooglesheets.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `credentials` | [Union[shared.SourceGoogleSheetsAuthenticateViaGoogleOAuth, shared.SourceGoogleSheetsServiceAccountKeyAuthentication]](../../models/shared/sourcegooglesheetsauthentication.md) | :heavy_check_mark: | Credentials for connecting to the Google Sheets API | | +| `spreadsheet_id` | *str* | :heavy_check_mark: | Enter the link to the Google spreadsheet you want to sync. To copy the link, click the 'Share' button in the top-right corner of the spreadsheet, then click 'Copy link'. | https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG-arw2xy4HR3D-dwUb/edit | | `names_conversion` | *Optional[bool]* | :heavy_minus_sign: | Enables the conversion of column names to a standardized, SQL-compliant format. For example, 'My Name' -> 'my_name'. Enable this option if your destination is SQL-based. | | -| `source_type` | [shared.SourceGoogleSheetsGoogleSheets](../../models/shared/sourcegooglesheetsgooglesheets.md) | :heavy_check_mark: | N/A | | -| `spreadsheet_id` | *str* | :heavy_check_mark: | Enter the link to the Google spreadsheet you want to sync. To copy the link, click the 'Share' button in the top-right corner of the spreadsheet, then click 'Copy link'. | https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG-arw2xy4HR3D-dwUb/edit | \ No newline at end of file +| `source_type` | [shared.SourceGoogleSheetsGoogleSheets](../../models/shared/sourcegooglesheetsgooglesheets.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcegooglesheetsauthenticateviagoogleoauth.md b/docs/models/shared/sourcegooglesheetsauthenticateviagoogleoauth.md index 35a5b640..ab336f7a 100644 --- a/docs/models/shared/sourcegooglesheetsauthenticateviagoogleoauth.md +++ b/docs/models/shared/sourcegooglesheetsauthenticateviagoogleoauth.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth_type` | [shared.SourceGoogleSheetsAuthType](../../models/shared/sourcegooglesheetsauthtype.md) | :heavy_check_mark: | N/A | | `client_id` | *str* | :heavy_check_mark: | Enter your Google application's Client ID. See Google's documentation for more information. | | `client_secret` | *str* | :heavy_check_mark: | Enter your Google application's Client Secret. See Google's documentation for more information. | -| `refresh_token` | *str* | :heavy_check_mark: | Enter your Google application's refresh token. See Google's documentation for more information. | \ No newline at end of file +| `refresh_token` | *str* | :heavy_check_mark: | Enter your Google application's refresh token. See Google's documentation for more information. | +| `auth_type` | [shared.SourceGoogleSheetsAuthType](../../models/shared/sourcegooglesheetsauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcegooglesheetsserviceaccountkeyauthentication.md b/docs/models/shared/sourcegooglesheetsserviceaccountkeyauthentication.md index 173463ed..14922631 100644 --- a/docs/models/shared/sourcegooglesheetsserviceaccountkeyauthentication.md +++ b/docs/models/shared/sourcegooglesheetsserviceaccountkeyauthentication.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth_type` | [shared.SourceGoogleSheetsSchemasAuthType](../../models/shared/sourcegooglesheetsschemasauthtype.md) | :heavy_check_mark: | N/A | | -| `service_account_info` | *str* | :heavy_check_mark: | The JSON key of the service account to use for authorization. Read more here. | { "type": "service_account", "project_id": YOUR_PROJECT_ID, "private_key_id": YOUR_PRIVATE_KEY, ... } | \ No newline at end of file +| `service_account_info` | *str* | :heavy_check_mark: | The JSON key of the service account to use for authorization. Read more here. | { "type": "service_account", "project_id": YOUR_PROJECT_ID, "private_key_id": YOUR_PRIVATE_KEY, ... } | +| `auth_type` | [shared.SourceGoogleSheetsSchemasAuthType](../../models/shared/sourcegooglesheetsschemasauthtype.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcegooglewebfonts.md b/docs/models/shared/sourcegooglewebfonts.md index 111bae22..71efb89f 100644 --- a/docs/models/shared/sourcegooglewebfonts.md +++ b/docs/models/shared/sourcegooglewebfonts.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `alt` | *Optional[str]* | :heavy_minus_sign: | Optional, Available params- json, media, proto | | `api_key` | *str* | :heavy_check_mark: | API key is required to access google apis, For getting your's goto google console and generate api key for Webfonts | +| `alt` | *Optional[str]* | :heavy_minus_sign: | Optional, Available params- json, media, proto | | `pretty_print` | *Optional[str]* | :heavy_minus_sign: | Optional, boolean type | | `sort` | *Optional[str]* | :heavy_minus_sign: | Optional, to find how to sort | | `source_type` | [shared.GoogleWebfonts](../../models/shared/googlewebfonts.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceharvest.md b/docs/models/shared/sourceharvest.md index d99d7612..e9a6b891 100644 --- a/docs/models/shared/sourceharvest.md +++ b/docs/models/shared/sourceharvest.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `account_id` | *str* | :heavy_check_mark: | Harvest account ID. Required for all Harvest requests in pair with Personal Access Token | | +| `replication_start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2017-01-25T00:00:00Z | | `credentials` | [Optional[Union[shared.AuthenticateViaHarvestOAuth, shared.SourceHarvestAuthenticateWithPersonalAccessToken]]](../../models/shared/sourceharvestauthenticationmechanism.md) | :heavy_minus_sign: | Choose how to authenticate to Harvest. | | | `replication_end_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data after this date will not be replicated. | 2017-01-25T00:00:00Z | -| `replication_start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2017-01-25T00:00:00Z | | `source_type` | [shared.SourceHarvestHarvest](../../models/shared/sourceharvestharvest.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceharvestauthenticatewithpersonalaccesstoken.md b/docs/models/shared/sourceharvestauthenticatewithpersonalaccesstoken.md index b62a858d..065e37a0 100644 --- a/docs/models/shared/sourceharvestauthenticatewithpersonalaccesstoken.md +++ b/docs/models/shared/sourceharvestauthenticatewithpersonalaccesstoken.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `api_token` | *str* | :heavy_check_mark: | Log into Harvest and then create new personal access token. | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `auth_type` | [Optional[shared.SourceHarvestSchemasAuthType]](../../models/shared/sourceharvestschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcehubspot.md b/docs/models/shared/sourcehubspot.md index b83596cb..79b82eff 100644 --- a/docs/models/shared/sourcehubspot.md +++ b/docs/models/shared/sourcehubspot.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | | `credentials` | [Union[shared.SourceHubspotOAuth, shared.PrivateApp]](../../models/shared/sourcehubspotauthentication.md) | :heavy_check_mark: | Choose how to authenticate to HubSpot. | | +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2017-01-25T00:00:00Z | | `enable_experimental_streams` | *Optional[bool]* | :heavy_minus_sign: | If enabled then experimental streams become available for sync. | | -| `source_type` | [shared.SourceHubspotHubspot](../../models/shared/sourcehubspothubspot.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2017-01-25T00:00:00Z | \ No newline at end of file +| `source_type` | [shared.SourceHubspotHubspot](../../models/shared/sourcehubspothubspot.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcehubspotoauth.md b/docs/models/shared/sourcehubspotoauth.md index c53e51b2..e09159e9 100644 --- a/docs/models/shared/sourcehubspotoauth.md +++ b/docs/models/shared/sourcehubspotoauth.md @@ -7,5 +7,5 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `client_id` | *str* | :heavy_check_mark: | The Client ID of your HubSpot developer application. See the Hubspot docs if you need help finding this ID. | 123456789000 | | `client_secret` | *str* | :heavy_check_mark: | The client secret for your HubSpot developer application. See the Hubspot docs if you need help finding this secret. | secret | -| `credentials_title` | [shared.SourceHubspotAuthType](../../models/shared/sourcehubspotauthtype.md) | :heavy_check_mark: | Name of the credentials | | -| `refresh_token` | *str* | :heavy_check_mark: | Refresh token to renew an expired access token. See the Hubspot docs if you need help finding this token. | refresh_token | \ No newline at end of file +| `refresh_token` | *str* | :heavy_check_mark: | Refresh token to renew an expired access token. See the Hubspot docs if you need help finding this token. | refresh_token | +| `credentials_title` | [shared.SourceHubspotAuthType](../../models/shared/sourcehubspotauthtype.md) | :heavy_check_mark: | Name of the credentials | | \ No newline at end of file diff --git a/docs/models/shared/sourceinsightly.md b/docs/models/shared/sourceinsightly.md index fc9ff574..85c09bfd 100644 --- a/docs/models/shared/sourceinsightly.md +++ b/docs/models/shared/sourceinsightly.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `source_type` | [shared.Insightly](../../models/shared/insightly.md) | :heavy_check_mark: | N/A | | | `start_date` | *Optional[str]* | :heavy_check_mark: | The date from which you'd like to replicate data for Insightly in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. Note that it will be used only for incremental streams. | 2021-03-01T00:00:00Z | -| `token` | *Optional[str]* | :heavy_check_mark: | Your Insightly API token. | | \ No newline at end of file +| `token` | *Optional[str]* | :heavy_check_mark: | Your Insightly API token. | | +| `source_type` | [shared.Insightly](../../models/shared/insightly.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceintercom.md b/docs/models/shared/sourceintercom.md index eaa8c52f..4cd7e7a3 100644 --- a/docs/models/shared/sourceintercom.md +++ b/docs/models/shared/sourceintercom.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | Access token for making authenticated requests. See the Intercom docs for more information. | | +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2020-11-16T00:00:00Z | | `client_id` | *Optional[str]* | :heavy_minus_sign: | Client Id for your Intercom application. | | | `client_secret` | *Optional[str]* | :heavy_minus_sign: | Client Secret for your Intercom application. | | -| `source_type` | [shared.SourceIntercomIntercom](../../models/shared/sourceintercomintercom.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2020-11-16T00:00:00Z | \ No newline at end of file +| `source_type` | [shared.SourceIntercomIntercom](../../models/shared/sourceintercomintercom.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceiterable.md b/docs/models/shared/sourceiterable.md index 24886815..f56ecf3f 100644 --- a/docs/models/shared/sourceiterable.md +++ b/docs/models/shared/sourceiterable.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Iterable API Key. See the docs for more information on how to obtain this key. | | -| `source_type` | [shared.Iterable](../../models/shared/iterable.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date from which you'd like to replicate data for Iterable, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. | 2021-04-01T00:00:00Z | \ No newline at end of file +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date from which you'd like to replicate data for Iterable, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. | 2021-04-01T00:00:00Z | +| `source_type` | [shared.Iterable](../../models/shared/iterable.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceklarna.md b/docs/models/shared/sourceklarna.md index 969c2348..c9707dcf 100644 --- a/docs/models/shared/sourceklarna.md +++ b/docs/models/shared/sourceklarna.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `password` | *str* | :heavy_check_mark: | A string which is associated with your Merchant ID and is used to authorize use of Klarna's APIs (https://developers.klarna.com/api/#authentication) | -| `playground` | *Optional[bool]* | :heavy_minus_sign: | Propertie defining if connector is used against playground or production environment | | `region` | [shared.SourceKlarnaRegion](../../models/shared/sourceklarnaregion.md) | :heavy_check_mark: | Base url region (For playground eu https://docs.klarna.com/klarna-payments/api/payments-api/#tag/API-URLs). Supported 'eu', 'us', 'oc' | -| `source_type` | [shared.Klarna](../../models/shared/klarna.md) | :heavy_check_mark: | N/A | -| `username` | *str* | :heavy_check_mark: | Consists of your Merchant ID (eid) - a unique number that identifies your e-store, combined with a random string (https://developers.klarna.com/api/#authentication) | \ No newline at end of file +| `username` | *str* | :heavy_check_mark: | Consists of your Merchant ID (eid) - a unique number that identifies your e-store, combined with a random string (https://developers.klarna.com/api/#authentication) | +| `playground` | *Optional[bool]* | :heavy_minus_sign: | Propertie defining if connector is used against playground or production environment | +| `source_type` | [shared.Klarna](../../models/shared/klarna.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcekustomersinger.md b/docs/models/shared/sourcekustomersinger.md index 4aea7e2d..08e44916 100644 --- a/docs/models/shared/sourcekustomersinger.md +++ b/docs/models/shared/sourcekustomersinger.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | `api_token` | *str* | :heavy_check_mark: | Kustomer API Token. See the docs on how to obtain this | | -| `source_type` | [shared.KustomerSinger](../../models/shared/kustomersinger.md) | :heavy_check_mark: | N/A | | -| `start_date` | *str* | :heavy_check_mark: | The date from which you'd like to replicate the data | 2019-01-01T00:00:00Z | \ No newline at end of file +| `start_date` | *str* | :heavy_check_mark: | The date from which you'd like to replicate the data | 2019-01-01T00:00:00Z | +| `source_type` | [shared.KustomerSinger](../../models/shared/kustomersinger.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcekyve.md b/docs/models/shared/sourcekyve.md index 44920522..218ab254 100644 --- a/docs/models/shared/sourcekyve.md +++ b/docs/models/shared/sourcekyve.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `pool_ids` | *str* | :heavy_check_mark: | The IDs of the KYVE storage pool you want to archive. (Comma separated) | 0 | +| `start_ids` | *str* | :heavy_check_mark: | The start-id defines, from which bundle id the pipeline should start to extract the data. (Comma separated) | 0 | | `max_pages` | *Optional[int]* | :heavy_minus_sign: | The maximum amount of pages to go trough. Set to 'null' for all pages. | | | `page_size` | *Optional[int]* | :heavy_minus_sign: | The pagesize for pagination, smaller numbers are used in integration tests. | | -| `pool_ids` | *str* | :heavy_check_mark: | The IDs of the KYVE storage pool you want to archive. (Comma separated) | 0 | | `source_type` | [shared.Kyve](../../models/shared/kyve.md) | :heavy_check_mark: | N/A | | -| `start_ids` | *str* | :heavy_check_mark: | The start-id defines, from which bundle id the pipeline should start to extract the data. (Comma separated) | 0 | | `url_base` | *Optional[str]* | :heavy_minus_sign: | URL to the KYVE Chain API. | https://api.kaon.kyve.network/ | \ No newline at end of file diff --git a/docs/models/shared/sourceleverhiring.md b/docs/models/shared/sourceleverhiring.md index f04eec58..44b3422a 100644 --- a/docs/models/shared/sourceleverhiring.md +++ b/docs/models/shared/sourceleverhiring.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `start_date` | *str* | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. Note that it will be used only in the following incremental streams: comments, commits, and issues. | 2021-03-01T00:00:00Z | | `credentials` | [Optional[Union[shared.AuthenticateViaLeverOAuth, shared.AuthenticateViaLeverAPIKey]]](../../models/shared/sourceleverhiringauthenticationmechanism.md) | :heavy_minus_sign: | Choose how to authenticate to Lever Hiring. | | | `environment` | [Optional[shared.SourceLeverHiringEnvironment]](../../models/shared/sourceleverhiringenvironment.md) | :heavy_minus_sign: | The environment in which you'd like to replicate data for Lever. This is used to determine which Lever API endpoint to use. | | -| `source_type` | [shared.SourceLeverHiringLeverHiring](../../models/shared/sourceleverhiringleverhiring.md) | :heavy_check_mark: | N/A | | -| `start_date` | *str* | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. Note that it will be used only in the following incremental streams: comments, commits, and issues. | 2021-03-01T00:00:00Z | \ No newline at end of file +| `source_type` | [shared.SourceLeverHiringLeverHiring](../../models/shared/sourceleverhiringleverhiring.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcelinkedinads.md b/docs/models/shared/sourcelinkedinads.md index 32a3435f..3ba07928 100644 --- a/docs/models/shared/sourcelinkedinads.md +++ b/docs/models/shared/sourcelinkedinads.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. | 2021-05-17 | | `account_ids` | List[*int*] | :heavy_minus_sign: | Specify the account IDs to pull data from, separated by a space. Leave this field empty if you want to pull the data from all accounts accessible by the authenticated user. See the LinkedIn docs to locate these IDs. | 123456789 | | `ad_analytics_reports` | List[[shared.AdAnalyticsReportConfiguration](../../models/shared/adanalyticsreportconfiguration.md)] | :heavy_minus_sign: | N/A | | | `credentials` | [Optional[Union[shared.SourceLinkedinAdsOAuth20, shared.AccessToken]]](../../models/shared/sourcelinkedinadsauthentication.md) | :heavy_minus_sign: | N/A | | -| `source_type` | [shared.SourceLinkedinAdsLinkedinAds](../../models/shared/sourcelinkedinadslinkedinads.md) | :heavy_check_mark: | N/A | | -| `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. | 2021-05-17 | \ No newline at end of file +| `source_type` | [shared.SourceLinkedinAdsLinkedinAds](../../models/shared/sourcelinkedinadslinkedinads.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcelinkedinadsoauth20.md b/docs/models/shared/sourcelinkedinadsoauth20.md index 24f4295b..0ecda3ac 100644 --- a/docs/models/shared/sourcelinkedinadsoauth20.md +++ b/docs/models/shared/sourcelinkedinadsoauth20.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth_method` | [Optional[shared.SourceLinkedinAdsAuthMethod]](../../models/shared/sourcelinkedinadsauthmethod.md) | :heavy_minus_sign: | N/A | | `client_id` | *str* | :heavy_check_mark: | The client ID of your developer application. Refer to our documentation for more information. | | `client_secret` | *str* | :heavy_check_mark: | The client secret of your developer application. Refer to our documentation for more information. | -| `refresh_token` | *str* | :heavy_check_mark: | The key to refresh the expired access token. Refer to our documentation for more information. | \ No newline at end of file +| `refresh_token` | *str* | :heavy_check_mark: | The key to refresh the expired access token. Refer to our documentation for more information. | +| `auth_method` | [Optional[shared.SourceLinkedinAdsAuthMethod]](../../models/shared/sourcelinkedinadsauthmethod.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcelinkedinpages.md b/docs/models/shared/sourcelinkedinpages.md index b4104088..348f3c45 100644 --- a/docs/models/shared/sourcelinkedinpages.md +++ b/docs/models/shared/sourcelinkedinpages.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Optional[Union[shared.SourceLinkedinPagesOAuth20, shared.SourceLinkedinPagesAccessToken]]](../../models/shared/sourcelinkedinpagesauthentication.md) | :heavy_minus_sign: | N/A | | | `org_id` | *str* | :heavy_check_mark: | Specify the Organization ID | 123456789 | +| `credentials` | [Optional[Union[shared.SourceLinkedinPagesOAuth20, shared.SourceLinkedinPagesAccessToken]]](../../models/shared/sourcelinkedinpagesauthentication.md) | :heavy_minus_sign: | N/A | | | `source_type` | [shared.LinkedinPages](../../models/shared/linkedinpages.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcelinkedinpagesoauth20.md b/docs/models/shared/sourcelinkedinpagesoauth20.md index 28306a3d..3ed62d4a 100644 --- a/docs/models/shared/sourcelinkedinpagesoauth20.md +++ b/docs/models/shared/sourcelinkedinpagesoauth20.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `auth_method` | [Optional[shared.SourceLinkedinPagesAuthMethod]](../../models/shared/sourcelinkedinpagesauthmethod.md) | :heavy_minus_sign: | N/A | | `client_id` | *str* | :heavy_check_mark: | The client ID of the LinkedIn developer application. | | `client_secret` | *str* | :heavy_check_mark: | The client secret of the LinkedIn developer application. | -| `refresh_token` | *str* | :heavy_check_mark: | The token value generated using the LinkedIn Developers OAuth Token Tools. See the docs to obtain yours. | \ No newline at end of file +| `refresh_token` | *str* | :heavy_check_mark: | The token value generated using the LinkedIn Developers OAuth Token Tools. See the docs to obtain yours. | +| `auth_method` | [Optional[shared.SourceLinkedinPagesAuthMethod]](../../models/shared/sourcelinkedinpagesauthmethod.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcelinnworks.md b/docs/models/shared/sourcelinnworks.md index 8ebf6eb9..4e286fb7 100644 --- a/docs/models/shared/sourcelinnworks.md +++ b/docs/models/shared/sourcelinnworks.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | | `application_id` | *str* | :heavy_check_mark: | Linnworks Application ID | | `application_secret` | *str* | :heavy_check_mark: | Linnworks Application Secret | -| `source_type` | [shared.Linnworks](../../models/shared/linnworks.md) | :heavy_check_mark: | N/A | | `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | -| `token` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `token` | *str* | :heavy_check_mark: | N/A | +| `source_type` | [shared.Linnworks](../../models/shared/linnworks.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcemailgun.md b/docs/models/shared/sourcemailgun.md index 390d5fc1..e8efa2f7 100644 --- a/docs/models/shared/sourcemailgun.md +++ b/docs/models/shared/sourcemailgun.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ | -| `domain_region` | *Optional[str]* | :heavy_minus_sign: | Domain region code. 'EU' or 'US' are possible values. The default is 'US'. | | | `private_key` | *str* | :heavy_check_mark: | Primary account API key to access your Mailgun data. | | +| `domain_region` | *Optional[str]* | :heavy_minus_sign: | Domain region code. 'EU' or 'US' are possible values. The default is 'US'. | | | `source_type` | [shared.Mailgun](../../models/shared/mailgun.md) | :heavy_check_mark: | N/A | | | `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | UTC date and time in the format 2020-10-01 00:00:00. Any data before this date will not be replicated. If omitted, defaults to 3 days ago. | 2023-08-01T00:00:00Z | \ No newline at end of file diff --git a/docs/models/shared/sourcemailjetsms.md b/docs/models/shared/sourcemailjetsms.md index db096af9..59ff9638 100644 --- a/docs/models/shared/sourcemailjetsms.md +++ b/docs/models/shared/sourcemailjetsms.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| `token` | *str* | :heavy_check_mark: | Your access token. See here. | | | `end_date` | *Optional[int]* | :heavy_minus_sign: | Retrieve SMS messages created before the specified timestamp. Required format - Unix timestamp. | 1666281656 | | `source_type` | [shared.MailjetSms](../../models/shared/mailjetsms.md) | :heavy_check_mark: | N/A | | -| `start_date` | *Optional[int]* | :heavy_minus_sign: | Retrieve SMS messages created after the specified timestamp. Required format - Unix timestamp. | 1666261656 | -| `token` | *str* | :heavy_check_mark: | Your access token. See here. | | \ No newline at end of file +| `start_date` | *Optional[int]* | :heavy_minus_sign: | Retrieve SMS messages created after the specified timestamp. Required format - Unix timestamp. | 1666261656 | \ No newline at end of file diff --git a/docs/models/shared/sourcemarketo.md b/docs/models/shared/sourcemarketo.md index d2def086..b3ee50b3 100644 --- a/docs/models/shared/sourcemarketo.md +++ b/docs/models/shared/sourcemarketo.md @@ -8,5 +8,5 @@ | `client_id` | *str* | :heavy_check_mark: | The Client ID of your Marketo developer application. See the docs for info on how to obtain this. | | | `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your Marketo developer application. See the docs for info on how to obtain this. | | | `domain_url` | *str* | :heavy_check_mark: | Your Marketo Base URL. See the docs for info on how to obtain this. | https://000-AAA-000.mktorest.com | -| `source_type` | [shared.Marketo](../../models/shared/marketo.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2020-09-25T00:00:00Z | \ No newline at end of file +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2020-09-25T00:00:00Z | +| `source_type` | [shared.Marketo](../../models/shared/marketo.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcemicrosoftteams.md b/docs/models/shared/sourcemicrosoftteams.md index ac2e80c8..ecd115f3 100644 --- a/docs/models/shared/sourcemicrosoftteams.md +++ b/docs/models/shared/sourcemicrosoftteams.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Optional[Union[shared.AuthenticateViaMicrosoftOAuth20, shared.AuthenticateViaMicrosoft]]](../../models/shared/sourcemicrosoftteamsauthenticationmechanism.md) | :heavy_minus_sign: | Choose how to authenticate to Microsoft | | | `period` | *str* | :heavy_check_mark: | Specifies the length of time over which the Team Device Report stream is aggregated. The supported values are: D7, D30, D90, and D180. | D7 | +| `credentials` | [Optional[Union[shared.AuthenticateViaMicrosoftOAuth20, shared.AuthenticateViaMicrosoft]]](../../models/shared/sourcemicrosoftteamsauthenticationmechanism.md) | :heavy_minus_sign: | Choose how to authenticate to Microsoft | | | `source_type` | [shared.SourceMicrosoftTeamsMicrosoftTeams](../../models/shared/sourcemicrosoftteamsmicrosoftteams.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcemixpanel.md b/docs/models/shared/sourcemixpanel.md index 02de3132..59f21672 100644 --- a/docs/models/shared/sourcemixpanel.md +++ b/docs/models/shared/sourcemixpanel.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `attribution_window` | *Optional[int]* | :heavy_minus_sign: | A period of time for attributing results to ads and the lookback period after those actions occur during which ad results are counted. Default attribution window is 5 days. (This value should be non-negative integer) | | | `credentials` | [Union[shared.ServiceAccount, shared.ProjectSecret]](../../models/shared/authenticationwildcard.md) | :heavy_check_mark: | Choose how to authenticate to Mixpanel | | +| `attribution_window` | *Optional[int]* | :heavy_minus_sign: | A period of time for attributing results to ads and the lookback period after those actions occur during which ad results are counted. Default attribution window is 5 days. (This value should be non-negative integer) | | | `date_window_size` | *Optional[int]* | :heavy_minus_sign: | Defines window size in days, that used to slice through data. You can reduce it, if amount of data in each window is too big for your environment. (This value should be positive integer) | | | `end_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date in the format YYYY-MM-DD. Any data after this date will not be replicated. Left empty to always sync to most recent date | 2021-11-16 | | `project_timezone` | *Optional[str]* | :heavy_minus_sign: | Time zone in which integer date times are stored. The project timezone may be found in the project settings in the Mixpanel console. | US/Pacific | diff --git a/docs/models/shared/sourcemondayoauth20.md b/docs/models/shared/sourcemondayoauth20.md index 93bc27d6..048731c1 100644 --- a/docs/models/shared/sourcemondayoauth20.md +++ b/docs/models/shared/sourcemondayoauth20.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | -| `auth_type` | [shared.SourceMondayAuthType](../../models/shared/sourcemondayauthtype.md) | :heavy_check_mark: | N/A | | `client_id` | *str* | :heavy_check_mark: | The Client ID of your OAuth application. | | `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your OAuth application. | +| `auth_type` | [shared.SourceMondayAuthType](../../models/shared/sourcemondayauthtype.md) | :heavy_check_mark: | N/A | | `subdomain` | *Optional[str]* | :heavy_minus_sign: | Slug/subdomain of the account, or the first part of the URL that comes before .monday.com | \ No newline at end of file diff --git a/docs/models/shared/sourcemssql.md b/docs/models/shared/sourcemssql.md index f8723425..d9909877 100644 --- a/docs/models/shared/sourcemssql.md +++ b/docs/models/shared/sourcemssql.md @@ -7,12 +7,12 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `database` | *str* | :heavy_check_mark: | The name of the database. | master | | `host` | *str* | :heavy_check_mark: | The hostname of the database. | | -| `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3). | | | `password` | *str* | :heavy_check_mark: | The password associated with the username. | | | `port` | *int* | :heavy_check_mark: | The port of the database. | 1433 | +| `username` | *str* | :heavy_check_mark: | The username which is used to access the database. | | +| `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3). | | | `replication_method` | [Optional[Union[shared.ReadChangesUsingChangeDataCaptureCDC, shared.ScanChangesWithUserDefinedCursor]]](../../models/shared/updatemethod.md) | :heavy_minus_sign: | Configures how data is extracted from the database. | | | `schemas` | List[*str*] | :heavy_minus_sign: | The list of schemas to sync from. Defaults to user. Case sensitive. | | | `source_type` | [shared.SourceMssqlMssql](../../models/shared/sourcemssqlmssql.md) | :heavy_check_mark: | N/A | | | `ssl_method` | [Optional[Union[shared.Unencrypted, shared.SourceMssqlEncryptedTrustServerCertificate, shared.SourceMssqlEncryptedVerifyCertificate]]](../../models/shared/sourcemssqlsslmethod.md) | :heavy_minus_sign: | The encryption method which is used when communicating with the database. | | -| `tunnel_method` | [Optional[Union[shared.SourceMssqlNoTunnel, shared.SourceMssqlSSHKeyAuthentication, shared.SourceMssqlPasswordAuthentication]]](../../models/shared/sourcemssqlsshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | -| `username` | *str* | :heavy_check_mark: | The username which is used to access the database. | | \ No newline at end of file +| `tunnel_method` | [Optional[Union[shared.SourceMssqlNoTunnel, shared.SourceMssqlSSHKeyAuthentication, shared.SourceMssqlPasswordAuthentication]]](../../models/shared/sourcemssqlsshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | \ No newline at end of file diff --git a/docs/models/shared/sourcemssqlpasswordauthentication.md b/docs/models/shared/sourcemssqlpasswordauthentication.md index 0487d760..44bbae14 100644 --- a/docs/models/shared/sourcemssqlpasswordauthentication.md +++ b/docs/models/shared/sourcemssqlpasswordauthentication.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | -| `tunnel_method` | [shared.SourceMssqlSchemasTunnelMethodTunnelMethod](../../models/shared/sourcemssqlschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | | `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host | | -| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | \ No newline at end of file +| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [shared.SourceMssqlSchemasTunnelMethodTunnelMethod](../../models/shared/sourcemssqlschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/sourcemssqlsshkeyauthentication.md b/docs/models/shared/sourcemssqlsshkeyauthentication.md index 98b3cddc..1415d257 100644 --- a/docs/models/shared/sourcemssqlsshkeyauthentication.md +++ b/docs/models/shared/sourcemssqlsshkeyauthentication.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `ssh_key` | *str* | :heavy_check_mark: | OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa ) | | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | +| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | | `tunnel_method` | [shared.SourceMssqlSchemasTunnelMethod](../../models/shared/sourcemssqlschemastunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and ssh key | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | -| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | \ No newline at end of file +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/sourcemyhours.md b/docs/models/shared/sourcemyhours.md index d0c7e856..c4675fab 100644 --- a/docs/models/shared/sourcemyhours.md +++ b/docs/models/shared/sourcemyhours.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | | `email` | *str* | :heavy_check_mark: | Your My Hours username | john@doe.com | -| `logs_batch_size` | *Optional[int]* | :heavy_minus_sign: | Pagination size used for retrieving logs in days | 30 | | `password` | *str* | :heavy_check_mark: | The password associated to the username | | -| `source_type` | [shared.MyHours](../../models/shared/myhours.md) | :heavy_check_mark: | N/A | | -| `start_date` | *str* | :heavy_check_mark: | Start date for collecting time logs | %Y-%m-%d | \ No newline at end of file +| `start_date` | *str* | :heavy_check_mark: | Start date for collecting time logs | %Y-%m-%d | +| `logs_batch_size` | *Optional[int]* | :heavy_minus_sign: | Pagination size used for retrieving logs in days | 30 | +| `source_type` | [shared.MyHours](../../models/shared/myhours.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcemysql.md b/docs/models/shared/sourcemysql.md index dda7204a..a88bf7f1 100644 --- a/docs/models/shared/sourcemysql.md +++ b/docs/models/shared/sourcemysql.md @@ -7,11 +7,11 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `database` | *str* | :heavy_check_mark: | The database name. | | | `host` | *str* | :heavy_check_mark: | The host name of the database. | | +| `replication_method` | [Union[shared.ReadChangesUsingBinaryLogCDC, shared.SourceMysqlScanChangesWithUserDefinedCursor]](../../models/shared/sourcemysqlupdatemethod.md) | :heavy_check_mark: | Configures how data is extracted from the database. | | +| `username` | *str* | :heavy_check_mark: | The username which is used to access the database. | | | `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3). For more information read about JDBC URL parameters. | | | `password` | *Optional[str]* | :heavy_minus_sign: | The password associated with the username. | | | `port` | *Optional[int]* | :heavy_minus_sign: | The port to connect to. | 3306 | -| `replication_method` | [Union[shared.ReadChangesUsingBinaryLogCDC, shared.SourceMysqlScanChangesWithUserDefinedCursor]](../../models/shared/sourcemysqlupdatemethod.md) | :heavy_check_mark: | Configures how data is extracted from the database. | | | `source_type` | [shared.SourceMysqlMysql](../../models/shared/sourcemysqlmysql.md) | :heavy_check_mark: | N/A | | | `ssl_mode` | [Optional[Union[shared.Preferred, shared.Required, shared.SourceMysqlVerifyCA, shared.VerifyIdentity]]](../../models/shared/sourcemysqlsslmodes.md) | :heavy_minus_sign: | SSL connection modes. Read more in the docs. | | -| `tunnel_method` | [Optional[Union[shared.SourceMysqlNoTunnel, shared.SourceMysqlSSHKeyAuthentication, shared.SourceMysqlPasswordAuthentication]]](../../models/shared/sourcemysqlsshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | -| `username` | *str* | :heavy_check_mark: | The username which is used to access the database. | | \ No newline at end of file +| `tunnel_method` | [Optional[Union[shared.SourceMysqlNoTunnel, shared.SourceMysqlSSHKeyAuthentication, shared.SourceMysqlPasswordAuthentication]]](../../models/shared/sourcemysqlsshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | \ No newline at end of file diff --git a/docs/models/shared/sourcemysqlpasswordauthentication.md b/docs/models/shared/sourcemysqlpasswordauthentication.md index e9855b13..615dc0f5 100644 --- a/docs/models/shared/sourcemysqlpasswordauthentication.md +++ b/docs/models/shared/sourcemysqlpasswordauthentication.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | -| `tunnel_method` | [shared.SourceMysqlSchemasTunnelMethodTunnelMethod](../../models/shared/sourcemysqlschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | | `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host | | -| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | \ No newline at end of file +| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [shared.SourceMysqlSchemasTunnelMethodTunnelMethod](../../models/shared/sourcemysqlschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/sourcemysqlsshkeyauthentication.md b/docs/models/shared/sourcemysqlsshkeyauthentication.md index df86c5f0..9923c40a 100644 --- a/docs/models/shared/sourcemysqlsshkeyauthentication.md +++ b/docs/models/shared/sourcemysqlsshkeyauthentication.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `ssh_key` | *str* | :heavy_check_mark: | OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa ) | | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | +| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | | `tunnel_method` | [shared.SourceMysqlSchemasTunnelMethod](../../models/shared/sourcemysqlschemastunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and ssh key | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | -| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | \ No newline at end of file +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/sourcenetsuite.md b/docs/models/shared/sourcenetsuite.md index de713893..f324f262 100644 --- a/docs/models/shared/sourcenetsuite.md +++ b/docs/models/shared/sourcenetsuite.md @@ -7,10 +7,10 @@ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `consumer_key` | *str* | :heavy_check_mark: | Consumer key associated with your integration | | | `consumer_secret` | *str* | :heavy_check_mark: | Consumer secret associated with your integration | | -| `object_types` | List[*str*] | :heavy_minus_sign: | The API names of the Netsuite objects you want to sync. Setting this speeds up the connection setup process by limiting the number of schemas that need to be retrieved from Netsuite. | customer | | `realm` | *str* | :heavy_check_mark: | Netsuite realm e.g. 2344535, as for `production` or 2344535_SB1, as for the `sandbox` | | -| `source_type` | [shared.Netsuite](../../models/shared/netsuite.md) | :heavy_check_mark: | N/A | | | `start_datetime` | *str* | :heavy_check_mark: | Starting point for your data replication, in format of "YYYY-MM-DDTHH:mm:ssZ" | 2017-01-25T00:00:00Z | | `token_key` | *str* | :heavy_check_mark: | Access token key | | | `token_secret` | *str* | :heavy_check_mark: | Access token secret | | +| `object_types` | List[*str*] | :heavy_minus_sign: | The API names of the Netsuite objects you want to sync. Setting this speeds up the connection setup process by limiting the number of schemas that need to be retrieved from Netsuite. | customer | +| `source_type` | [shared.Netsuite](../../models/shared/netsuite.md) | :heavy_check_mark: | N/A | | | `window_in_days` | *Optional[int]* | :heavy_minus_sign: | The amount of days used to query the data with date chunks. Set smaller value, if you have lots of data. | | \ No newline at end of file diff --git a/docs/models/shared/sourcenotionaccesstoken.md b/docs/models/shared/sourcenotionaccesstoken.md index 2a9235d2..b0bfa153 100644 --- a/docs/models/shared/sourcenotionaccesstoken.md +++ b/docs/models/shared/sourcenotionaccesstoken.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `auth_type` | [shared.SourceNotionSchemasAuthType](../../models/shared/sourcenotionschemasauthtype.md) | :heavy_check_mark: | N/A | -| `token` | *str* | :heavy_check_mark: | The Access Token for your private Notion integration. See the docs for more information on how to obtain this token. | \ No newline at end of file +| `token` | *str* | :heavy_check_mark: | The Access Token for your private Notion integration. See the docs for more information on how to obtain this token. | +| `auth_type` | [shared.SourceNotionSchemasAuthType](../../models/shared/sourcenotionschemasauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcenotionoauth20.md b/docs/models/shared/sourcenotionoauth20.md index cbf51378..bdacef95 100644 --- a/docs/models/shared/sourcenotionoauth20.md +++ b/docs/models/shared/sourcenotionoauth20.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `access_token` | *str* | :heavy_check_mark: | The Access Token received by completing the OAuth flow for your Notion integration. See our docs for more information. | -| `auth_type` | [shared.SourceNotionAuthType](../../models/shared/sourcenotionauthtype.md) | :heavy_check_mark: | N/A | | `client_id` | *str* | :heavy_check_mark: | The Client ID of your Notion integration. See our docs for more information. | -| `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your Notion integration. See our docs for more information. | \ No newline at end of file +| `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your Notion integration. See our docs for more information. | +| `auth_type` | [shared.SourceNotionAuthType](../../models/shared/sourcenotionauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcenytimes.md b/docs/models/shared/sourcenytimes.md index 5ff90139..e677073c 100644 --- a/docs/models/shared/sourcenytimes.md +++ b/docs/models/shared/sourcenytimes.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | API Key | | -| `end_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | End date to stop the article retrieval (format YYYY-MM) | 2022-08 | | `period` | [shared.PeriodUsedForMostPopularStreams](../../models/shared/periodusedformostpopularstreams.md) | :heavy_check_mark: | Period of time (in days) | | +| `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | Start date to begin the article retrieval (format YYYY-MM) | 2022-08 | +| `end_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | End date to stop the article retrieval (format YYYY-MM) | 2022-08 | | `share_type` | [Optional[shared.ShareTypeUsedForMostPopularSharedStream]](../../models/shared/sharetypeusedformostpopularsharedstream.md) | :heavy_minus_sign: | Share Type | | -| `source_type` | [shared.Nytimes](../../models/shared/nytimes.md) | :heavy_check_mark: | N/A | | -| `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | Start date to begin the article retrieval (format YYYY-MM) | 2022-08 | \ No newline at end of file +| `source_type` | [shared.Nytimes](../../models/shared/nytimes.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceoktaoauth20.md b/docs/models/shared/sourceoktaoauth20.md index 789a6347..db692930 100644 --- a/docs/models/shared/sourceoktaoauth20.md +++ b/docs/models/shared/sourceoktaoauth20.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `auth_type` | [shared.SourceOktaAuthType](../../models/shared/sourceoktaauthtype.md) | :heavy_check_mark: | N/A | | `client_id` | *str* | :heavy_check_mark: | The Client ID of your OAuth application. | | `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your OAuth application. | -| `refresh_token` | *str* | :heavy_check_mark: | Refresh Token to obtain new Access Token, when it's expired. | \ No newline at end of file +| `refresh_token` | *str* | :heavy_check_mark: | Refresh Token to obtain new Access Token, when it's expired. | +| `auth_type` | [shared.SourceOktaAuthType](../../models/shared/sourceoktaauthtype.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceonesignal.md b/docs/models/shared/sourceonesignal.md index 1bce2ece..b5b422e0 100644 --- a/docs/models/shared/sourceonesignal.md +++ b/docs/models/shared/sourceonesignal.md @@ -7,6 +7,6 @@ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `applications` | List[[shared.Applications](../../models/shared/applications.md)] | :heavy_check_mark: | Applications keys, see the docs for more information on how to obtain this data | | | `outcome_names` | *str* | :heavy_check_mark: | Comma-separated list of names and the value (sum/count) for the returned outcome data. See the docs for more details | os__session_duration.count,os__click.count,CustomOutcomeName.sum | -| `source_type` | [shared.Onesignal](../../models/shared/onesignal.md) | :heavy_check_mark: | N/A | | | `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date from which you'd like to replicate data for OneSignal API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. | 2020-11-16T00:00:00Z | -| `user_auth_key` | *str* | :heavy_check_mark: | OneSignal User Auth Key, see the docs for more information on how to obtain this key. | | \ No newline at end of file +| `user_auth_key` | *str* | :heavy_check_mark: | OneSignal User Auth Key, see the docs for more information on how to obtain this key. | | +| `source_type` | [shared.Onesignal](../../models/shared/onesignal.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceoracle.md b/docs/models/shared/sourceoracle.md index a9dd11c6..648a6d61 100644 --- a/docs/models/shared/sourceoracle.md +++ b/docs/models/shared/sourceoracle.md @@ -5,13 +5,13 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `connection_data` | [Optional[Union[shared.ServiceName, shared.SystemIDSID]]](../../models/shared/connectby.md) | :heavy_minus_sign: | Connect data that will be used for DB connection | | `encryption` | [Union[shared.NativeNetworkEncryptionNNE, shared.TLSEncryptedVerifyCertificate]](../../models/shared/encryption.md) | :heavy_check_mark: | The encryption method with is used when communicating with the database. | | `host` | *str* | :heavy_check_mark: | Hostname of the database. | +| `username` | *str* | :heavy_check_mark: | The username which is used to access the database. | +| `connection_data` | [Optional[Union[shared.ServiceName, shared.SystemIDSID]]](../../models/shared/connectby.md) | :heavy_minus_sign: | Connect data that will be used for DB connection | | `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3). | | `password` | *Optional[str]* | :heavy_minus_sign: | The password associated with the username. | | `port` | *Optional[int]* | :heavy_minus_sign: | Port of the database.
    Oracle Corporations recommends the following port numbers:
    1521 - Default listening port for client connections to the listener.
    2484 - Recommended and officially registered listening port for client connections to the listener using TCP/IP with SSL | | `schemas` | List[*str*] | :heavy_minus_sign: | The list of schemas to sync from. Defaults to user. Case sensitive. | | `source_type` | [shared.SourceOracleOracle](../../models/shared/sourceoracleoracle.md) | :heavy_check_mark: | N/A | -| `tunnel_method` | [Optional[Union[shared.SourceOracleNoTunnel, shared.SourceOracleSSHKeyAuthentication, shared.SourceOraclePasswordAuthentication]]](../../models/shared/sourceoraclesshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | -| `username` | *str* | :heavy_check_mark: | The username which is used to access the database. | \ No newline at end of file +| `tunnel_method` | [Optional[Union[shared.SourceOracleNoTunnel, shared.SourceOracleSSHKeyAuthentication, shared.SourceOraclePasswordAuthentication]]](../../models/shared/sourceoraclesshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | \ No newline at end of file diff --git a/docs/models/shared/sourceoraclepasswordauthentication.md b/docs/models/shared/sourceoraclepasswordauthentication.md index 66a04980..64c3c5ac 100644 --- a/docs/models/shared/sourceoraclepasswordauthentication.md +++ b/docs/models/shared/sourceoraclepasswordauthentication.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | -| `tunnel_method` | [shared.SourceOracleSchemasTunnelMethodTunnelMethod](../../models/shared/sourceoracleschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | | `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host | | -| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | \ No newline at end of file +| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [shared.SourceOracleSchemasTunnelMethodTunnelMethod](../../models/shared/sourceoracleschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/sourceoraclesshkeyauthentication.md b/docs/models/shared/sourceoraclesshkeyauthentication.md index 0c971056..9660ac72 100644 --- a/docs/models/shared/sourceoraclesshkeyauthentication.md +++ b/docs/models/shared/sourceoraclesshkeyauthentication.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `ssh_key` | *str* | :heavy_check_mark: | OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa ) | | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | +| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | | `tunnel_method` | [shared.SourceOracleSchemasTunnelMethod](../../models/shared/sourceoracleschemastunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and ssh key | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | -| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | \ No newline at end of file +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/sourceorb.md b/docs/models/shared/sourceorb.md index a26b72c6..939adf14 100644 --- a/docs/models/shared/sourceorb.md +++ b/docs/models/shared/sourceorb.md @@ -6,10 +6,10 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Orb API Key, issued from the Orb admin console. | | +| `start_date` | *str* | :heavy_check_mark: | UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at before this data will not be synced. For Subscription Usage, this becomes the `timeframe_start` API parameter. | 2022-03-01T00:00:00Z | | `lookback_window_days` | *Optional[int]* | :heavy_minus_sign: | When set to N, the connector will always refresh resources created within the past N days. By default, updated objects that are not newly created are not incrementally synced. | | | `numeric_event_properties_keys` | List[*str*] | :heavy_minus_sign: | Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction. | | | `plan_id` | *Optional[str]* | :heavy_minus_sign: | Orb Plan ID to filter subscriptions that should have usage fetched. | | | `source_type` | [shared.Orb](../../models/shared/orb.md) | :heavy_check_mark: | N/A | | -| `start_date` | *str* | :heavy_check_mark: | UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at before this data will not be synced. For Subscription Usage, this becomes the `timeframe_start` API parameter. | 2022-03-01T00:00:00Z | | `string_event_properties_keys` | List[*str*] | :heavy_minus_sign: | Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction. | | | `subscription_usage_grouping_key` | *Optional[str]* | :heavy_minus_sign: | Property key name to group subscription usage by. | | \ No newline at end of file diff --git a/docs/models/shared/sourceorbit.md b/docs/models/shared/sourceorbit.md index 7cfc443c..9c1fab51 100644 --- a/docs/models/shared/sourceorbit.md +++ b/docs/models/shared/sourceorbit.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | | `api_token` | *str* | :heavy_check_mark: | Authorizes you to work with Orbit workspaces associated with the token. | +| `workspace` | *str* | :heavy_check_mark: | The unique name of the workspace that your API token is associated with. | | `source_type` | [shared.Orbit](../../models/shared/orbit.md) | :heavy_check_mark: | N/A | -| `start_date` | *Optional[str]* | :heavy_minus_sign: | Date in the format 2022-06-26. Only load members whose last activities are after this date. | -| `workspace` | *str* | :heavy_check_mark: | The unique name of the workspace that your API token is associated with. | \ No newline at end of file +| `start_date` | *Optional[str]* | :heavy_minus_sign: | Date in the format 2022-06-26. Only load members whose last activities are after this date. | \ No newline at end of file diff --git a/docs/models/shared/sourceoutbrainamplify.md b/docs/models/shared/sourceoutbrainamplify.md index d37942fa..18aaf0e8 100644 --- a/docs/models/shared/sourceoutbrainamplify.md +++ b/docs/models/shared/sourceoutbrainamplify.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `credentials` | [Union[shared.SourceOutbrainAmplifyAccessToken, shared.SourceOutbrainAmplifyUsernamePassword]](../../models/shared/sourceoutbrainamplifyauthenticationmethod.md) | :heavy_check_mark: | Credentials for making authenticated requests requires either username/password or access_token. | +| `start_date` | *str* | :heavy_check_mark: | Date in the format YYYY-MM-DD eg. 2017-01-25. Any data before this date will not be replicated. | | `end_date` | *Optional[str]* | :heavy_minus_sign: | Date in the format YYYY-MM-DD. | | `geo_location_breakdown` | [Optional[shared.GranularityForGeoLocationRegion]](../../models/shared/granularityforgeolocationregion.md) | :heavy_minus_sign: | The granularity used for geo location data in reports. | | `report_granularity` | [Optional[shared.GranularityForPeriodicReports]](../../models/shared/granularityforperiodicreports.md) | :heavy_minus_sign: | The granularity used for periodic data in reports. See the docs. | -| `source_type` | [shared.OutbrainAmplify](../../models/shared/outbrainamplify.md) | :heavy_check_mark: | N/A | -| `start_date` | *str* | :heavy_check_mark: | Date in the format YYYY-MM-DD eg. 2017-01-25. Any data before this date will not be replicated. | \ No newline at end of file +| `source_type` | [shared.OutbrainAmplify](../../models/shared/outbrainamplify.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceoutbrainamplifyusernamepassword.md b/docs/models/shared/sourceoutbrainamplifyusernamepassword.md index 4c87cd81..4f5f4b54 100644 --- a/docs/models/shared/sourceoutbrainamplifyusernamepassword.md +++ b/docs/models/shared/sourceoutbrainamplifyusernamepassword.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | `password` | *str* | :heavy_check_mark: | Add Password for authentication. | -| `type` | [shared.BothUsernameAndPasswordIsRequiredForAuthenticationRequest](../../models/shared/bothusernameandpasswordisrequiredforauthenticationrequest.md) | :heavy_check_mark: | N/A | -| `username` | *str* | :heavy_check_mark: | Add Username for authentication. | \ No newline at end of file +| `username` | *str* | :heavy_check_mark: | Add Username for authentication. | +| `type` | [shared.BothUsernameAndPasswordIsRequiredForAuthenticationRequest](../../models/shared/bothusernameandpasswordisrequiredforauthenticationrequest.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceoutreach.md b/docs/models/shared/sourceoutreach.md index 1812507b..d90b2814 100644 --- a/docs/models/shared/sourceoutreach.md +++ b/docs/models/shared/sourceoutreach.md @@ -9,5 +9,5 @@ | `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your Outreach developer application. | | | `redirect_uri` | *str* | :heavy_check_mark: | A Redirect URI is the location where the authorization server sends the user once the app has been successfully authorized and granted an authorization code or access token. | | | `refresh_token` | *str* | :heavy_check_mark: | The token for obtaining the new access token. | | -| `source_type` | [shared.Outreach](../../models/shared/outreach.md) | :heavy_check_mark: | N/A | | -| `start_date` | *str* | :heavy_check_mark: | The date from which you'd like to replicate data for Outreach API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. | 2020-11-16T00:00:00Z | \ No newline at end of file +| `start_date` | *str* | :heavy_check_mark: | The date from which you'd like to replicate data for Outreach API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. | 2020-11-16T00:00:00Z | +| `source_type` | [shared.Outreach](../../models/shared/outreach.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcepaypaltransaction.md b/docs/models/shared/sourcepaypaltransaction.md index 7cd3e533..edebd8f6 100644 --- a/docs/models/shared/sourcepaypaltransaction.md +++ b/docs/models/shared/sourcepaypaltransaction.md @@ -7,8 +7,8 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `client_id` | *str* | :heavy_check_mark: | The Client ID of your Paypal developer application. | | | `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your Paypal developer application. | | +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Start Date for data extraction in ISO format. Date must be in range from 3 years till 12 hrs before present time. | 2021-06-11T23:59:59 | | `is_sandbox` | *Optional[bool]* | :heavy_minus_sign: | Determines whether to use the sandbox or production environment. | | | `refresh_token` | *Optional[str]* | :heavy_minus_sign: | The key to refresh the expired access token. | | | `source_type` | [shared.PaypalTransaction](../../models/shared/paypaltransaction.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Start Date for data extraction in ISO format. Date must be in range from 3 years till 12 hrs before present time. | 2021-06-11T23:59:59 | | `time_window` | *Optional[int]* | :heavy_minus_sign: | The number of days per request. Must be a number between 1 and 31. | | \ No newline at end of file diff --git a/docs/models/shared/sourcepaystack.md b/docs/models/shared/sourcepaystack.md index 0d0a23b8..ea26c8d4 100644 --- a/docs/models/shared/sourcepaystack.md +++ b/docs/models/shared/sourcepaystack.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `lookback_window_days` | *Optional[int]* | :heavy_minus_sign: | When set, the connector will always reload data from the past N days, where N is the value set here. This is useful if your data is updated after creation. | | | `secret_key` | *str* | :heavy_check_mark: | The Paystack API key (usually starts with 'sk_live_'; find yours here). | | -| `source_type` | [shared.Paystack](../../models/shared/paystack.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2017-01-25T00:00:00Z | \ No newline at end of file +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2017-01-25T00:00:00Z | +| `lookback_window_days` | *Optional[int]* | :heavy_minus_sign: | When set, the connector will always reload data from the past N days, where N is the value set here. This is useful if your data is updated after creation. | | +| `source_type` | [shared.Paystack](../../models/shared/paystack.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcepexelsapi.md b/docs/models/shared/sourcepexelsapi.md index 7237aece..8aaaebbf 100644 --- a/docs/models/shared/sourcepexelsapi.md +++ b/docs/models/shared/sourcepexelsapi.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | API key is required to access pexels api, For getting your's goto https://www.pexels.com/api/documentation and create account for free. | | +| `query` | *str* | :heavy_check_mark: | Optional, the search query, Example Ocean, Tigers, Pears, etc. | people | | `color` | *Optional[str]* | :heavy_minus_sign: | Optional, Desired photo color. Supported colors red, orange, yellow, green, turquoise, blue, violet, pink, brown, black, gray, white or any hexidecimal color code. | red | | `locale` | *Optional[str]* | :heavy_minus_sign: | Optional, The locale of the search you are performing. The current supported locales are 'en-US' 'pt-BR' 'es-ES' 'ca-ES' 'de-DE' 'it-IT' 'fr-FR' 'sv-SE' 'id-ID' 'pl-PL' 'ja-JP' 'zh-TW' 'zh-CN' 'ko-KR' 'th-TH' 'nl-NL' 'hu-HU' 'vi-VN' 'cs-CZ' 'da-DK' 'fi-FI' 'uk-UA' 'el-GR' 'ro-RO' 'nb-NO' 'sk-SK' 'tr-TR' 'ru-RU'. | en-US | | `orientation` | *Optional[str]* | :heavy_minus_sign: | Optional, Desired photo orientation. The current supported orientations are landscape, portrait or square | square | -| `query` | *str* | :heavy_check_mark: | Optional, the search query, Example Ocean, Tigers, Pears, etc. | people | | `size` | *Optional[str]* | :heavy_minus_sign: | Optional, Minimum photo size. The current supported sizes are large(24MP), medium(12MP) or small(4MP). | large | | `source_type` | [shared.PexelsAPI](../../models/shared/pexelsapi.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcepolygonstockapi.md b/docs/models/shared/sourcepolygonstockapi.md index be458a98..9c68a2f9 100644 --- a/docs/models/shared/sourcepolygonstockapi.md +++ b/docs/models/shared/sourcepolygonstockapi.md @@ -5,13 +5,13 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `adjusted` | *Optional[str]* | :heavy_minus_sign: | Determines whether or not the results are adjusted for splits. By default, results are adjusted and set to true. Set this to false to get results that are NOT adjusted for splits. | true | | `api_key` | *str* | :heavy_check_mark: | Your API ACCESS Key | | | `end_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | The target date for the aggregate window. | 2020-10-14 | -| `limit` | *Optional[int]* | :heavy_minus_sign: | The target date for the aggregate window. | 100 | | `multiplier` | *int* | :heavy_check_mark: | The size of the timespan multiplier. | 1 | -| `sort` | *Optional[str]* | :heavy_minus_sign: | Sort the results by timestamp. asc will return results in ascending order (oldest at the top), desc will return results in descending order (newest at the top). | asc | -| `source_type` | [shared.PolygonStockAPI](../../models/shared/polygonstockapi.md) | :heavy_check_mark: | N/A | | | `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | The beginning date for the aggregate window. | 2020-10-14 | | `stocks_ticker` | *str* | :heavy_check_mark: | The exchange symbol that this item is traded under. | IBM | -| `timespan` | *str* | :heavy_check_mark: | The size of the time window. | day | \ No newline at end of file +| `timespan` | *str* | :heavy_check_mark: | The size of the time window. | day | +| `adjusted` | *Optional[str]* | :heavy_minus_sign: | Determines whether or not the results are adjusted for splits. By default, results are adjusted and set to true. Set this to false to get results that are NOT adjusted for splits. | true | +| `limit` | *Optional[int]* | :heavy_minus_sign: | The target date for the aggregate window. | 100 | +| `sort` | *Optional[str]* | :heavy_minus_sign: | Sort the results by timestamp. asc will return results in ascending order (oldest at the top), desc will return results in descending order (newest at the top). | asc | +| `source_type` | [shared.PolygonStockAPI](../../models/shared/polygonstockapi.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcepostgres.md b/docs/models/shared/sourcepostgres.md index b000ed80..468dd206 100644 --- a/docs/models/shared/sourcepostgres.md +++ b/docs/models/shared/sourcepostgres.md @@ -7,6 +7,7 @@ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `database` | *str* | :heavy_check_mark: | Name of the database. | | | `host` | *str* | :heavy_check_mark: | Hostname of the database. | | +| `username` | *str* | :heavy_check_mark: | Username to access the database. | | | `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (Eg. key1=value1&key2=value2&key3=value3). For more information read about JDBC URL parameters. | | | `password` | *Optional[str]* | :heavy_minus_sign: | Password associated with the username. | | | `port` | *Optional[int]* | :heavy_minus_sign: | Port of the database. | 5432 | @@ -14,5 +15,4 @@ | `schemas` | List[*str*] | :heavy_minus_sign: | The list of schemas (case sensitive) to sync from. Defaults to public. | | | `source_type` | [shared.SourcePostgresPostgres](../../models/shared/sourcepostgrespostgres.md) | :heavy_check_mark: | N/A | | | `ssl_mode` | [Optional[Union[shared.SourcePostgresDisable, shared.SourcePostgresAllow, shared.SourcePostgresPrefer, shared.SourcePostgresRequire, shared.SourcePostgresVerifyCa, shared.SourcePostgresVerifyFull]]](../../models/shared/sourcepostgressslmodes.md) | :heavy_minus_sign: | SSL connection modes.
    Read more in the docs. | | -| `tunnel_method` | [Optional[Union[shared.SourcePostgresNoTunnel, shared.SourcePostgresSSHKeyAuthentication, shared.SourcePostgresPasswordAuthentication]]](../../models/shared/sourcepostgressshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | -| `username` | *str* | :heavy_check_mark: | Username to access the database. | | \ No newline at end of file +| `tunnel_method` | [Optional[Union[shared.SourcePostgresNoTunnel, shared.SourcePostgresSSHKeyAuthentication, shared.SourcePostgresPasswordAuthentication]]](../../models/shared/sourcepostgressshtunnelmethod.md) | :heavy_minus_sign: | Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use. | | \ No newline at end of file diff --git a/docs/models/shared/sourcepostgrespasswordauthentication.md b/docs/models/shared/sourcepostgrespasswordauthentication.md index f3d8dd32..7ae1344b 100644 --- a/docs/models/shared/sourcepostgrespasswordauthentication.md +++ b/docs/models/shared/sourcepostgrespasswordauthentication.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | -| `tunnel_method` | [shared.SourcePostgresSchemasTunnelMethodTunnelMethod](../../models/shared/sourcepostgresschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | | `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host | | -| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | \ No newline at end of file +| `tunnel_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | | +| `tunnel_method` | [shared.SourcePostgresSchemasTunnelMethodTunnelMethod](../../models/shared/sourcepostgresschemastunnelmethodtunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and password authentication | | +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/sourcepostgressshkeyauthentication.md b/docs/models/shared/sourcepostgressshkeyauthentication.md index 7e17bb51..ece7e5ba 100644 --- a/docs/models/shared/sourcepostgressshkeyauthentication.md +++ b/docs/models/shared/sourcepostgressshkeyauthentication.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `ssh_key` | *str* | :heavy_check_mark: | OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa ) | | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | +| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | | `tunnel_method` | [shared.SourcePostgresSchemasTunnelMethod](../../models/shared/sourcepostgresschemastunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and ssh key | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | -| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | \ No newline at end of file +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/sourcepostgresverifyca.md b/docs/models/shared/sourcepostgresverifyca.md index b6fa69f2..04fa53a3 100644 --- a/docs/models/shared/sourcepostgresverifyca.md +++ b/docs/models/shared/sourcepostgresverifyca.md @@ -7,8 +7,8 @@ Always require encryption and verifies that the source database server has a val | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `ca_certificate` | *str* | :heavy_check_mark: | CA certificate | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `client_certificate` | *Optional[str]* | :heavy_minus_sign: | Client certificate | | `client_key` | *Optional[str]* | :heavy_minus_sign: | Client key | | `client_key_password` | *Optional[str]* | :heavy_minus_sign: | Password for keystorage. If you do not add it - the password will be generated automatically. | diff --git a/docs/models/shared/sourcepostgresverifyfull.md b/docs/models/shared/sourcepostgresverifyfull.md index 9dceeef8..e998ee3e 100644 --- a/docs/models/shared/sourcepostgresverifyfull.md +++ b/docs/models/shared/sourcepostgresverifyfull.md @@ -7,8 +7,8 @@ This is the most secure mode. Always require encryption and verifies the identit | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `ca_certificate` | *str* | :heavy_check_mark: | CA certificate | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `client_certificate` | *Optional[str]* | :heavy_minus_sign: | Client certificate | | `client_key` | *Optional[str]* | :heavy_minus_sign: | Client key | | `client_key_password` | *Optional[str]* | :heavy_minus_sign: | Password for keystorage. If you do not add it - the password will be generated automatically. | diff --git a/docs/models/shared/sourceposthog.md b/docs/models/shared/sourceposthog.md index 85d9792f..a0ff2923 100644 --- a/docs/models/shared/sourceposthog.md +++ b/docs/models/shared/sourceposthog.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | API Key. See the docs for information on how to generate this key. | | +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date from which you'd like to replicate the data. Any data before this date will not be replicated. | 2021-01-01T00:00:00Z | | `base_url` | *Optional[str]* | :heavy_minus_sign: | Base PostHog url. Defaults to PostHog Cloud (https://app.posthog.com). | https://posthog.example.com | | `events_time_step` | *Optional[int]* | :heavy_minus_sign: | Set lower value in case of failing long running sync of events stream. | 30 | -| `source_type` | [shared.Posthog](../../models/shared/posthog.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date from which you'd like to replicate the data. Any data before this date will not be replicated. | 2021-01-01T00:00:00Z | \ No newline at end of file +| `source_type` | [shared.Posthog](../../models/shared/posthog.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceprestashop.md b/docs/models/shared/sourceprestashop.md index 34683ad2..4046a3f3 100644 --- a/docs/models/shared/sourceprestashop.md +++ b/docs/models/shared/sourceprestashop.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `access_key` | *str* | :heavy_check_mark: | Your PrestaShop access key. See the docs for info on how to obtain this. | | -| `source_type` | [shared.Prestashop](../../models/shared/prestashop.md) | :heavy_check_mark: | N/A | | | `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | The Start date in the format YYYY-MM-DD. | 2022-01-01 | -| `url` | *str* | :heavy_check_mark: | Shop URL without trailing slash. | | \ No newline at end of file +| `url` | *str* | :heavy_check_mark: | Shop URL without trailing slash. | | +| `source_type` | [shared.Prestashop](../../models/shared/prestashop.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcequalaroo.md b/docs/models/shared/sourcequalaroo.md index 7c8b29ea..25b28dd5 100644 --- a/docs/models/shared/sourcequalaroo.md +++ b/docs/models/shared/sourcequalaroo.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `key` | *str* | :heavy_check_mark: | A Qualaroo token. See the docs for instructions on how to generate it. | | -| `source_type` | [shared.Qualaroo](../../models/shared/qualaroo.md) | :heavy_check_mark: | N/A | | | `start_date` | *str* | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2021-03-01T00:00:00.000Z | -| `survey_ids` | List[*str*] | :heavy_minus_sign: | IDs of the surveys from which you'd like to replicate data. If left empty, data from all surveys to which you have access will be replicated. | | -| `token` | *str* | :heavy_check_mark: | A Qualaroo token. See the docs for instructions on how to generate it. | | \ No newline at end of file +| `token` | *str* | :heavy_check_mark: | A Qualaroo token. See the docs for instructions on how to generate it. | | +| `source_type` | [shared.Qualaroo](../../models/shared/qualaroo.md) | :heavy_check_mark: | N/A | | +| `survey_ids` | List[*str*] | :heavy_minus_sign: | IDs of the surveys from which you'd like to replicate data. If left empty, data from all surveys to which you have access will be replicated. | | \ No newline at end of file diff --git a/docs/models/shared/sourcequickbooks.md b/docs/models/shared/sourcequickbooks.md index d78bc92c..47581ef4 100644 --- a/docs/models/shared/sourcequickbooks.md +++ b/docs/models/shared/sourcequickbooks.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `credentials` | [Union[shared.SourceQuickbooksOAuth20]](../../models/shared/sourcequickbooksauthorizationmethod.md) | :heavy_check_mark: | N/A | | +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The default value to use if no bookmark exists for an endpoint (rfc3339 date string). E.g, 2021-03-20T00:00:00Z. Any data before this date will not be replicated. | 2021-03-20T00:00:00Z | | `sandbox` | *Optional[bool]* | :heavy_minus_sign: | Determines whether to use the sandbox or production environment. | | -| `source_type` | [shared.Quickbooks](../../models/shared/quickbooks.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The default value to use if no bookmark exists for an endpoint (rfc3339 date string). E.g, 2021-03-20T00:00:00Z. Any data before this date will not be replicated. | 2021-03-20T00:00:00Z | \ No newline at end of file +| `source_type` | [shared.Quickbooks](../../models/shared/quickbooks.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcequickbooksoauth20.md b/docs/models/shared/sourcequickbooksoauth20.md index 1d945f56..08c2d42b 100644 --- a/docs/models/shared/sourcequickbooksoauth20.md +++ b/docs/models/shared/sourcequickbooksoauth20.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | Access token fot making authenticated requests. | -| `auth_type` | [Optional[shared.SourceQuickbooksAuthType]](../../models/shared/sourcequickbooksauthtype.md) | :heavy_minus_sign: | N/A | | `client_id` | *str* | :heavy_check_mark: | Identifies which app is making the request. Obtain this value from the Keys tab on the app profile via My Apps on the developer site. There are two versions of this key: development and production. | | `client_secret` | *str* | :heavy_check_mark: | Obtain this value from the Keys tab on the app profile via My Apps on the developer site. There are two versions of this key: development and production. | | `realm_id` | *str* | :heavy_check_mark: | Labeled Company ID. The Make API Calls panel is populated with the realm id and the current access token. | | `refresh_token` | *str* | :heavy_check_mark: | A token used when refreshing the access token. | -| `token_expiry_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date-time when the access token should be refreshed. | \ No newline at end of file +| `token_expiry_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date-time when the access token should be refreshed. | +| `auth_type` | [Optional[shared.SourceQuickbooksAuthType]](../../models/shared/sourcequickbooksauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcerailz.md b/docs/models/shared/sourcerailz.md index ce67b3c3..0521ee08 100644 --- a/docs/models/shared/sourcerailz.md +++ b/docs/models/shared/sourcerailz.md @@ -7,5 +7,5 @@ | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | | `client_id` | *str* | :heavy_check_mark: | Client ID (client_id) | | `secret_key` | *str* | :heavy_check_mark: | Secret key (secret_key) | -| `source_type` | [shared.Railz](../../models/shared/railz.md) | :heavy_check_mark: | N/A | -| `start_date` | *str* | :heavy_check_mark: | Start date | \ No newline at end of file +| `start_date` | *str* | :heavy_check_mark: | Start date | +| `source_type` | [shared.Railz](../../models/shared/railz.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcerecharge.md b/docs/models/shared/sourcerecharge.md index 284289b2..070cdc8f 100644 --- a/docs/models/shared/sourcerecharge.md +++ b/docs/models/shared/sourcerecharge.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | The value of the Access Token generated. See the docs for more information. | | -| `source_type` | [shared.Recharge](../../models/shared/recharge.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date from which you'd like to replicate data for Recharge API, in the format YYYY-MM-DDT00:00:00Z. Any data before this date will not be replicated. | 2021-05-14T00:00:00Z | \ No newline at end of file +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date from which you'd like to replicate data for Recharge API, in the format YYYY-MM-DDT00:00:00Z. Any data before this date will not be replicated. | 2021-05-14T00:00:00Z | +| `source_type` | [shared.Recharge](../../models/shared/recharge.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceredshift.md b/docs/models/shared/sourceredshift.md index 3346a280..52f19b32 100644 --- a/docs/models/shared/sourceredshift.md +++ b/docs/models/shared/sourceredshift.md @@ -7,9 +7,9 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `database` | *str* | :heavy_check_mark: | Name of the database. | master | | `host` | *str* | :heavy_check_mark: | Host Endpoint of the Redshift Cluster (must include the cluster-id, region and end with .redshift.amazonaws.com). | | -| `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3). | | | `password` | *str* | :heavy_check_mark: | Password associated with the username. | | +| `username` | *str* | :heavy_check_mark: | Username to use to access the database. | | +| `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3). | | | `port` | *Optional[int]* | :heavy_minus_sign: | Port of the database. | 5439 | | `schemas` | List[*str*] | :heavy_minus_sign: | The list of schemas to sync from. Specify one or more explicitly or keep empty to process all schemas. Schema names are case sensitive. | public | -| `source_type` | [shared.SourceRedshiftRedshift](../../models/shared/sourceredshiftredshift.md) | :heavy_check_mark: | N/A | | -| `username` | *str* | :heavy_check_mark: | Username to use to access the database. | | \ No newline at end of file +| `source_type` | [shared.SourceRedshiftRedshift](../../models/shared/sourceredshiftredshift.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcerkicovid.md b/docs/models/shared/sourcerkicovid.md index 1719ec4c..e2a46f18 100644 --- a/docs/models/shared/sourcerkicovid.md +++ b/docs/models/shared/sourcerkicovid.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `source_type` | [shared.RkiCovid](../../models/shared/rkicovid.md) | :heavy_check_mark: | N/A | -| `start_date` | *str* | :heavy_check_mark: | UTC date in the format 2017-01-25. Any data before this date will not be replicated. | \ No newline at end of file +| `start_date` | *str* | :heavy_check_mark: | UTC date in the format 2017-01-25. Any data before this date will not be replicated. | +| `source_type` | [shared.RkiCovid](../../models/shared/rkicovid.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcerss.md b/docs/models/shared/sourcerss.md index 47ea5de7..884c6343 100644 --- a/docs/models/shared/sourcerss.md +++ b/docs/models/shared/sourcerss.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| `source_type` | [shared.Rss](../../models/shared/rss.md) | :heavy_check_mark: | N/A | -| `url` | *str* | :heavy_check_mark: | RSS Feed URL | \ No newline at end of file +| `url` | *str* | :heavy_check_mark: | RSS Feed URL | +| `source_type` | [shared.Rss](../../models/shared/rss.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sources3.md b/docs/models/shared/sources3.md index 8e84365c..e584abce 100644 --- a/docs/models/shared/sources3.md +++ b/docs/models/shared/sources3.md @@ -8,9 +8,10 @@ because it is responsible for converting legacy S3 v3 configs into v4 configs us | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `bucket` | *str* | :heavy_check_mark: | Name of the S3 bucket where the file(s) exist. | | +| `streams` | List[[shared.SourceS3FileBasedStreamConfig](../../models/shared/sources3filebasedstreamconfig.md)] | :heavy_check_mark: | Each instance of this configuration defines a stream. Use this to define which files belong in the stream, their format, and how they should be parsed and validated. When sending data to warehouse destination such as Snowflake or BigQuery, each stream is a separate table. | | | `aws_access_key_id` | *Optional[str]* | :heavy_minus_sign: | In order to access private Buckets stored on AWS S3, this connector requires credentials with the proper permissions. If accessing publicly available data, this field is not necessary. | | | `aws_secret_access_key` | *Optional[str]* | :heavy_minus_sign: | In order to access private Buckets stored on AWS S3, this connector requires credentials with the proper permissions. If accessing publicly available data, this field is not necessary. | | -| `bucket` | *str* | :heavy_check_mark: | Name of the S3 bucket where the file(s) exist. | | | `dataset` | *Optional[str]* | :heavy_minus_sign: | Deprecated and will be removed soon. Please do not use this field anymore and use streams.name instead. The name of the stream you would like this source to output. Can contain letters, numbers, or underscores. | | | `endpoint` | *Optional[str]* | :heavy_minus_sign: | Endpoint to an S3 compatible service. Leave empty to use AWS. The custom endpoint must be secure, but the 'https' prefix is not required. | my-s3-endpoint.com | | `format` | [Optional[Union[shared.Csv, shared.Parquet, shared.Avro, shared.Jsonl]]](../../models/shared/sources3fileformat.md) | :heavy_minus_sign: | Deprecated and will be removed soon. Please do not use this field anymore and use streams.format instead. The format of the files you'd like to replicate | | @@ -18,5 +19,4 @@ because it is responsible for converting legacy S3 v3 configs into v4 configs us | `provider` | [Optional[shared.S3AmazonWebServices]](../../models/shared/s3amazonwebservices.md) | :heavy_minus_sign: | Deprecated and will be removed soon. Please do not use this field anymore and use bucket, aws_access_key_id, aws_secret_access_key and endpoint instead. Use this to load files from S3 or S3-compatible services | | | `schema` | *Optional[str]* | :heavy_minus_sign: | Deprecated and will be removed soon. Please do not use this field anymore and use streams.input_schema instead. Optionally provide a schema to enforce, as a valid JSON string. Ensure this is a mapping of { "column" : "type" }, where types are valid JSON Schema datatypes. Leave as {} to auto-infer the schema. | {"column_1": "number", "column_2": "string", "column_3": "array", "column_4": "object", "column_5": "boolean"} | | `source_type` | [shared.SourceS3S3](../../models/shared/sources3s3.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | UTC date and time in the format 2017-01-25T00:00:00.000000Z. Any file modified before this date will not be replicated. | 2021-01-01T00:00:00.000000Z | -| `streams` | List[[shared.SourceS3FileBasedStreamConfig](../../models/shared/sources3filebasedstreamconfig.md)] | :heavy_check_mark: | Each instance of this configuration defines a stream. Use this to define which files belong in the stream, their format, and how they should be parsed and validated. When sending data to warehouse destination such as Snowflake or BigQuery, each stream is a separate table. | | \ No newline at end of file +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | UTC date and time in the format 2017-01-25T00:00:00.000000Z. Any file modified before this date will not be replicated. | 2021-01-01T00:00:00.000000Z | \ No newline at end of file diff --git a/docs/models/shared/sources3filebasedstreamconfig.md b/docs/models/shared/sources3filebasedstreamconfig.md index 3baf0d47..d044e73a 100644 --- a/docs/models/shared/sources3filebasedstreamconfig.md +++ b/docs/models/shared/sources3filebasedstreamconfig.md @@ -5,12 +5,12 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `days_to_sync_if_history_is_full` | *Optional[int]* | :heavy_minus_sign: | When the state history of the file store is full, syncs will only read files that were last modified in the provided day range. | | `format` | [Union[shared.SourceS3AvroFormat, shared.SourceS3CSVFormat, shared.SourceS3JsonlFormat, shared.SourceS3ParquetFormat, shared.SourceS3DocumentFileTypeFormatExperimental]](../../models/shared/sources3format.md) | :heavy_check_mark: | The configuration options that are used to alter how to read incoming files that deviate from the standard formatting. | +| `name` | *str* | :heavy_check_mark: | The name of the stream. | +| `days_to_sync_if_history_is_full` | *Optional[int]* | :heavy_minus_sign: | When the state history of the file store is full, syncs will only read files that were last modified in the provided day range. | | `globs` | List[*str*] | :heavy_minus_sign: | The pattern used to specify which files should be selected from the file system. For more information on glob pattern matching look here. | | `input_schema` | *Optional[str]* | :heavy_minus_sign: | The schema that will be used to validate records extracted from the file. This will override the stream schema that is auto-detected from incoming files. | | `legacy_prefix` | *Optional[str]* | :heavy_minus_sign: | The path prefix configured in v3 versions of the S3 connector. This option is deprecated in favor of a single glob. | -| `name` | *str* | :heavy_check_mark: | The name of the stream. | | `primary_key` | *Optional[str]* | :heavy_minus_sign: | The column or columns (for a composite key) that serves as the unique identifier of a record. If empty, the primary key will default to the parser's default primary key. | | `schemaless` | *Optional[bool]* | :heavy_minus_sign: | When enabled, syncs will not validate or structure records against the stream's schema. | | `validation_policy` | [Optional[shared.SourceS3ValidationPolicy]](../../models/shared/sources3validationpolicy.md) | :heavy_minus_sign: | The name of the validation policy that dictates sync behavior when a record does not adhere to the stream schema. | \ No newline at end of file diff --git a/docs/models/shared/sourcesalesforce.md b/docs/models/shared/sourcesalesforce.md index fe37cbfd..8d21818c 100644 --- a/docs/models/shared/sourcesalesforce.md +++ b/docs/models/shared/sourcesalesforce.md @@ -5,12 +5,12 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `auth_type` | [Optional[shared.AuthType]](../../models/shared/authtype.md) | :heavy_minus_sign: | N/A | | | `client_id` | *str* | :heavy_check_mark: | Enter your Salesforce developer application's Client ID | | | `client_secret` | *str* | :heavy_check_mark: | Enter your Salesforce developer application's Client secret | | +| `refresh_token` | *str* | :heavy_check_mark: | Enter your application's Salesforce Refresh Token used for Airbyte to access your Salesforce account. | | +| `auth_type` | [Optional[shared.AuthType]](../../models/shared/authtype.md) | :heavy_minus_sign: | N/A | | | `force_use_bulk_api` | *Optional[bool]* | :heavy_minus_sign: | Toggle to use Bulk API (this might cause empty fields for some streams) | | | `is_sandbox` | *Optional[bool]* | :heavy_minus_sign: | Toggle if you're using a Salesforce Sandbox | | -| `refresh_token` | *str* | :heavy_check_mark: | Enter your application's Salesforce Refresh Token used for Airbyte to access your Salesforce account. | | | `source_type` | [shared.SourceSalesforceSalesforce](../../models/shared/sourcesalesforcesalesforce.md) | :heavy_check_mark: | N/A | | | `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Enter the date (or date-time) in the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ format. Airbyte will replicate the data updated on and after this date. If this field is blank, Airbyte will replicate the data for last two years. | 2021-07-25 | | `streams_criteria` | List[[shared.StreamsCriteria](../../models/shared/streamscriteria.md)] | :heavy_minus_sign: | Add filters to select only required stream based on `SObject` name. Use this field to filter which tables are displayed by this connector. This is useful if your Salesforce account has a large number of tables (>1000), in which case you may find it easier to navigate the UI and speed up the connector's performance if you restrict the tables displayed by this connector. | | \ No newline at end of file diff --git a/docs/models/shared/sourcesalesloft.md b/docs/models/shared/sourcesalesloft.md index 3971ec65..d00ec169 100644 --- a/docs/models/shared/sourcesalesloft.md +++ b/docs/models/shared/sourcesalesloft.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `credentials` | [Union[shared.AuthenticateViaOAuth, shared.AuthenticateViaAPIKey]](../../models/shared/sourcesalesloftcredentials.md) | :heavy_check_mark: | N/A | | -| `source_type` | [shared.Salesloft](../../models/shared/salesloft.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date from which you'd like to replicate data for Salesloft API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. | 2020-11-16T00:00:00Z | \ No newline at end of file +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date from which you'd like to replicate data for Salesloft API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. | 2020-11-16T00:00:00Z | +| `source_type` | [shared.Salesloft](../../models/shared/salesloft.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcesenseforce.md b/docs/models/shared/sourcesenseforce.md index 60d7c19c..420fb5dc 100644 --- a/docs/models/shared/sourcesenseforce.md +++ b/docs/models/shared/sourcesenseforce.md @@ -8,6 +8,6 @@ | `access_token` | *str* | :heavy_check_mark: | Your API access token. See here. The toke is case sensitive. | | | `backend_url` | *str* | :heavy_check_mark: | Your Senseforce API backend URL. This is the URL shown during the Login screen. See here for more details. (Note: Most Senseforce backend APIs have the term 'galaxy' in their ULR) | https://galaxyapi.senseforce.io | | `dataset_id` | *str* | :heavy_check_mark: | The ID of the dataset you want to synchronize. The ID can be found in the URL when opening the dataset. See here for more details. (Note: As the Senseforce API only allows to synchronize a specific dataset, each dataset you want to synchronize needs to be implemented as a separate airbyte source). | 8f418098-ca28-4df5-9498-0df9fe78eda7 | +| `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25. Only data with "Timestamp" after this date will be replicated. Important note: This start date must be set to the first day of where your dataset provides data. If your dataset has data from 2020-10-10 10:21:10, set the start_date to 2020-10-10 or later | 2017-01-25 | | `slice_range` | *Optional[int]* | :heavy_minus_sign: | The time increment used by the connector when requesting data from the Senseforce API. The bigger the value is, the less requests will be made and faster the sync will be. On the other hand, the more seldom the state is persisted and the more likely one could run into rate limites. Furthermore, consider that large chunks of time might take a long time for the Senseforce query to return data - meaning it could take in effect longer than with more smaller time slices. If there are a lot of data per day, set this setting to 1. If there is only very little data per day, you might change the setting to 10 or more. | 1 | -| `source_type` | [shared.Senseforce](../../models/shared/senseforce.md) | :heavy_check_mark: | N/A | | -| `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25. Only data with "Timestamp" after this date will be replicated. Important note: This start date must be set to the first day of where your dataset provides data. If your dataset has data from 2020-10-10 10:21:10, set the start_date to 2020-10-10 or later | 2017-01-25 | \ No newline at end of file +| `source_type` | [shared.Senseforce](../../models/shared/senseforce.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcesentry.md b/docs/models/shared/sourcesentry.md index f17cace0..10a11393 100644 --- a/docs/models/shared/sourcesentry.md +++ b/docs/models/shared/sourcesentry.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `auth_token` | *str* | :heavy_check_mark: | Log into Sentry and then create authentication tokens.For self-hosted, you can find or create authentication tokens by visiting "{instance_url_prefix}/settings/account/api/auth-tokens/" | -| `discover_fields` | List[*Any*] | :heavy_minus_sign: | Fields to retrieve when fetching discover events | -| `hostname` | *Optional[str]* | :heavy_minus_sign: | Host name of Sentry API server.For self-hosted, specify your host name here. Otherwise, leave it empty. | | `organization` | *str* | :heavy_check_mark: | The slug of the organization the groups belong to. | | `project` | *str* | :heavy_check_mark: | The name (slug) of the Project you want to sync. | +| `discover_fields` | List[*Any*] | :heavy_minus_sign: | Fields to retrieve when fetching discover events | +| `hostname` | *Optional[str]* | :heavy_minus_sign: | Host name of Sentry API server.For self-hosted, specify your host name here. Otherwise, leave it empty. | | `source_type` | [shared.Sentry](../../models/shared/sentry.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcesftp.md b/docs/models/shared/sourcesftp.md index d1b08d72..2c292a02 100644 --- a/docs/models/shared/sourcesftp.md +++ b/docs/models/shared/sourcesftp.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `host` | *str* | :heavy_check_mark: | The server host address | www.host.com | +| `user` | *str* | :heavy_check_mark: | The server user | | | `credentials` | [Optional[Union[shared.SourceSftpPasswordAuthentication, shared.SourceSftpSSHKeyAuthentication]]](../../models/shared/sourcesftpauthenticationwildcard.md) | :heavy_minus_sign: | The server authentication method | | | `file_pattern` | *Optional[str]* | :heavy_minus_sign: | The regular expression to specify files for sync in a chosen Folder Path | log-([0-9]{4})([0-9]{2})([0-9]{2}) - This will filter files which `log-yearmmdd` | | `file_types` | *Optional[str]* | :heavy_minus_sign: | Coma separated file types. Currently only 'csv' and 'json' types are supported. | csv,json | | `folder_path` | *Optional[str]* | :heavy_minus_sign: | The directory to search files for sync | /logs/2022 | -| `host` | *str* | :heavy_check_mark: | The server host address | www.host.com | | `port` | *Optional[int]* | :heavy_minus_sign: | The server port | 22 | -| `source_type` | [shared.Sftp](../../models/shared/sftp.md) | :heavy_check_mark: | N/A | | -| `user` | *str* | :heavy_check_mark: | The server user | | \ No newline at end of file +| `source_type` | [shared.Sftp](../../models/shared/sftp.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcesftpbulk.md b/docs/models/shared/sourcesftpbulk.md index 60d14f84..927f9f20 100644 --- a/docs/models/shared/sourcesftpbulk.md +++ b/docs/models/shared/sourcesftpbulk.md @@ -5,16 +5,16 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `host` | *str* | :heavy_check_mark: | The server host address | www.host.com | +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date from which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. | 2017-01-25T00:00:00Z | +| `stream_name` | *str* | :heavy_check_mark: | The name of the stream or table you want to create | ftp_contacts | +| `username` | *str* | :heavy_check_mark: | The server user | | | `file_most_recent` | *Optional[bool]* | :heavy_minus_sign: | Sync only the most recent file for the configured folder path and file pattern | | | `file_pattern` | *Optional[str]* | :heavy_minus_sign: | The regular expression to specify files for sync in a chosen Folder Path | log-([0-9]{4})([0-9]{2})([0-9]{2}) - This will filter files which `log-yearmmdd` | | `file_type` | [Optional[shared.FileType]](../../models/shared/filetype.md) | :heavy_minus_sign: | The file type you want to sync. Currently only 'csv' and 'json' files are supported. | csv | | `folder_path` | *Optional[str]* | :heavy_minus_sign: | The directory to search files for sync | /logs/2022 | -| `host` | *str* | :heavy_check_mark: | The server host address | www.host.com | | `password` | *Optional[str]* | :heavy_minus_sign: | OS-level password for logging into the jump server host | | | `port` | *Optional[int]* | :heavy_minus_sign: | The server port | 22 | | `private_key` | *Optional[str]* | :heavy_minus_sign: | The private key | | | `separator` | *Optional[str]* | :heavy_minus_sign: | The separator used in the CSV files. Define None if you want to use the Sniffer functionality | , | -| `source_type` | [shared.SftpBulk](../../models/shared/sftpbulk.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date from which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. | 2017-01-25T00:00:00Z | -| `stream_name` | *str* | :heavy_check_mark: | The name of the stream or table you want to create | ftp_contacts | -| `username` | *str* | :heavy_check_mark: | The server user | | \ No newline at end of file +| `source_type` | [shared.SftpBulk](../../models/shared/sftpbulk.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcesftppasswordauthentication.md b/docs/models/shared/sourcesftppasswordauthentication.md index d5390cd1..3eb2e1c4 100644 --- a/docs/models/shared/sourcesftppasswordauthentication.md +++ b/docs/models/shared/sourcesftppasswordauthentication.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| `auth_method` | [shared.SourceSftpAuthMethod](../../models/shared/sourcesftpauthmethod.md) | :heavy_check_mark: | Connect through password authentication | -| `auth_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | \ No newline at end of file +| `auth_user_password` | *str* | :heavy_check_mark: | OS-level password for logging into the jump server host | +| `auth_method` | [shared.SourceSftpAuthMethod](../../models/shared/sourcesftpauthmethod.md) | :heavy_check_mark: | Connect through password authentication | \ No newline at end of file diff --git a/docs/models/shared/sourcesftpsshkeyauthentication.md b/docs/models/shared/sourcesftpsshkeyauthentication.md index fb70905e..2dfb2801 100644 --- a/docs/models/shared/sourcesftpsshkeyauthentication.md +++ b/docs/models/shared/sourcesftpsshkeyauthentication.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `auth_method` | [shared.SourceSftpSchemasAuthMethod](../../models/shared/sourcesftpschemasauthmethod.md) | :heavy_check_mark: | Connect through ssh key | -| `auth_ssh_key` | *str* | :heavy_check_mark: | OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa ) | \ No newline at end of file +| `auth_ssh_key` | *str* | :heavy_check_mark: | OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa ) | +| `auth_method` | [shared.SourceSftpSchemasAuthMethod](../../models/shared/sourcesftpschemasauthmethod.md) | :heavy_check_mark: | Connect through ssh key | \ No newline at end of file diff --git a/docs/models/shared/sourceshopify.md b/docs/models/shared/sourceshopify.md index 0c766cd0..6a6f1da6 100644 --- a/docs/models/shared/sourceshopify.md +++ b/docs/models/shared/sourceshopify.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Optional[Union[shared.SourceShopifyOAuth20, shared.APIPassword]]](../../models/shared/shopifyauthorizationmethod.md) | :heavy_minus_sign: | The authorization method to use to retrieve data from Shopify | | | `shop` | *str* | :heavy_check_mark: | The name of your Shopify store found in the URL. For example, if your URL was https://NAME.myshopify.com, then the name would be 'NAME' or 'NAME.myshopify.com'. | my-store | +| `credentials` | [Optional[Union[shared.SourceShopifyOAuth20, shared.APIPassword]]](../../models/shared/shopifyauthorizationmethod.md) | :heavy_minus_sign: | The authorization method to use to retrieve data from Shopify | | | `source_type` | [shared.SourceShopifyShopify](../../models/shared/sourceshopifyshopify.md) | :heavy_check_mark: | N/A | | | `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | The date you would like to replicate data from. Format: YYYY-MM-DD. Any data before this date will not be replicated. | | \ No newline at end of file diff --git a/docs/models/shared/sourceshortio.md b/docs/models/shared/sourceshortio.md index e86b188c..dadac010 100644 --- a/docs/models/shared/sourceshortio.md +++ b/docs/models/shared/sourceshortio.md @@ -7,5 +7,5 @@ | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | | `domain_id` | *str* | :heavy_check_mark: | N/A | | | `secret_key` | *str* | :heavy_check_mark: | Short.io Secret Key | | -| `source_type` | [shared.Shortio](../../models/shared/shortio.md) | :heavy_check_mark: | N/A | | -| `start_date` | *str* | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2023-07-30T03:43:59.244Z | \ No newline at end of file +| `start_date` | *str* | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2023-07-30T03:43:59.244Z | +| `source_type` | [shared.Shortio](../../models/shared/shortio.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceslack.md b/docs/models/shared/sourceslack.md index 819daa44..5fb2fbb5 100644 --- a/docs/models/shared/sourceslack.md +++ b/docs/models/shared/sourceslack.md @@ -5,9 +5,9 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2017-01-25T00:00:00Z | | `channel_filter` | List[*str*] | :heavy_minus_sign: | A channel name list (without leading '#' char) which limit the channels from which you'd like to sync. Empty list means no filter. | channel_one | | `credentials` | [Optional[Union[shared.SignInViaSlackOAuth, shared.SourceSlackAPIToken]]](../../models/shared/sourceslackauthenticationmechanism.md) | :heavy_minus_sign: | Choose how to authenticate into Slack | | | `join_channels` | *Optional[bool]* | :heavy_minus_sign: | Whether to join all channels or to sync data only from channels the bot is already in. If false, you'll need to manually add the bot to all the channels from which you'd like to sync messages. | | | `lookback_window` | *Optional[int]* | :heavy_minus_sign: | How far into the past to look for messages in threads, default is 0 days | 7 | -| `source_type` | [shared.SourceSlackSlack](../../models/shared/sourceslackslack.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2017-01-25T00:00:00Z | \ No newline at end of file +| `source_type` | [shared.SourceSlackSlack](../../models/shared/sourceslackslack.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcesmartsheets.md b/docs/models/shared/sourcesmartsheets.md index 7b9ee9ad..266d7c7f 100644 --- a/docs/models/shared/sourcesmartsheets.md +++ b/docs/models/shared/sourcesmartsheets.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `credentials` | [Union[shared.SourceSmartsheetsOAuth20, shared.APIAccessToken]](../../models/shared/sourcesmartsheetsauthorizationmethod.md) | :heavy_check_mark: | N/A | | +| `spreadsheet_id` | *str* | :heavy_check_mark: | The spreadsheet ID. Find it by opening the spreadsheet then navigating to File > Properties | | | `metadata_fields` | List[[shared.Validenums](../../models/shared/validenums.md)] | :heavy_minus_sign: | A List of available columns which metadata can be pulled from. | | | `source_type` | [shared.SourceSmartsheetsSmartsheets](../../models/shared/sourcesmartsheetssmartsheets.md) | :heavy_check_mark: | N/A | | -| `spreadsheet_id` | *str* | :heavy_check_mark: | The spreadsheet ID. Find it by opening the spreadsheet then navigating to File > Properties | | | `start_datetime` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Only rows modified after this date/time will be replicated. This should be an ISO 8601 string, for instance: `2000-01-01T13:00:00` | 2000-01-01T13:00:00 | \ No newline at end of file diff --git a/docs/models/shared/sourcesmartsheetsoauth20.md b/docs/models/shared/sourcesmartsheetsoauth20.md index 25adfc6c..c50f93b2 100644 --- a/docs/models/shared/sourcesmartsheetsoauth20.md +++ b/docs/models/shared/sourcesmartsheetsoauth20.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | -| `auth_type` | [Optional[shared.SourceSmartsheetsAuthType]](../../models/shared/sourcesmartsheetsauthtype.md) | :heavy_minus_sign: | N/A | | `client_id` | *str* | :heavy_check_mark: | The API ID of the SmartSheets developer application. | | `client_secret` | *str* | :heavy_check_mark: | The API Secret the SmartSheets developer application. | | `refresh_token` | *str* | :heavy_check_mark: | The key to refresh the expired access_token. | -| `token_expiry_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date-time when the access token should be refreshed. | \ No newline at end of file +| `token_expiry_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date-time when the access token should be refreshed. | +| `auth_type` | [Optional[shared.SourceSmartsheetsAuthType]](../../models/shared/sourcesmartsheetsauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcesnapchatmarketing.md b/docs/models/shared/sourcesnapchatmarketing.md index 1c84e74c..80feb064 100644 --- a/docs/models/shared/sourcesnapchatmarketing.md +++ b/docs/models/shared/sourcesnapchatmarketing.md @@ -7,7 +7,7 @@ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | | `client_id` | *str* | :heavy_check_mark: | The Client ID of your Snapchat developer application. | | | `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your Snapchat developer application. | | -| `end_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date in the format 2017-01-25. Any data after this date will not be replicated. | 2022-01-30 | | `refresh_token` | *str* | :heavy_check_mark: | Refresh Token to renew the expired Access Token. | | +| `end_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date in the format 2017-01-25. Any data after this date will not be replicated. | 2022-01-30 | | `source_type` | [shared.SourceSnapchatMarketingSnapchatMarketing](../../models/shared/sourcesnapchatmarketingsnapchatmarketing.md) | :heavy_check_mark: | N/A | | | `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Date in the format 2022-01-01. Any data before this date will not be replicated. | 2022-01-01 | \ No newline at end of file diff --git a/docs/models/shared/sourcesnowflake.md b/docs/models/shared/sourcesnowflake.md index d25a3d37..faae3492 100644 --- a/docs/models/shared/sourcesnowflake.md +++ b/docs/models/shared/sourcesnowflake.md @@ -5,11 +5,11 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `credentials` | [Optional[Union[shared.SourceSnowflakeOAuth20, shared.SourceSnowflakeUsernameAndPassword]]](../../models/shared/sourcesnowflakeauthorizationmethod.md) | :heavy_minus_sign: | N/A | | | `database` | *str* | :heavy_check_mark: | The database you created for Airbyte to access data. | AIRBYTE_DATABASE | | `host` | *str* | :heavy_check_mark: | The host domain of the snowflake instance (must include the account, region, cloud environment, and end with snowflakecomputing.com). | accountname.us-east-2.aws.snowflakecomputing.com | -| `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3). | | | `role` | *str* | :heavy_check_mark: | The role you created for Airbyte to access Snowflake. | AIRBYTE_ROLE | +| `warehouse` | *str* | :heavy_check_mark: | The warehouse you created for Airbyte to access data. | AIRBYTE_WAREHOUSE | +| `credentials` | [Optional[Union[shared.SourceSnowflakeOAuth20, shared.SourceSnowflakeUsernameAndPassword]]](../../models/shared/sourcesnowflakeauthorizationmethod.md) | :heavy_minus_sign: | N/A | | +| `jdbc_url_params` | *Optional[str]* | :heavy_minus_sign: | Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3). | | | `schema` | *Optional[str]* | :heavy_minus_sign: | The source Snowflake schema tables. Leave empty to access tables from multiple schemas. | AIRBYTE_SCHEMA | -| `source_type` | [shared.SourceSnowflakeSnowflake](../../models/shared/sourcesnowflakesnowflake.md) | :heavy_check_mark: | N/A | | -| `warehouse` | *str* | :heavy_check_mark: | The warehouse you created for Airbyte to access data. | AIRBYTE_WAREHOUSE | \ No newline at end of file +| `source_type` | [shared.SourceSnowflakeSnowflake](../../models/shared/sourcesnowflakesnowflake.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcesnowflakeoauth20.md b/docs/models/shared/sourcesnowflakeoauth20.md index d9a984cb..23b67539 100644 --- a/docs/models/shared/sourcesnowflakeoauth20.md +++ b/docs/models/shared/sourcesnowflakeoauth20.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `access_token` | *Optional[str]* | :heavy_minus_sign: | Access Token for making authenticated requests. | -| `auth_type` | [shared.SourceSnowflakeAuthType](../../models/shared/sourcesnowflakeauthtype.md) | :heavy_check_mark: | N/A | | `client_id` | *str* | :heavy_check_mark: | The Client ID of your Snowflake developer application. | | `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your Snowflake developer application. | +| `access_token` | *Optional[str]* | :heavy_minus_sign: | Access Token for making authenticated requests. | +| `auth_type` | [shared.SourceSnowflakeAuthType](../../models/shared/sourcesnowflakeauthtype.md) | :heavy_check_mark: | N/A | | `refresh_token` | *Optional[str]* | :heavy_minus_sign: | Refresh Token for making authenticated requests. | \ No newline at end of file diff --git a/docs/models/shared/sourcesnowflakeusernameandpassword.md b/docs/models/shared/sourcesnowflakeusernameandpassword.md index 3e164464..20587118 100644 --- a/docs/models/shared/sourcesnowflakeusernameandpassword.md +++ b/docs/models/shared/sourcesnowflakeusernameandpassword.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `auth_type` | [shared.SourceSnowflakeSchemasAuthType](../../models/shared/sourcesnowflakeschemasauthtype.md) | :heavy_check_mark: | N/A | | | `password` | *str* | :heavy_check_mark: | The password associated with the username. | | -| `username` | *str* | :heavy_check_mark: | The username you created to allow Airbyte to access the database. | AIRBYTE_USER | \ No newline at end of file +| `username` | *str* | :heavy_check_mark: | The username you created to allow Airbyte to access the database. | AIRBYTE_USER | +| `auth_type` | [shared.SourceSnowflakeSchemasAuthType](../../models/shared/sourcesnowflakeschemasauthtype.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcesonarcloud.md b/docs/models/shared/sourcesonarcloud.md index e8cfd059..0b5e1b04 100644 --- a/docs/models/shared/sourcesonarcloud.md +++ b/docs/models/shared/sourcesonarcloud.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | | `component_keys` | List[*Any*] | :heavy_check_mark: | Comma-separated list of component keys. | airbyte-ws-order | -| `end_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | To retrieve issues created before the given date (inclusive). | YYYY-MM-DD | | `organization` | *str* | :heavy_check_mark: | Organization key. See here. | airbyte | +| `user_token` | *str* | :heavy_check_mark: | Your User Token. See here. The token is case sensitive. | | +| `end_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | To retrieve issues created before the given date (inclusive). | YYYY-MM-DD | | `source_type` | [shared.SonarCloud](../../models/shared/sonarcloud.md) | :heavy_check_mark: | N/A | | -| `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | To retrieve issues created after the given date (inclusive). | YYYY-MM-DD | -| `user_token` | *str* | :heavy_check_mark: | Your User Token. See here. The token is case sensitive. | | \ No newline at end of file +| `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | To retrieve issues created after the given date (inclusive). | YYYY-MM-DD | \ No newline at end of file diff --git a/docs/models/shared/sourcestrava.md b/docs/models/shared/sourcestrava.md index 5efc650b..5862be9d 100644 --- a/docs/models/shared/sourcestrava.md +++ b/docs/models/shared/sourcestrava.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | `athlete_id` | *int* | :heavy_check_mark: | The Athlete ID of your Strava developer application. | 17831421 | -| `auth_type` | [Optional[shared.SourceStravaAuthType]](../../models/shared/sourcestravaauthtype.md) | :heavy_minus_sign: | N/A | | | `client_id` | *str* | :heavy_check_mark: | The Client ID of your Strava developer application. | 12345 | | `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your Strava developer application. | fc6243f283e51f6ca989aab298b17da125496f50 | | `refresh_token` | *str* | :heavy_check_mark: | The Refresh Token with the activity: read_all permissions. | fc6243f283e51f6ca989aab298b17da125496f50 | -| `source_type` | [shared.SourceStravaStrava](../../models/shared/sourcestravastrava.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time. Any data before this date will not be replicated. | 2021-03-01T00:00:00Z | \ No newline at end of file +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time. Any data before this date will not be replicated. | 2021-03-01T00:00:00Z | +| `auth_type` | [Optional[shared.SourceStravaAuthType]](../../models/shared/sourcestravaauthtype.md) | :heavy_minus_sign: | N/A | | +| `source_type` | [shared.SourceStravaStrava](../../models/shared/sourcestravastrava.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcestripe.md b/docs/models/shared/sourcestripe.md index 44a4afb5..c48c18cd 100644 --- a/docs/models/shared/sourcestripe.md +++ b/docs/models/shared/sourcestripe.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `account_id` | *str* | :heavy_check_mark: | Your Stripe account ID (starts with 'acct_', find yours here). | | -| `call_rate_limit` | *Optional[int]* | :heavy_minus_sign: | The number of API calls per second that you allow connector to make. This value can not be bigger than real API call rate limit (https://stripe.com/docs/rate-limits). If not specified the default maximum is 25 and 100 calls per second for test and production tokens respectively. | 25 | | `client_secret` | *str* | :heavy_check_mark: | Stripe API key (usually starts with 'sk_live_'; find yours here). | | +| `call_rate_limit` | *Optional[int]* | :heavy_minus_sign: | The number of API calls per second that you allow connector to make. This value can not be bigger than real API call rate limit (https://stripe.com/docs/rate-limits). If not specified the default maximum is 25 and 100 calls per second for test and production tokens respectively. | 25 | | `lookback_window_days` | *Optional[int]* | :heavy_minus_sign: | When set, the connector will always re-export data from the past N days, where N is the value set here. This is useful if your data is frequently updated after creation. The Lookback Window only applies to streams that do not support event-based incremental syncs: Events, SetupAttempts, ShippingRates, BalanceTransactions, Files, FileLinks, Refunds. More info here | | | `num_workers` | *Optional[int]* | :heavy_minus_sign: | The number of worker thread to use for the sync. The performance upper boundary depends on call_rate_limit setting and type of account. | 1 | | `slice_range` | *Optional[int]* | :heavy_minus_sign: | The time increment used by the connector when requesting data from the Stripe API. The bigger the value is, the less requests will be made and faster the sync will be. On the other hand, the more seldom the state is persisted. | 1 | diff --git a/docs/models/shared/sourcesurveymonkey.md b/docs/models/shared/sourcesurveymonkey.md index c97560b1..3df2f871 100644 --- a/docs/models/shared/sourcesurveymonkey.md +++ b/docs/models/shared/sourcesurveymonkey.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2021-01-01T00:00:00Z | | `credentials` | [Optional[shared.SurveyMonkeyAuthorizationMethod]](../../models/shared/surveymonkeyauthorizationmethod.md) | :heavy_minus_sign: | The authorization method to use to retrieve data from SurveyMonkey | | | `origin` | [Optional[shared.OriginDatacenterOfTheSurveyMonkeyAccount]](../../models/shared/origindatacenterofthesurveymonkeyaccount.md) | :heavy_minus_sign: | Depending on the originating datacenter of the SurveyMonkey account, the API access URL may be different. | | | `source_type` | [shared.SourceSurveymonkeySurveymonkey](../../models/shared/sourcesurveymonkeysurveymonkey.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2021-01-01T00:00:00Z | | `survey_ids` | List[*str*] | :heavy_minus_sign: | IDs of the surveys from which you'd like to replicate data. If left empty, data from all boards to which you have access will be replicated. | | \ No newline at end of file diff --git a/docs/models/shared/sourcetheguardianapi.md b/docs/models/shared/sourcetheguardianapi.md index 63709159..a92d8189 100644 --- a/docs/models/shared/sourcetheguardianapi.md +++ b/docs/models/shared/sourcetheguardianapi.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Your API Key. See here. The key is case sensitive. | | +| `start_date` | *str* | :heavy_check_mark: | Use this to set the minimum date (YYYY-MM-DD) of the results. Results older than the start_date will not be shown. | YYYY-MM-DD | | `end_date` | *Optional[str]* | :heavy_minus_sign: | (Optional) Use this to set the maximum date (YYYY-MM-DD) of the results. Results newer than the end_date will not be shown. Default is set to the current date (today) for incremental syncs. | YYYY-MM-DD | | `query` | *Optional[str]* | :heavy_minus_sign: | (Optional) The query (q) parameter filters the results to only those that include that search term. The q parameter supports AND, OR and NOT operators. | environment AND NOT water | | `section` | *Optional[str]* | :heavy_minus_sign: | (Optional) Use this to filter the results by a particular section. See here for a list of all sections, and here for the sections endpoint documentation. | media | | `source_type` | [shared.TheGuardianAPI](../../models/shared/theguardianapi.md) | :heavy_check_mark: | N/A | | -| `start_date` | *str* | :heavy_check_mark: | Use this to set the minimum date (YYYY-MM-DD) of the results. Results older than the start_date will not be shown. | YYYY-MM-DD | | `tag` | *Optional[str]* | :heavy_minus_sign: | (Optional) A tag is a piece of data that is used by The Guardian to categorise content. Use this parameter to filter results by showing only the ones matching the entered tag. See here for a list of all tags, and here for the tags endpoint documentation. | environment/recycling | \ No newline at end of file diff --git a/docs/models/shared/sourcetiktokmarketingoauth20.md b/docs/models/shared/sourcetiktokmarketingoauth20.md index 82141cb9..5d37f8e4 100644 --- a/docs/models/shared/sourcetiktokmarketingoauth20.md +++ b/docs/models/shared/sourcetiktokmarketingoauth20.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | | `access_token` | *str* | :heavy_check_mark: | Long-term Authorized Access Token. | -| `advertiser_id` | *Optional[str]* | :heavy_minus_sign: | The Advertiser ID to filter reports and streams. Let this empty to retrieve all. | | `app_id` | *str* | :heavy_check_mark: | The Developer Application App ID. | -| `auth_type` | [Optional[shared.SourceTiktokMarketingAuthType]](../../models/shared/sourcetiktokmarketingauthtype.md) | :heavy_minus_sign: | N/A | -| `secret` | *str* | :heavy_check_mark: | The Developer Application Secret. | \ No newline at end of file +| `secret` | *str* | :heavy_check_mark: | The Developer Application Secret. | +| `advertiser_id` | *Optional[str]* | :heavy_minus_sign: | The Advertiser ID to filter reports and streams. Let this empty to retrieve all. | +| `auth_type` | [Optional[shared.SourceTiktokMarketingAuthType]](../../models/shared/sourcetiktokmarketingauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcetrello.md b/docs/models/shared/sourcetrello.md index 706cb2ee..7e3c5e16 100644 --- a/docs/models/shared/sourcetrello.md +++ b/docs/models/shared/sourcetrello.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `board_ids` | List[*str*] | :heavy_minus_sign: | IDs of the boards to replicate data from. If left empty, data from all boards to which you have access will be replicated. Please note that this is not the 8-character ID in the board's shortLink (URL of the board). Rather, what is required here is the 24-character ID usually returned by the API | | | `key` | *str* | :heavy_check_mark: | Trello API key. See the docs for instructions on how to generate it. | | -| `source_type` | [shared.Trello](../../models/shared/trello.md) | :heavy_check_mark: | N/A | | | `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. | 2021-03-01T00:00:00Z | -| `token` | *str* | :heavy_check_mark: | Trello API token. See the docs for instructions on how to generate it. | | \ No newline at end of file +| `token` | *str* | :heavy_check_mark: | Trello API token. See the docs for instructions on how to generate it. | | +| `board_ids` | List[*str*] | :heavy_minus_sign: | IDs of the boards to replicate data from. If left empty, data from all boards to which you have access will be replicated. Please note that this is not the 8-character ID in the board's shortLink (URL of the board). Rather, what is required here is the 24-character ID usually returned by the API | | +| `source_type` | [shared.Trello](../../models/shared/trello.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcetrustpilot.md b/docs/models/shared/sourcetrustpilot.md index 8386222a..40418860 100644 --- a/docs/models/shared/sourcetrustpilot.md +++ b/docs/models/shared/sourcetrustpilot.md @@ -7,5 +7,5 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | `business_units` | List[*str*] | :heavy_check_mark: | The names of business units which shall be synchronized. Some streams e.g. configured_business_units or private_reviews use this configuration. | mydomain.com | | `credentials` | [Union[shared.SourceTrustpilotOAuth20, shared.SourceTrustpilotAPIKey]](../../models/shared/sourcetrustpilotauthorizationmethod.md) | :heavy_check_mark: | N/A | | -| `source_type` | [shared.Trustpilot](../../models/shared/trustpilot.md) | :heavy_check_mark: | N/A | | -| `start_date` | *str* | :heavy_check_mark: | For streams with sync. method incremental the start date time to be used | %Y-%m-%dT%H:%M:%S | \ No newline at end of file +| `start_date` | *str* | :heavy_check_mark: | For streams with sync. method incremental the start date time to be used | %Y-%m-%dT%H:%M:%S | +| `source_type` | [shared.Trustpilot](../../models/shared/trustpilot.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcetrustpilotapikey.md b/docs/models/shared/sourcetrustpilotapikey.md index 70bba783..dc8db4ee 100644 --- a/docs/models/shared/sourcetrustpilotapikey.md +++ b/docs/models/shared/sourcetrustpilotapikey.md @@ -7,5 +7,5 @@ The API key authentication method gives you access to only the streams which are | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `auth_type` | [Optional[shared.SourceTrustpilotSchemasAuthType]](../../models/shared/sourcetrustpilotschemasauthtype.md) | :heavy_minus_sign: | N/A | -| `client_id` | *str* | :heavy_check_mark: | The API key of the Trustpilot API application. | \ No newline at end of file +| `client_id` | *str* | :heavy_check_mark: | The API key of the Trustpilot API application. | +| `auth_type` | [Optional[shared.SourceTrustpilotSchemasAuthType]](../../models/shared/sourcetrustpilotschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcetrustpilotoauth20.md b/docs/models/shared/sourcetrustpilotoauth20.md index 2ee27f17..936e36d6 100644 --- a/docs/models/shared/sourcetrustpilotoauth20.md +++ b/docs/models/shared/sourcetrustpilotoauth20.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | -| `auth_type` | [Optional[shared.SourceTrustpilotAuthType]](../../models/shared/sourcetrustpilotauthtype.md) | :heavy_minus_sign: | N/A | | `client_id` | *str* | :heavy_check_mark: | The API key of the Trustpilot API application. (represents the OAuth Client ID) | | `client_secret` | *str* | :heavy_check_mark: | The Secret of the Trustpilot API application. (represents the OAuth Client Secret) | | `refresh_token` | *str* | :heavy_check_mark: | The key to refresh the expired access_token. | -| `token_expiry_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date-time when the access token should be refreshed. | \ No newline at end of file +| `token_expiry_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date-time when the access token should be refreshed. | +| `auth_type` | [Optional[shared.SourceTrustpilotAuthType]](../../models/shared/sourcetrustpilotauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcetvmazeschedule.md b/docs/models/shared/sourcetvmazeschedule.md index d84b9ea6..466cc031 100644 --- a/docs/models/shared/sourcetvmazeschedule.md +++ b/docs/models/shared/sourcetvmazeschedule.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `domestic_schedule_country_code` | *str* | :heavy_check_mark: | Country code for domestic TV schedule retrieval. | US | +| `start_date` | *str* | :heavy_check_mark: | Start date for TV schedule retrieval. May be in the future. | | | `end_date` | *Optional[str]* | :heavy_minus_sign: | End date for TV schedule retrieval. May be in the future. Optional.
    | | | `source_type` | [shared.TvmazeSchedule](../../models/shared/tvmazeschedule.md) | :heavy_check_mark: | N/A | | -| `start_date` | *str* | :heavy_check_mark: | Start date for TV schedule retrieval. May be in the future. | | | `web_schedule_country_code` | *Optional[str]* | :heavy_minus_sign: | ISO 3166-1 country code for web TV schedule retrieval. Leave blank for
    all countries plus global web channels (e.g. Netflix). Alternatively,
    set to 'global' for just global web channels.
    | US | \ No newline at end of file diff --git a/docs/models/shared/sourcetwilio.md b/docs/models/shared/sourcetwilio.md index 6b6a8740..ff28bff9 100644 --- a/docs/models/shared/sourcetwilio.md +++ b/docs/models/shared/sourcetwilio.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | | `account_sid` | *str* | :heavy_check_mark: | Twilio account SID | | | `auth_token` | *str* | :heavy_check_mark: | Twilio Auth Token. | | +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2020-10-01T00:00:00Z. Any data before this date will not be replicated. | 2020-10-01T00:00:00Z | | `lookback_window` | *Optional[int]* | :heavy_minus_sign: | How far into the past to look for records. (in minutes) | 60 | -| `source_type` | [shared.Twilio](../../models/shared/twilio.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | UTC date and time in the format 2020-10-01T00:00:00Z. Any data before this date will not be replicated. | 2020-10-01T00:00:00Z | \ No newline at end of file +| `source_type` | [shared.Twilio](../../models/shared/twilio.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcetwitter.md b/docs/models/shared/sourcetwitter.md index ed46abfe..c0ba340f 100644 --- a/docs/models/shared/sourcetwitter.md +++ b/docs/models/shared/sourcetwitter.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | App only Bearer Token. See the docs for more information on how to obtain this token. | -| `end_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The end date for retrieving tweets must be a minimum of 10 seconds prior to the request time. | | `query` | *str* | :heavy_check_mark: | Query for matching Tweets. You can learn how to build this query by reading build a query guide . | +| `end_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The end date for retrieving tweets must be a minimum of 10 seconds prior to the request time. | | `source_type` | [shared.Twitter](../../models/shared/twitter.md) | :heavy_check_mark: | N/A | | `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The start date for retrieving tweets cannot be more than 7 days in the past. | \ No newline at end of file diff --git a/docs/models/shared/sourcetypeformoauth20.md b/docs/models/shared/sourcetypeformoauth20.md index 3a816e01..56d45bc1 100644 --- a/docs/models/shared/sourcetypeformoauth20.md +++ b/docs/models/shared/sourcetypeformoauth20.md @@ -6,8 +6,8 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | Access Token for making authenticated requests. | -| `auth_type` | [Optional[shared.SourceTypeformAuthType]](../../models/shared/sourcetypeformauthtype.md) | :heavy_minus_sign: | N/A | | `client_id` | *str* | :heavy_check_mark: | The Client ID of the Typeform developer application. | | `client_secret` | *str* | :heavy_check_mark: | The Client Secret the Typeform developer application. | | `refresh_token` | *str* | :heavy_check_mark: | The key to refresh the expired access_token. | -| `token_expiry_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date-time when the access token should be refreshed. | \ No newline at end of file +| `token_expiry_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date-time when the access token should be refreshed. | +| `auth_type` | [Optional[shared.SourceTypeformAuthType]](../../models/shared/sourcetypeformauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourceuscensus.md b/docs/models/shared/sourceuscensus.md index c30a1e0b..58ed260e 100644 --- a/docs/models/shared/sourceuscensus.md +++ b/docs/models/shared/sourceuscensus.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `api_key` | *str* | :heavy_check_mark: | Your API Key. Get your key here. | | -| `query_params` | *Optional[str]* | :heavy_minus_sign: | The query parameters portion of the GET request, without the api key | get=NAME,NAICS2017_LABEL,LFO_LABEL,EMPSZES_LABEL,ESTAB,PAYANN,PAYQTR1,EMP&for=us:*&NAICS2017=72&LFO=001&EMPSZES=001 | | `query_path` | *str* | :heavy_check_mark: | The path portion of the GET request | data/2019/cbp | +| `query_params` | *Optional[str]* | :heavy_minus_sign: | The query parameters portion of the GET request, without the api key | get=NAME,NAICS2017_LABEL,LFO_LABEL,EMPSZES_LABEL,ESTAB,PAYANN,PAYQTR1,EMP&for=us:*&NAICS2017=72&LFO=001&EMPSZES=001 | | `source_type` | [shared.UsCensus](../../models/shared/uscensus.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcewebflow.md b/docs/models/shared/sourcewebflow.md index ccf936d0..2a9be1f7 100644 --- a/docs/models/shared/sourcewebflow.md +++ b/docs/models/shared/sourcewebflow.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| `accept_version` | *Optional[str]* | :heavy_minus_sign: | The version of the Webflow API to use. See https://developers.webflow.com/#versioning | 1.0.0 | | `api_key` | *str* | :heavy_check_mark: | The API token for authenticating to Webflow. See https://university.webflow.com/lesson/intro-to-the-webflow-api | a very long hex sequence | | `site_id` | *str* | :heavy_check_mark: | The id of the Webflow site you are requesting data from. See https://developers.webflow.com/#sites | a relatively long hex sequence | +| `accept_version` | *Optional[str]* | :heavy_minus_sign: | The version of the Webflow API to use. See https://developers.webflow.com/#versioning | 1.0.0 | | `source_type` | [shared.Webflow](../../models/shared/webflow.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcewikipediapageviews.md b/docs/models/shared/sourcewikipediapageviews.md index f7396e1d..fb8a444b 100644 --- a/docs/models/shared/sourcewikipediapageviews.md +++ b/docs/models/shared/sourcewikipediapageviews.md @@ -11,5 +11,5 @@ | `country` | *str* | :heavy_check_mark: | The ISO 3166-1 alpha-2 code of a country for which to retrieve top articles. | FR | | `end` | *str* | :heavy_check_mark: | The date of the last day to include, in YYYYMMDD or YYYYMMDDHH format. | | | `project` | *str* | :heavy_check_mark: | If you want to filter by project, use the domain of any Wikimedia project. | en.wikipedia.org | -| `source_type` | [shared.WikipediaPageviews](../../models/shared/wikipediapageviews.md) | :heavy_check_mark: | N/A | | -| `start` | *str* | :heavy_check_mark: | The date of the first day to include, in YYYYMMDD or YYYYMMDDHH format. | | \ No newline at end of file +| `start` | *str* | :heavy_check_mark: | The date of the first day to include, in YYYYMMDD or YYYYMMDDHH format. | | +| `source_type` | [shared.WikipediaPageviews](../../models/shared/wikipediapageviews.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcewoocommerce.md b/docs/models/shared/sourcewoocommerce.md index 0451280a..fdb3f9a9 100644 --- a/docs/models/shared/sourcewoocommerce.md +++ b/docs/models/shared/sourcewoocommerce.md @@ -8,5 +8,5 @@ | `api_key` | *str* | :heavy_check_mark: | Customer Key for API in WooCommerce shop | | | `api_secret` | *str* | :heavy_check_mark: | Customer Secret for API in WooCommerce shop | | | `shop` | *str* | :heavy_check_mark: | The name of the store. For https://EXAMPLE.com, the shop name is 'EXAMPLE.com'. | | -| `source_type` | [shared.Woocommerce](../../models/shared/woocommerce.md) | :heavy_check_mark: | N/A | | -| `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | The date you would like to replicate data from. Format: YYYY-MM-DD | 2021-01-01 | \ No newline at end of file +| `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | The date you would like to replicate data from. Format: YYYY-MM-DD | 2021-01-01 | +| `source_type` | [shared.Woocommerce](../../models/shared/woocommerce.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceyandexmetrica.md b/docs/models/shared/sourceyandexmetrica.md index 534502e7..089d248d 100644 --- a/docs/models/shared/sourceyandexmetrica.md +++ b/docs/models/shared/sourceyandexmetrica.md @@ -7,6 +7,6 @@ | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | `auth_token` | *str* | :heavy_check_mark: | Your Yandex Metrica API access token | | | `counter_id` | *str* | :heavy_check_mark: | Counter ID | | +| `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | Starting point for your data replication, in format of "YYYY-MM-DD". | 2022-01-01 | | `end_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_minus_sign: | Starting point for your data replication, in format of "YYYY-MM-DD". If not provided will sync till most recent date. | 2022-01-01 | -| `source_type` | [shared.YandexMetrica](../../models/shared/yandexmetrica.md) | :heavy_check_mark: | N/A | | -| `start_date` | [datetime](https://docs.python.org/3/library/datetime.html#datetime-objects) | :heavy_check_mark: | Starting point for your data replication, in format of "YYYY-MM-DD". | 2022-01-01 | \ No newline at end of file +| `source_type` | [shared.YandexMetrica](../../models/shared/yandexmetrica.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourceyotpo.md b/docs/models/shared/sourceyotpo.md index 16278871..209c44e8 100644 --- a/docs/models/shared/sourceyotpo.md +++ b/docs/models/shared/sourceyotpo.md @@ -7,6 +7,6 @@ | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | Access token recieved as a result of API call to https://api.yotpo.com/oauth/token (Ref- https://apidocs.yotpo.com/reference/yotpo-authentication) | | | `app_key` | *str* | :heavy_check_mark: | App key found at settings (Ref- https://settings.yotpo.com/#/general_settings) | | +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Date time filter for incremental filter, Specify which date to extract from. | 2022-03-01T00:00:00.000Z | | `email` | *Optional[str]* | :heavy_minus_sign: | Email address registered with yotpo. | | -| `source_type` | [shared.Yotpo](../../models/shared/yotpo.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | Date time filter for incremental filter, Specify which date to extract from. | 2022-03-01T00:00:00.000Z | \ No newline at end of file +| `source_type` | [shared.Yotpo](../../models/shared/yotpo.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcezendeskchat.md b/docs/models/shared/sourcezendeskchat.md index 5ac9a84c..8b9209ff 100644 --- a/docs/models/shared/sourcezendeskchat.md +++ b/docs/models/shared/sourcezendeskchat.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date from which you'd like to replicate data for Zendesk Chat API, in the format YYYY-MM-DDT00:00:00Z. | 2021-02-01T00:00:00Z | | `credentials` | [Optional[Union[shared.SourceZendeskChatOAuth20, shared.SourceZendeskChatAccessToken]]](../../models/shared/sourcezendeskchatauthorizationmethod.md) | :heavy_minus_sign: | N/A | | | `source_type` | [shared.SourceZendeskChatZendeskChat](../../models/shared/sourcezendeskchatzendeskchat.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date from which you'd like to replicate data for Zendesk Chat API, in the format YYYY-MM-DDT00:00:00Z. | 2021-02-01T00:00:00Z | | `subdomain` | *Optional[str]* | :heavy_minus_sign: | Required if you access Zendesk Chat from a Zendesk Support subdomain. | | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesksunshine.md b/docs/models/shared/sourcezendesksunshine.md index 8d0a146c..64c505ea 100644 --- a/docs/models/shared/sourcezendesksunshine.md +++ b/docs/models/shared/sourcezendesksunshine.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Optional[Union[shared.SourceZendeskSunshineOAuth20, shared.SourceZendeskSunshineAPIToken]]](../../models/shared/sourcezendesksunshineauthorizationmethod.md) | :heavy_minus_sign: | N/A | | -| `source_type` | [shared.SourceZendeskSunshineZendeskSunshine](../../models/shared/sourcezendesksunshinezendesksunshine.md) | :heavy_check_mark: | N/A | | | `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date from which you'd like to replicate data for Zendesk Sunshine API, in the format YYYY-MM-DDT00:00:00Z. | 2021-01-01T00:00:00Z | -| `subdomain` | *str* | :heavy_check_mark: | The subdomain for your Zendesk Account. | | \ No newline at end of file +| `subdomain` | *str* | :heavy_check_mark: | The subdomain for your Zendesk Account. | | +| `credentials` | [Optional[Union[shared.SourceZendeskSunshineOAuth20, shared.SourceZendeskSunshineAPIToken]]](../../models/shared/sourcezendesksunshineauthorizationmethod.md) | :heavy_minus_sign: | N/A | | +| `source_type` | [shared.SourceZendeskSunshineZendeskSunshine](../../models/shared/sourcezendesksunshinezendesksunshine.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesksunshineapitoken.md b/docs/models/shared/sourcezendesksunshineapitoken.md index 49349dc5..2ceb61ea 100644 --- a/docs/models/shared/sourcezendesksunshineapitoken.md +++ b/docs/models/shared/sourcezendesksunshineapitoken.md @@ -6,5 +6,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `api_token` | *str* | :heavy_check_mark: | API Token. See the docs for information on how to generate this key. | -| `auth_method` | [Optional[shared.SourceZendeskSunshineSchemasAuthMethod]](../../models/shared/sourcezendesksunshineschemasauthmethod.md) | :heavy_minus_sign: | N/A | -| `email` | *str* | :heavy_check_mark: | The user email for your Zendesk account | \ No newline at end of file +| `email` | *str* | :heavy_check_mark: | The user email for your Zendesk account | +| `auth_method` | [Optional[shared.SourceZendeskSunshineSchemasAuthMethod]](../../models/shared/sourcezendesksunshineschemasauthmethod.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesksunshineoauth20.md b/docs/models/shared/sourcezendesksunshineoauth20.md index f77b6c11..9b9d7765 100644 --- a/docs/models/shared/sourcezendesksunshineoauth20.md +++ b/docs/models/shared/sourcezendesksunshineoauth20.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `access_token` | *str* | :heavy_check_mark: | Long-term access Token for making authenticated requests. | -| `auth_method` | [Optional[shared.SourceZendeskSunshineAuthMethod]](../../models/shared/sourcezendesksunshineauthmethod.md) | :heavy_minus_sign: | N/A | | `client_id` | *str* | :heavy_check_mark: | The Client ID of your OAuth application. | -| `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your OAuth application. | \ No newline at end of file +| `client_secret` | *str* | :heavy_check_mark: | The Client Secret of your OAuth application. | +| `auth_method` | [Optional[shared.SourceZendeskSunshineAuthMethod]](../../models/shared/sourcezendesksunshineauthmethod.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesksupport.md b/docs/models/shared/sourcezendesksupport.md index 5b086e3a..d946b9fd 100644 --- a/docs/models/shared/sourcezendesksupport.md +++ b/docs/models/shared/sourcezendesksupport.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `subdomain` | *str* | :heavy_check_mark: | This is your unique Zendesk subdomain that can be found in your account URL. For example, in https://MY_SUBDOMAIN.zendesk.com/, MY_SUBDOMAIN is the value of your subdomain. | | | `credentials` | [Optional[Union[shared.SourceZendeskSupportOAuth20, shared.SourceZendeskSupportAPIToken]]](../../models/shared/sourcezendesksupportauthentication.md) | :heavy_minus_sign: | Zendesk allows two authentication methods. We recommend using `OAuth2.0` for Airbyte Cloud users and `API token` for Airbyte Open Source users. | | | `ignore_pagination` | *Optional[bool]* | :heavy_minus_sign: | Makes each stream read a single page of data. | | | `source_type` | [shared.SourceZendeskSupportZendeskSupport](../../models/shared/sourcezendesksupportzendesksupport.md) | :heavy_check_mark: | N/A | | -| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The UTC date and time from which you'd like to replicate data, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. | 2020-10-15T00:00:00Z | -| `subdomain` | *str* | :heavy_check_mark: | This is your unique Zendesk subdomain that can be found in your account URL. For example, in https://MY_SUBDOMAIN.zendesk.com/, MY_SUBDOMAIN is the value of your subdomain. | | \ No newline at end of file +| `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | The UTC date and time from which you'd like to replicate data, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. | 2020-10-15T00:00:00Z | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesksupportapitoken.md b/docs/models/shared/sourcezendesksupportapitoken.md index 2f787cc8..961ccf04 100644 --- a/docs/models/shared/sourcezendesksupportapitoken.md +++ b/docs/models/shared/sourcezendesksupportapitoken.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `api_token` | *str* | :heavy_check_mark: | The value of the API token generated. See our full documentation for more information on generating this token. | -| `credentials` | [Optional[shared.SourceZendeskSupportSchemasCredentials]](../../models/shared/sourcezendesksupportschemascredentials.md) | :heavy_minus_sign: | N/A | -| `email` | *str* | :heavy_check_mark: | The user email for your Zendesk account. | \ No newline at end of file +| `email` | *str* | :heavy_check_mark: | The user email for your Zendesk account. | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `credentials` | [Optional[shared.SourceZendeskSupportSchemasCredentials]](../../models/shared/sourcezendesksupportschemascredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesksupportoauth20.md b/docs/models/shared/sourcezendesksupportoauth20.md index 46a6a893..6c58962b 100644 --- a/docs/models/shared/sourcezendesksupportoauth20.md +++ b/docs/models/shared/sourcezendesksupportoauth20.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `access_token` | *str* | :heavy_check_mark: | The OAuth access token. See the Zendesk docs for more information on generating this token. | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `client_id` | *Optional[str]* | :heavy_minus_sign: | The OAuth client's ID. See this guide for more information. | | `client_secret` | *Optional[str]* | :heavy_minus_sign: | The OAuth client secret. See this guide for more information. | | `credentials` | [Optional[shared.SourceZendeskSupportCredentials]](../../models/shared/sourcezendesksupportcredentials.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesktalk.md b/docs/models/shared/sourcezendesktalk.md index 3d9d6791..e9d9ef97 100644 --- a/docs/models/shared/sourcezendesktalk.md +++ b/docs/models/shared/sourcezendesktalk.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `credentials` | [Optional[Union[shared.SourceZendeskTalkAPIToken, shared.SourceZendeskTalkOAuth20]]](../../models/shared/sourcezendesktalkauthentication.md) | :heavy_minus_sign: | Zendesk service provides two authentication methods. Choose between: `OAuth2.0` or `API token`. | | -| `source_type` | [shared.SourceZendeskTalkZendeskTalk](../../models/shared/sourcezendesktalkzendesktalk.md) | :heavy_check_mark: | N/A | | | `start_date` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_check_mark: | The date from which you'd like to replicate data for Zendesk Talk API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. | 2020-10-15T00:00:00Z | -| `subdomain` | *str* | :heavy_check_mark: | This is your Zendesk subdomain that can be found in your account URL. For example, in https://{MY_SUBDOMAIN}.zendesk.com/, where MY_SUBDOMAIN is the value of your subdomain. | | \ No newline at end of file +| `subdomain` | *str* | :heavy_check_mark: | This is your Zendesk subdomain that can be found in your account URL. For example, in https://{MY_SUBDOMAIN}.zendesk.com/, where MY_SUBDOMAIN is the value of your subdomain. | | +| `credentials` | [Optional[Union[shared.SourceZendeskTalkAPIToken, shared.SourceZendeskTalkOAuth20]]](../../models/shared/sourcezendesktalkauthentication.md) | :heavy_minus_sign: | Zendesk service provides two authentication methods. Choose between: `OAuth2.0` or `API token`. | | +| `source_type` | [shared.SourceZendeskTalkZendeskTalk](../../models/shared/sourcezendesktalkzendesktalk.md) | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesktalkapitoken.md b/docs/models/shared/sourcezendesktalkapitoken.md index 0385a880..4b9b7462 100644 --- a/docs/models/shared/sourcezendesktalkapitoken.md +++ b/docs/models/shared/sourcezendesktalkapitoken.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `api_token` | *str* | :heavy_check_mark: | The value of the API token generated. See the docs for more information. | -| `auth_type` | [Optional[shared.SourceZendeskTalkAuthType]](../../models/shared/sourcezendesktalkauthtype.md) | :heavy_minus_sign: | N/A | -| `email` | *str* | :heavy_check_mark: | The user email for your Zendesk account. | \ No newline at end of file +| `email` | *str* | :heavy_check_mark: | The user email for your Zendesk account. | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | +| `auth_type` | [Optional[shared.SourceZendeskTalkAuthType]](../../models/shared/sourcezendesktalkauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/sourcezendesktalkoauth20.md b/docs/models/shared/sourcezendesktalkoauth20.md index fb72060c..a47ab592 100644 --- a/docs/models/shared/sourcezendesktalkoauth20.md +++ b/docs/models/shared/sourcezendesktalkoauth20.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `access_token` | *str* | :heavy_check_mark: | The value of the API token generated. See the docs for more information. | +| `additional_properties` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | | `auth_type` | [Optional[shared.SourceZendeskTalkSchemasAuthType]](../../models/shared/sourcezendesktalkschemasauthtype.md) | :heavy_minus_sign: | N/A | | `client_id` | *Optional[str]* | :heavy_minus_sign: | Client ID | | `client_secret` | *Optional[str]* | :heavy_minus_sign: | Client Secret | \ No newline at end of file diff --git a/docs/models/shared/sourcezohocrm.md b/docs/models/shared/sourcezohocrm.md index 70b585a8..d7f5f45e 100644 --- a/docs/models/shared/sourcezohocrm.md +++ b/docs/models/shared/sourcezohocrm.md @@ -8,8 +8,8 @@ | `client_id` | *str* | :heavy_check_mark: | OAuth2.0 Client ID | | | `client_secret` | *str* | :heavy_check_mark: | OAuth2.0 Client Secret | | | `dc_region` | [shared.DataCenterLocation](../../models/shared/datacenterlocation.md) | :heavy_check_mark: | Please choose the region of your Data Center location. More info by this Link | | -| `edition` | [Optional[shared.ZohoCRMEdition]](../../models/shared/zohocrmedition.md) | :heavy_minus_sign: | Choose your Edition of Zoho CRM to determine API Concurrency Limits | | | `environment` | [shared.SourceZohoCrmEnvironment](../../models/shared/sourcezohocrmenvironment.md) | :heavy_check_mark: | Please choose the environment | | | `refresh_token` | *str* | :heavy_check_mark: | OAuth2.0 Refresh Token | | +| `edition` | [Optional[shared.ZohoCRMEdition]](../../models/shared/zohocrmedition.md) | :heavy_minus_sign: | Choose your Edition of Zoho CRM to determine API Concurrency Limits | | | `source_type` | [shared.ZohoCrm](../../models/shared/zohocrm.md) | :heavy_check_mark: | N/A | | | `start_datetime` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | ISO 8601, for instance: `YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS+HH:MM` | 2000-01-01 | \ No newline at end of file diff --git a/docs/models/shared/sourcezuora.md b/docs/models/shared/sourcezuora.md index f19cb187..8d6f18ac 100644 --- a/docs/models/shared/sourcezuora.md +++ b/docs/models/shared/sourcezuora.md @@ -7,8 +7,8 @@ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `client_id` | *str* | :heavy_check_mark: | Your OAuth user Client ID | | | `client_secret` | *str* | :heavy_check_mark: | Your OAuth user Client Secret | | -| `data_query` | [Optional[shared.DataQueryType]](../../models/shared/dataquerytype.md) | :heavy_minus_sign: | Choose between `Live`, or `Unlimited` - the optimized, replicated database at 12 hours freshness for high volume extraction Link | | -| `source_type` | [shared.Zuora](../../models/shared/zuora.md) | :heavy_check_mark: | N/A | | | `start_date` | *str* | :heavy_check_mark: | Start Date in format: YYYY-MM-DD | | | `tenant_endpoint` | [shared.TenantEndpointLocation](../../models/shared/tenantendpointlocation.md) | :heavy_check_mark: | Please choose the right endpoint where your Tenant is located. More info by this Link | | +| `data_query` | [Optional[shared.DataQueryType]](../../models/shared/dataquerytype.md) | :heavy_minus_sign: | Choose between `Live`, or `Unlimited` - the optimized, replicated database at 12 hours freshness for high volume extraction Link | | +| `source_type` | [shared.Zuora](../../models/shared/zuora.md) | :heavy_check_mark: | N/A | | | `window_in_days` | *Optional[str]* | :heavy_minus_sign: | The amount of days for each data-chunk begining from start_date. Bigger the value - faster the fetch. (0.1 - as for couple of hours, 1 - as for a Day; 364 - as for a Year). | 0.5 | \ No newline at end of file diff --git a/docs/models/shared/sshkeyauthentication.md b/docs/models/shared/sshkeyauthentication.md index 220710e9..0e547d02 100644 --- a/docs/models/shared/sshkeyauthentication.md +++ b/docs/models/shared/sshkeyauthentication.md @@ -7,6 +7,6 @@ | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | | `ssh_key` | *str* | :heavy_check_mark: | OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa ) | | | `tunnel_host` | *str* | :heavy_check_mark: | Hostname of the jump server host that allows inbound ssh tunnel. | | +| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | | `tunnel_method` | [shared.DestinationClickhouseTunnelMethod](../../models/shared/destinationclickhousetunnelmethod.md) | :heavy_check_mark: | Connect through a jump server tunnel host using username and ssh key | | -| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | -| `tunnel_user` | *str* | :heavy_check_mark: | OS-level username for logging into the jump server host. | | \ No newline at end of file +| `tunnel_port` | *Optional[int]* | :heavy_minus_sign: | Port on the proxy/jump server that accepts inbound ssh connections. | 22 | \ No newline at end of file diff --git a/docs/models/shared/sshsecureshell.md b/docs/models/shared/sshsecureshell.md index b5c9e86f..23a20873 100644 --- a/docs/models/shared/sshsecureshell.md +++ b/docs/models/shared/sshsecureshell.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | `host` | *str* | :heavy_check_mark: | N/A | +| `user` | *str* | :heavy_check_mark: | N/A | | `password` | *Optional[str]* | :heavy_minus_sign: | N/A | | `port` | *Optional[str]* | :heavy_minus_sign: | N/A | -| `storage` | [shared.SourceFileSchemasProviderStorageProviderStorage](../../models/shared/sourcefileschemasproviderstorageproviderstorage.md) | :heavy_check_mark: | N/A | -| `user` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `storage` | [shared.SourceFileSchemasProviderStorageProviderStorage](../../models/shared/sourcefileschemasproviderstorageproviderstorage.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/streamconfiguration.md b/docs/models/shared/streamconfiguration.md index 9237a36d..7d9f1681 100644 --- a/docs/models/shared/streamconfiguration.md +++ b/docs/models/shared/streamconfiguration.md @@ -7,7 +7,7 @@ Configurations for a single stream. | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `cursor_field` | List[*str*] | :heavy_minus_sign: | Path to the field that will be used to determine if a record is new or modified since the last sync. This field is REQUIRED if `sync_mode` is `incremental` unless there is a default. | | `name` | *str* | :heavy_check_mark: | N/A | +| `cursor_field` | List[*str*] | :heavy_minus_sign: | Path to the field that will be used to determine if a record is new or modified since the last sync. This field is REQUIRED if `sync_mode` is `incremental` unless there is a default. | | `primary_key` | List[List[*str*]] | :heavy_minus_sign: | Paths to the fields that will be used as primary key. This field is REQUIRED if `destination_sync_mode` is `*_dedup` unless it is already supplied by the source schema. | | `sync_mode` | [Optional[shared.ConnectionSyncModeEnum]](../../models/shared/connectionsyncmodeenum.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/streamscriteria.md b/docs/models/shared/streamscriteria.md index dc9dfa75..ac7fada4 100644 --- a/docs/models/shared/streamscriteria.md +++ b/docs/models/shared/streamscriteria.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `criteria` | [Optional[shared.SearchCriteria]](../../models/shared/searchcriteria.md) | :heavy_minus_sign: | N/A | -| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `value` | *str* | :heavy_check_mark: | N/A | +| `criteria` | [Optional[shared.SearchCriteria]](../../models/shared/searchcriteria.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/stringfilter.md b/docs/models/shared/stringfilter.md index 72dabb77..965f5fc0 100644 --- a/docs/models/shared/stringfilter.md +++ b/docs/models/shared/stringfilter.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `value` | *str* | :heavy_check_mark: | N/A | | `case_sensitive` | *Optional[bool]* | :heavy_minus_sign: | N/A | | `filter_name` | [shared.FilterName](../../models/shared/filtername.md) | :heavy_check_mark: | N/A | -| `match_type` | List[[shared.SourceGoogleAnalyticsDataAPIValidEnums](../../models/shared/sourcegoogleanalyticsdataapivalidenums.md)] | :heavy_minus_sign: | N/A | -| `value` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `match_type` | List[[shared.SourceGoogleAnalyticsDataAPIValidEnums](../../models/shared/sourcegoogleanalyticsdataapivalidenums.md)] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/systemidsid.md b/docs/models/shared/systemidsid.md index a3288f09..08aafd1e 100644 --- a/docs/models/shared/systemidsid.md +++ b/docs/models/shared/systemidsid.md @@ -7,5 +7,5 @@ Use SID (Oracle System Identifier) | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | -| `connection_type` | [Optional[shared.SourceOracleConnectionType]](../../models/shared/sourceoracleconnectiontype.md) | :heavy_minus_sign: | N/A | -| `sid` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `sid` | *str* | :heavy_check_mark: | N/A | +| `connection_type` | [Optional[shared.SourceOracleConnectionType]](../../models/shared/sourceoracleconnectiontype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/tlsencryptedverifycertificate.md b/docs/models/shared/tlsencryptedverifycertificate.md index 3b62e2cb..2f6f9dbf 100644 --- a/docs/models/shared/tlsencryptedverifycertificate.md +++ b/docs/models/shared/tlsencryptedverifycertificate.md @@ -7,5 +7,5 @@ Verify and use the certificate provided by the server. | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `encryption_method` | [shared.SourceOracleEncryptionMethod](../../models/shared/sourceoracleencryptionmethod.md) | :heavy_check_mark: | N/A | -| `ssl_certificate` | *str* | :heavy_check_mark: | Privacy Enhanced Mail (PEM) files are concatenated certificate containers frequently used in certificate installations. | \ No newline at end of file +| `ssl_certificate` | *str* | :heavy_check_mark: | Privacy Enhanced Mail (PEM) files are concatenated certificate containers frequently used in certificate installations. | +| `encryption_method` | [shared.SourceOracleEncryptionMethod](../../models/shared/sourceoracleencryptionmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/usernameandpassword.md b/docs/models/shared/usernameandpassword.md index 61b2eeb4..93638de0 100644 --- a/docs/models/shared/usernameandpassword.md +++ b/docs/models/shared/usernameandpassword.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | -| `auth_type` | [Optional[shared.DestinationSnowflakeSchemasAuthType]](../../models/shared/destinationsnowflakeschemasauthtype.md) | :heavy_minus_sign: | N/A | -| `password` | *str* | :heavy_check_mark: | Enter the password associated with the username. | \ No newline at end of file +| `password` | *str* | :heavy_check_mark: | Enter the password associated with the username. | +| `auth_type` | [Optional[shared.DestinationSnowflakeSchemasAuthType]](../../models/shared/destinationsnowflakeschemasauthtype.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/shared/usernamepassword.md b/docs/models/shared/usernamepassword.md index dcb2fa84..29c57ddb 100644 --- a/docs/models/shared/usernamepassword.md +++ b/docs/models/shared/usernamepassword.md @@ -7,6 +7,6 @@ Basic auth header with a username and password | Field | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | -| `method` | [shared.DestinationElasticsearchSchemasMethod](../../models/shared/destinationelasticsearchschemasmethod.md) | :heavy_check_mark: | N/A | | `password` | *str* | :heavy_check_mark: | Basic auth password to access a secure Elasticsearch server | -| `username` | *str* | :heavy_check_mark: | Basic auth username to access a secure Elasticsearch server | \ No newline at end of file +| `username` | *str* | :heavy_check_mark: | Basic auth username to access a secure Elasticsearch server | +| `method` | [shared.DestinationElasticsearchSchemasMethod](../../models/shared/destinationelasticsearchschemasmethod.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/shared/workspaceresponse.md b/docs/models/shared/workspaceresponse.md index 01923624..7cc8720b 100644 --- a/docs/models/shared/workspaceresponse.md +++ b/docs/models/shared/workspaceresponse.md @@ -7,6 +7,6 @@ Provides details of a single workspace. | Field | Type | Required | Description | | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| `data_residency` | [Optional[shared.GeographyEnum]](../../models/shared/geographyenum.md) | :heavy_minus_sign: | N/A | | `name` | *str* | :heavy_check_mark: | N/A | -| `workspace_id` | *str* | :heavy_check_mark: | N/A | \ No newline at end of file +| `workspace_id` | *str* | :heavy_check_mark: | N/A | +| `data_residency` | [Optional[shared.GeographyEnum]](../../models/shared/geographyenum.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/sdks/connections/README.md b/docs/sdks/connections/README.md index a89cc959..f0d5563c 100644 --- a/docs/sdks/connections/README.md +++ b/docs/sdks/connections/README.md @@ -29,13 +29,15 @@ s = airbyte.Airbyte( ) req = shared.ConnectionCreateRequest( + destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', + source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', configurations=shared.StreamConfigurations( streams=[ shared.StreamConfiguration( + name='string', cursor_field=[ 'string', ], - name='string', primary_key=[ [ 'string', @@ -44,12 +46,10 @@ req = shared.ConnectionCreateRequest( ), ], ), - destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', namespace_format='${SOURCE_NAMESPACE}', schedule=shared.ConnectionSchedule( - schedule_type=shared.ScheduleTypeEnum.MANUAL, + schedule_type=shared.ScheduleTypeEnum.CRON, ), - source_id='dd427d83-a555-4847-8358-42325b6c7b3f', ) res = s.connections.create_connection(req) @@ -239,10 +239,10 @@ req = operations.PatchConnectionRequest( configurations=shared.StreamConfigurations( streams=[ shared.StreamConfiguration( + name='string', cursor_field=[ 'string', ], - name='string', primary_key=[ [ 'string', diff --git a/docs/sdks/destinations/README.md b/docs/sdks/destinations/README.md index d48ee524..cb3d69b4 100644 --- a/docs/sdks/destinations/README.md +++ b/docs/sdks/destinations/README.md @@ -225,6 +225,7 @@ s = airbyte.Airbyte( ) req = operations.PatchDestinationRequest( + destination_id='string', destination_patch_request=shared.DestinationPatchRequest( configuration=shared.DestinationGoogleSheets( credentials=shared.AuthenticationViaGoogleOAuth( @@ -235,7 +236,6 @@ req = operations.PatchDestinationRequest( spreadsheet_id='https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG/edit', ), ), - destination_id='string', ) res = s.destinations.patch_destination(req) @@ -281,6 +281,7 @@ s = airbyte.Airbyte( ) req = operations.PutDestinationRequest( + destination_id='string', destination_put_request=shared.DestinationPutRequest( configuration=shared.DestinationGoogleSheets( credentials=shared.AuthenticationViaGoogleOAuth( @@ -292,7 +293,6 @@ req = operations.PutDestinationRequest( ), name='string', ), - destination_id='string', ) res = s.destinations.put_destination(req) diff --git a/docs/sdks/sources/README.md b/docs/sdks/sources/README.md index 832a2a72..80831701 100644 --- a/docs/sdks/sources/README.md +++ b/docs/sdks/sources/README.md @@ -179,10 +179,10 @@ s = airbyte.Airbyte( ) req = shared.InitiateOauthRequest( - o_auth_input_configuration=shared.OAuthInputConfiguration(), redirect_url='string', source_type=shared.OAuthActorNames.GOOGLE_ADS, workspace_id='fd28130d-9919-4ffa-a67d-4e12eb099447', + o_auth_input_configuration=shared.OAuthInputConfiguration(), ) res = s.sources.initiate_o_auth(req) @@ -277,6 +277,7 @@ s = airbyte.Airbyte( ) req = operations.PatchSourceRequest( + source_id='string', source_patch_request=shared.SourcePatchRequest( configuration=shared.SourceAha( api_key='string', @@ -284,7 +285,6 @@ req = operations.PatchSourceRequest( ), name='My source', ), - source_id='string', ) res = s.sources.patch_source(req) @@ -331,6 +331,7 @@ s = airbyte.Airbyte( ) req = operations.PutSourceRequest( + source_id='string', source_put_request=shared.SourcePutRequest( configuration=shared.SourceAha( api_key='string', @@ -338,7 +339,6 @@ req = operations.PutSourceRequest( ), name='string', ), - source_id='string', ) res = s.sources.put_source(req) diff --git a/gen.yaml b/gen.yaml index 9bba8e50..32377f29 100644 --- a/gen.yaml +++ b/gen.yaml @@ -7,8 +7,9 @@ generation: fixes: nameResolutionDec2023: false parameterOrderingFeb2024: false + requestResponseComponentNamesFeb2024: false python: - version: 0.46.0 + version: 0.47.0 author: Airbyte clientServerStatusCodesAsErrors: true description: Python Client SDK for Airbyte API diff --git a/setup.py b/setup.py index 6c34a126..2ca3c820 100644 --- a/setup.py +++ b/setup.py @@ -10,7 +10,7 @@ setuptools.setup( name="airbyte-api", - version="0.46.0", + version="0.47.0", author="Airbyte", description="Python Client SDK for Airbyte API", long_description=long_description, diff --git a/src/airbyte/models/operations/canceljob.py b/src/airbyte/models/operations/canceljob.py index 3f307483..dcb69f3d 100644 --- a/src/airbyte/models/operations/canceljob.py +++ b/src/airbyte/models/operations/canceljob.py @@ -18,10 +18,10 @@ class CancelJobRequest: class CancelJobResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" job_response: Optional[shared_jobresponse.JobResponse] = dataclasses.field(default=None) r"""Cancel a Job.""" diff --git a/src/airbyte/models/operations/createconnection.py b/src/airbyte/models/operations/createconnection.py index 0571afa4..ae961e57 100644 --- a/src/airbyte/models/operations/createconnection.py +++ b/src/airbyte/models/operations/createconnection.py @@ -11,10 +11,10 @@ class CreateConnectionResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" connection_response: Optional[shared_connectionresponse.ConnectionResponse] = dataclasses.field(default=None) r"""Successful operation""" diff --git a/src/airbyte/models/operations/createdestination.py b/src/airbyte/models/operations/createdestination.py index b4f07d4f..d9d37872 100644 --- a/src/airbyte/models/operations/createdestination.py +++ b/src/airbyte/models/operations/createdestination.py @@ -11,10 +11,10 @@ class CreateDestinationResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" destination_response: Optional[shared_destinationresponse.DestinationResponse] = dataclasses.field(default=None) r"""Successful operation""" diff --git a/src/airbyte/models/operations/createjob.py b/src/airbyte/models/operations/createjob.py index 4d2b5cb0..0dcc5211 100644 --- a/src/airbyte/models/operations/createjob.py +++ b/src/airbyte/models/operations/createjob.py @@ -11,10 +11,10 @@ class CreateJobResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" job_response: Optional[shared_jobresponse.JobResponse] = dataclasses.field(default=None) r"""Kicks off a new Job based on the JobType. The connectionId is the resource that Job will be run for.""" diff --git a/src/airbyte/models/operations/createorupdateworkspaceoauthcredentials.py b/src/airbyte/models/operations/createorupdateworkspaceoauthcredentials.py index b804c907..45d2ec9c 100644 --- a/src/airbyte/models/operations/createorupdateworkspaceoauthcredentials.py +++ b/src/airbyte/models/operations/createorupdateworkspaceoauthcredentials.py @@ -8,8 +8,8 @@ @dataclasses.dataclass class CreateOrUpdateWorkspaceOAuthCredentialsRequest: - workspace_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'workspaceId', 'style': 'simple', 'explode': False }}) workspace_o_auth_credentials_request: shared_workspaceoauthcredentialsrequest.WorkspaceOAuthCredentialsRequest = dataclasses.field(metadata={'request': { 'media_type': 'application/json' }}) + workspace_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'workspaceId', 'style': 'simple', 'explode': False }}) @@ -18,9 +18,9 @@ class CreateOrUpdateWorkspaceOAuthCredentialsRequest: class CreateOrUpdateWorkspaceOAuthCredentialsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/src/airbyte/models/operations/createsource.py b/src/airbyte/models/operations/createsource.py index e6343419..1d50c9df 100644 --- a/src/airbyte/models/operations/createsource.py +++ b/src/airbyte/models/operations/createsource.py @@ -11,10 +11,10 @@ class CreateSourceResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" source_response: Optional[shared_sourceresponse.SourceResponse] = dataclasses.field(default=None) r"""Successful operation""" diff --git a/src/airbyte/models/operations/createworkspace.py b/src/airbyte/models/operations/createworkspace.py index 3154c9ec..37828857 100644 --- a/src/airbyte/models/operations/createworkspace.py +++ b/src/airbyte/models/operations/createworkspace.py @@ -11,10 +11,10 @@ class CreateWorkspaceResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" workspace_response: Optional[shared_workspaceresponse.WorkspaceResponse] = dataclasses.field(default=None) r"""Successful operation""" diff --git a/src/airbyte/models/operations/deleteconnection.py b/src/airbyte/models/operations/deleteconnection.py index dfc0e464..18b886e9 100644 --- a/src/airbyte/models/operations/deleteconnection.py +++ b/src/airbyte/models/operations/deleteconnection.py @@ -16,9 +16,9 @@ class DeleteConnectionRequest: class DeleteConnectionResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/src/airbyte/models/operations/deletedestination.py b/src/airbyte/models/operations/deletedestination.py index 97ff3528..b28057fc 100644 --- a/src/airbyte/models/operations/deletedestination.py +++ b/src/airbyte/models/operations/deletedestination.py @@ -16,9 +16,9 @@ class DeleteDestinationRequest: class DeleteDestinationResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/src/airbyte/models/operations/deletesource.py b/src/airbyte/models/operations/deletesource.py index e2b40554..4e69e55d 100644 --- a/src/airbyte/models/operations/deletesource.py +++ b/src/airbyte/models/operations/deletesource.py @@ -16,9 +16,9 @@ class DeleteSourceRequest: class DeleteSourceResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/src/airbyte/models/operations/deleteworkspace.py b/src/airbyte/models/operations/deleteworkspace.py index 0624c587..e5e196dd 100644 --- a/src/airbyte/models/operations/deleteworkspace.py +++ b/src/airbyte/models/operations/deleteworkspace.py @@ -16,9 +16,9 @@ class DeleteWorkspaceRequest: class DeleteWorkspaceResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/src/airbyte/models/operations/getconnection.py b/src/airbyte/models/operations/getconnection.py index 3119a9f2..5fa67ed1 100644 --- a/src/airbyte/models/operations/getconnection.py +++ b/src/airbyte/models/operations/getconnection.py @@ -18,10 +18,10 @@ class GetConnectionRequest: class GetConnectionResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" connection_response: Optional[shared_connectionresponse.ConnectionResponse] = dataclasses.field(default=None) r"""Get a Connection by the id in the path.""" diff --git a/src/airbyte/models/operations/getdestination.py b/src/airbyte/models/operations/getdestination.py index 3be484ea..376cda67 100644 --- a/src/airbyte/models/operations/getdestination.py +++ b/src/airbyte/models/operations/getdestination.py @@ -18,10 +18,10 @@ class GetDestinationRequest: class GetDestinationResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" destination_response: Optional[shared_destinationresponse.DestinationResponse] = dataclasses.field(default=None) r"""Get a Destination by the id in the path.""" diff --git a/src/airbyte/models/operations/getjob.py b/src/airbyte/models/operations/getjob.py index 693808da..0388f194 100644 --- a/src/airbyte/models/operations/getjob.py +++ b/src/airbyte/models/operations/getjob.py @@ -18,10 +18,10 @@ class GetJobRequest: class GetJobResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" job_response: Optional[shared_jobresponse.JobResponse] = dataclasses.field(default=None) r"""Get a Job by the id in the path.""" diff --git a/src/airbyte/models/operations/getsource.py b/src/airbyte/models/operations/getsource.py index 68148334..5041abc4 100644 --- a/src/airbyte/models/operations/getsource.py +++ b/src/airbyte/models/operations/getsource.py @@ -18,10 +18,10 @@ class GetSourceRequest: class GetSourceResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" source_response: Optional[shared_sourceresponse.SourceResponse] = dataclasses.field(default=None) r"""Get a Source by the id in the path.""" diff --git a/src/airbyte/models/operations/getstreamproperties.py b/src/airbyte/models/operations/getstreamproperties.py index 9cb9b92b..8a17c4e4 100644 --- a/src/airbyte/models/operations/getstreamproperties.py +++ b/src/airbyte/models/operations/getstreamproperties.py @@ -23,10 +23,10 @@ class GetStreamPropertiesRequest: class GetStreamPropertiesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" stream_properties_response: Optional[shared_streampropertiesresponse.StreamPropertiesResponse] = dataclasses.field(default=None) r"""Get the available streams properties for a source/destination pair.""" diff --git a/src/airbyte/models/operations/getworkspace.py b/src/airbyte/models/operations/getworkspace.py index 73951135..01cbd395 100644 --- a/src/airbyte/models/operations/getworkspace.py +++ b/src/airbyte/models/operations/getworkspace.py @@ -18,10 +18,10 @@ class GetWorkspaceRequest: class GetWorkspaceResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" workspace_response: Optional[shared_workspaceresponse.WorkspaceResponse] = dataclasses.field(default=None) r"""Get a Workspace by the id in the path.""" diff --git a/src/airbyte/models/operations/initiateoauth.py b/src/airbyte/models/operations/initiateoauth.py index ae88f3ef..86413a38 100644 --- a/src/airbyte/models/operations/initiateoauth.py +++ b/src/airbyte/models/operations/initiateoauth.py @@ -9,9 +9,9 @@ class InitiateOAuthResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" diff --git a/src/airbyte/models/operations/listconnections.py b/src/airbyte/models/operations/listconnections.py index b461e12f..58b4990f 100644 --- a/src/airbyte/models/operations/listconnections.py +++ b/src/airbyte/models/operations/listconnections.py @@ -25,10 +25,10 @@ class ListConnectionsRequest: class ListConnectionsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" connections_response: Optional[shared_connectionsresponse.ConnectionsResponse] = dataclasses.field(default=None) r"""Successful operation""" diff --git a/src/airbyte/models/operations/listdestinations.py b/src/airbyte/models/operations/listdestinations.py index 98ab1af6..34b96ec5 100644 --- a/src/airbyte/models/operations/listdestinations.py +++ b/src/airbyte/models/operations/listdestinations.py @@ -25,10 +25,10 @@ class ListDestinationsRequest: class ListDestinationsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" destinations_response: Optional[shared_destinationsresponse.DestinationsResponse] = dataclasses.field(default=None) r"""Successful operation""" diff --git a/src/airbyte/models/operations/listjobs.py b/src/airbyte/models/operations/listjobs.py index 6a014298..da35e25b 100644 --- a/src/airbyte/models/operations/listjobs.py +++ b/src/airbyte/models/operations/listjobs.py @@ -42,10 +42,10 @@ class ListJobsRequest: class ListJobsResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" jobs_response: Optional[shared_jobsresponse.JobsResponse] = dataclasses.field(default=None) r"""List all the Jobs by connectionId.""" diff --git a/src/airbyte/models/operations/listsources.py b/src/airbyte/models/operations/listsources.py index 1ac1fed4..c76a9a10 100644 --- a/src/airbyte/models/operations/listsources.py +++ b/src/airbyte/models/operations/listsources.py @@ -25,10 +25,10 @@ class ListSourcesRequest: class ListSourcesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" sources_response: Optional[shared_sourcesresponse.SourcesResponse] = dataclasses.field(default=None) r"""Successful operation""" diff --git a/src/airbyte/models/operations/listworkspaces.py b/src/airbyte/models/operations/listworkspaces.py index f428e627..c36c206a 100644 --- a/src/airbyte/models/operations/listworkspaces.py +++ b/src/airbyte/models/operations/listworkspaces.py @@ -25,10 +25,10 @@ class ListWorkspacesRequest: class ListWorkspacesResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" workspaces_response: Optional[shared_workspacesresponse.WorkspacesResponse] = dataclasses.field(default=None) r"""Successful operation""" diff --git a/src/airbyte/models/operations/patchconnection.py b/src/airbyte/models/operations/patchconnection.py index e80adecd..e546c01f 100644 --- a/src/airbyte/models/operations/patchconnection.py +++ b/src/airbyte/models/operations/patchconnection.py @@ -10,8 +10,8 @@ @dataclasses.dataclass class PatchConnectionRequest: - connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) connection_patch_request: shared_connectionpatchrequest.ConnectionPatchRequest = dataclasses.field(metadata={'request': { 'media_type': 'application/json' }}) + connection_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'connectionId', 'style': 'simple', 'explode': False }}) @@ -20,10 +20,10 @@ class PatchConnectionRequest: class PatchConnectionResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" connection_response: Optional[shared_connectionresponse.ConnectionResponse] = dataclasses.field(default=None) r"""Update a Connection by the id in the path.""" diff --git a/src/airbyte/models/operations/patchdestination.py b/src/airbyte/models/operations/patchdestination.py index 97a17086..b533fe04 100644 --- a/src/airbyte/models/operations/patchdestination.py +++ b/src/airbyte/models/operations/patchdestination.py @@ -20,10 +20,10 @@ class PatchDestinationRequest: class PatchDestinationResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" destination_response: Optional[shared_destinationresponse.DestinationResponse] = dataclasses.field(default=None) r"""Update a Destination""" diff --git a/src/airbyte/models/operations/patchsource.py b/src/airbyte/models/operations/patchsource.py index 72bdbf8f..80f7eb85 100644 --- a/src/airbyte/models/operations/patchsource.py +++ b/src/airbyte/models/operations/patchsource.py @@ -20,10 +20,10 @@ class PatchSourceRequest: class PatchSourceResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" source_response: Optional[shared_sourceresponse.SourceResponse] = dataclasses.field(default=None) r"""Update a Source""" diff --git a/src/airbyte/models/operations/putdestination.py b/src/airbyte/models/operations/putdestination.py index ec86f52d..301404a6 100644 --- a/src/airbyte/models/operations/putdestination.py +++ b/src/airbyte/models/operations/putdestination.py @@ -20,10 +20,10 @@ class PutDestinationRequest: class PutDestinationResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" destination_response: Optional[shared_destinationresponse.DestinationResponse] = dataclasses.field(default=None) r"""Update a Destination and fully overwrite it""" diff --git a/src/airbyte/models/operations/putsource.py b/src/airbyte/models/operations/putsource.py index 1f2635f7..23d5ab3c 100644 --- a/src/airbyte/models/operations/putsource.py +++ b/src/airbyte/models/operations/putsource.py @@ -20,10 +20,10 @@ class PutSourceRequest: class PutSourceResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" source_response: Optional[shared_sourceresponse.SourceResponse] = dataclasses.field(default=None) r"""Update a source and fully overwrite it""" diff --git a/src/airbyte/models/operations/updateworkspace.py b/src/airbyte/models/operations/updateworkspace.py index 8b40b591..d3152c79 100644 --- a/src/airbyte/models/operations/updateworkspace.py +++ b/src/airbyte/models/operations/updateworkspace.py @@ -10,8 +10,8 @@ @dataclasses.dataclass class UpdateWorkspaceRequest: - workspace_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'workspaceId', 'style': 'simple', 'explode': False }}) workspace_update_request: shared_workspaceupdaterequest.WorkspaceUpdateRequest = dataclasses.field(metadata={'request': { 'media_type': 'application/json' }}) + workspace_id: str = dataclasses.field(metadata={'path_param': { 'field_name': 'workspaceId', 'style': 'simple', 'explode': False }}) @@ -20,10 +20,10 @@ class UpdateWorkspaceRequest: class UpdateWorkspaceResponse: content_type: str = dataclasses.field() r"""HTTP response content type for this operation""" - raw_response: requests_http.Response = dataclasses.field() - r"""Raw HTTP response; suitable for custom response parsing""" status_code: int = dataclasses.field() r"""HTTP response status code for this operation""" + raw_response: requests_http.Response = dataclasses.field() + r"""Raw HTTP response; suitable for custom response parsing""" workspace_response: Optional[shared_workspaceresponse.WorkspaceResponse] = dataclasses.field(default=None) r"""Successful operation""" diff --git a/src/airbyte/models/shared/destination_aws_datalake.py b/src/airbyte/models/shared/destination_aws_datalake.py index dba851c1..095771af 100644 --- a/src/airbyte/models/shared/destination_aws_datalake.py +++ b/src/airbyte/models/shared/destination_aws_datalake.py @@ -137,11 +137,11 @@ class DestinationAwsDatalake: r"""Choose How to Authenticate to AWS.""" lakeformation_database_name: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lakeformation_database_name') }}) r"""The default database this destination will use to create tables in per stream. Can be changed per connection by customizing the namespace.""" - DESTINATION_TYPE: Final[AwsDatalake] = dataclasses.field(default=AwsDatalake.AWS_DATALAKE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) aws_account_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('aws_account_id'), 'exclude': lambda f: f is None }}) r"""target aws account id""" bucket_prefix: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('bucket_prefix'), 'exclude': lambda f: f is None }}) r"""S3 prefix""" + DESTINATION_TYPE: Final[AwsDatalake] = dataclasses.field(default=AwsDatalake.AWS_DATALAKE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) format: Optional[Union[JSONLinesNewlineDelimitedJSON, ParquetColumnarStorage]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('format'), 'exclude': lambda f: f is None }}) r"""Format of the data output.""" glue_catalog_float_as_decimal: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('glue_catalog_float_as_decimal'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/destination_azure_blob_storage.py b/src/airbyte/models/shared/destination_azure_blob_storage.py index 40333a4c..7a5b8e5a 100644 --- a/src/airbyte/models/shared/destination_azure_blob_storage.py +++ b/src/airbyte/models/shared/destination_azure_blob_storage.py @@ -33,9 +33,9 @@ class FormatType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class CSVCommaSeparatedValues: - FORMAT_TYPE: Final[FormatType] = dataclasses.field(default=FormatType.CSV, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('format_type') }}) flattening: Optional[NormalizationFlattening] = dataclasses.field(default=NormalizationFlattening.NO_FLATTENING, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('flattening'), 'exclude': lambda f: f is None }}) r"""Whether the input json data should be normalized (flattened) in the output CSV. Please refer to docs for details.""" + FORMAT_TYPE: Final[FormatType] = dataclasses.field(default=FormatType.CSV, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('format_type') }}) @@ -49,7 +49,6 @@ class DestinationAzureBlobStorage: r"""The account's name of the Azure Blob Storage.""" format: Union[CSVCommaSeparatedValues, DestinationAzureBlobStorageJSONLinesNewlineDelimitedJSON] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('format') }}) r"""Output data format""" - DESTINATION_TYPE: Final[AzureBlobStorage] = dataclasses.field(default=AzureBlobStorage.AZURE_BLOB_STORAGE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) azure_blob_storage_container_name: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('azure_blob_storage_container_name'), 'exclude': lambda f: f is None }}) r"""The name of the Azure blob storage container. If not exists - will be created automatically. May be empty, then will be created automatically airbytecontainer+timestamp""" azure_blob_storage_endpoint_domain_name: Optional[str] = dataclasses.field(default='blob.core.windows.net', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('azure_blob_storage_endpoint_domain_name'), 'exclude': lambda f: f is None }}) @@ -58,5 +57,6 @@ class DestinationAzureBlobStorage: r"""The amount of megabytes to buffer for the output stream to Azure. This will impact memory footprint on workers, but may need adjustment for performance and appropriate block size in Azure.""" azure_blob_storage_spill_size: Optional[int] = dataclasses.field(default=500, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('azure_blob_storage_spill_size'), 'exclude': lambda f: f is None }}) r"""The amount of megabytes after which the connector should spill the records in a new blob object. Make sure to configure size greater than individual records. Enter 0 if not applicable""" + DESTINATION_TYPE: Final[AzureBlobStorage] = dataclasses.field(default=AzureBlobStorage.AZURE_BLOB_STORAGE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) diff --git a/src/airbyte/models/shared/destination_bigquery.py b/src/airbyte/models/shared/destination_bigquery.py index 56f467b2..107a951d 100644 --- a/src/airbyte/models/shared/destination_bigquery.py +++ b/src/airbyte/models/shared/destination_bigquery.py @@ -103,9 +103,9 @@ class GCSStaging: r"""The name of the GCS bucket. Read more here.""" gcs_bucket_path: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('gcs_bucket_path') }}) r"""Directory under the GCS bucket where data will be written.""" - METHOD: Final[Method] = dataclasses.field(default=Method.GCS_STAGING, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('method') }}) keep_files_in_gcs_bucket: Optional[GCSTmpFilesAfterwardProcessing] = dataclasses.field(default=GCSTmpFilesAfterwardProcessing.DELETE_ALL_TMP_FILES_FROM_GCS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('keep_files_in_gcs-bucket'), 'exclude': lambda f: f is None }}) r"""This upload method is supposed to temporary store records in GCS bucket. By this select you can chose if these records should be removed from GCS when migration has finished. The default \\"Delete all tmp files from GCS\\" value is used if not set explicitly.""" + METHOD: Final[Method] = dataclasses.field(default=Method.GCS_STAGING, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('method') }}) @@ -124,11 +124,11 @@ class DestinationBigquery: r"""The location of the dataset. Warning: Changes made after creation will not be applied. Read more here.""" project_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('project_id') }}) r"""The GCP project ID for the project containing the target BigQuery dataset. Read more here.""" - DESTINATION_TYPE: Final[Bigquery] = dataclasses.field(default=Bigquery.BIGQUERY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) big_query_client_buffer_size_mb: Optional[int] = dataclasses.field(default=15, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('big_query_client_buffer_size_mb'), 'exclude': lambda f: f is None }}) r"""Google BigQuery client's chunk (buffer) size (MIN=1, MAX = 15) for each table. The size that will be written by a single RPC. Written data will be buffered and only flushed upon reaching this size or closing the channel. The default 15MB value is used if not set explicitly. Read more here.""" credentials_json: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials_json'), 'exclude': lambda f: f is None }}) r"""The contents of the JSON service account key. Check out the docs if you need help generating this key. Default credentials will be used if this field is left empty.""" + DESTINATION_TYPE: Final[Bigquery] = dataclasses.field(default=Bigquery.BIGQUERY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) disable_type_dedupe: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('disable_type_dedupe'), 'exclude': lambda f: f is None }}) r"""Disable Writing Final Tables. WARNING! The data format in _airbyte_data is likely stable but there are no guarantees that other metadata columns will remain the same in future versions""" loading_method: Optional[Union[GCSStaging, StandardInserts]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('loading_method'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/destination_cumulio.py b/src/airbyte/models/shared/destination_cumulio.py index 83d48cb5..68c50de4 100644 --- a/src/airbyte/models/shared/destination_cumulio.py +++ b/src/airbyte/models/shared/destination_cumulio.py @@ -18,8 +18,8 @@ class DestinationCumulio: r"""An API key generated in Cumul.io's platform (can be generated here: https://app.cumul.io/start/profile/integration).""" api_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_token') }}) r"""The corresponding API token generated in Cumul.io's platform (can be generated here: https://app.cumul.io/start/profile/integration).""" - DESTINATION_TYPE: Final[Cumulio] = dataclasses.field(default=Cumulio.CUMULIO, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) api_host: Optional[str] = dataclasses.field(default='https://api.cumul.io', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_host'), 'exclude': lambda f: f is None }}) r"""URL of the Cumul.io API (e.g. 'https://api.cumul.io', 'https://api.us.cumul.io', or VPC-specific API url). Defaults to 'https://api.cumul.io'.""" + DESTINATION_TYPE: Final[Cumulio] = dataclasses.field(default=Cumulio.CUMULIO, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) diff --git a/src/airbyte/models/shared/destination_databricks.py b/src/airbyte/models/shared/destination_databricks.py index ea4a501e..587d44e2 100644 --- a/src/airbyte/models/shared/destination_databricks.py +++ b/src/airbyte/models/shared/destination_databricks.py @@ -20,9 +20,9 @@ class DestinationDatabricksAzureBlobStorage: r"""The name of the Azure blob storage container.""" azure_blob_storage_sas_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('azure_blob_storage_sas_token') }}) r"""Shared access signature (SAS) token to grant limited access to objects in your storage account.""" - DATA_SOURCE_TYPE: Final[DestinationDatabricksSchemasDataSourceType] = dataclasses.field(default=DestinationDatabricksSchemasDataSourceType.AZURE_BLOB_STORAGE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data_source_type') }}) azure_blob_storage_endpoint_domain_name: Optional[str] = dataclasses.field(default='blob.core.windows.net', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('azure_blob_storage_endpoint_domain_name'), 'exclude': lambda f: f is None }}) r"""This is Azure Blob Storage endpoint domain name. Leave default value (or leave it empty if run container from command line) to use Microsoft native from example.""" + DATA_SOURCE_TYPE: Final[DestinationDatabricksSchemasDataSourceType] = dataclasses.field(default=DestinationDatabricksSchemasDataSourceType.AZURE_BLOB_STORAGE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data_source_type') }}) @@ -104,13 +104,13 @@ class DestinationDatabricks: r"""Databricks Personal Access Token for making authenticated requests.""" databricks_server_hostname: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('databricks_server_hostname') }}) r"""Databricks Cluster Server Hostname.""" - DESTINATION_TYPE: Final[Databricks] = dataclasses.field(default=Databricks.DATABRICKS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) accept_terms: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accept_terms'), 'exclude': lambda f: f is None }}) r"""You must agree to the Databricks JDBC Driver Terms & Conditions to use this connector.""" database: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('database'), 'exclude': lambda f: f is None }}) r"""The name of the catalog. If not specified otherwise, the \\"hive_metastore\\" will be used.""" databricks_port: Optional[str] = dataclasses.field(default='443', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('databricks_port'), 'exclude': lambda f: f is None }}) r"""Databricks Cluster Port.""" + DESTINATION_TYPE: Final[Databricks] = dataclasses.field(default=Databricks.DATABRICKS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) enable_schema_evolution: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_schema_evolution'), 'exclude': lambda f: f is None }}) r"""Support schema evolution for all streams. If \\"false\\", the connector might fail when a stream's schema changes.""" purge_staging_data: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('purge_staging_data'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/destination_elasticsearch.py b/src/airbyte/models/shared/destination_elasticsearch.py index 62d92ac8..8603e70d 100644 --- a/src/airbyte/models/shared/destination_elasticsearch.py +++ b/src/airbyte/models/shared/destination_elasticsearch.py @@ -48,11 +48,11 @@ class Elasticsearch(str, Enum): class DestinationElasticsearch: endpoint: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('endpoint') }}) r"""The full url of the Elasticsearch server""" - DESTINATION_TYPE: Final[Elasticsearch] = dataclasses.field(default=Elasticsearch.ELASTICSEARCH, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) authentication_method: Optional[Union[APIKeySecret, UsernamePassword]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('authenticationMethod'), 'exclude': lambda f: f is None }}) r"""The type of authentication to be used""" ca_certificate: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ca_certificate'), 'exclude': lambda f: f is None }}) r"""CA certificate""" + DESTINATION_TYPE: Final[Elasticsearch] = dataclasses.field(default=Elasticsearch.ELASTICSEARCH, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) upsert: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('upsert'), 'exclude': lambda f: f is None }}) r"""If a primary key identifier is defined in the source, an upsert will be performed using the primary key value as the elasticsearch doc id. Does not support composite primary keys.""" diff --git a/src/airbyte/models/shared/destination_firebolt.py b/src/airbyte/models/shared/destination_firebolt.py index fa03f8a4..e2bfd4d8 100644 --- a/src/airbyte/models/shared/destination_firebolt.py +++ b/src/airbyte/models/shared/destination_firebolt.py @@ -50,9 +50,9 @@ class DestinationFirebolt: r"""Firebolt password.""" username: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('username') }}) r"""Firebolt email address you use to login.""" - DESTINATION_TYPE: Final[Firebolt] = dataclasses.field(default=Firebolt.FIREBOLT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) account: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('account'), 'exclude': lambda f: f is None }}) r"""Firebolt account to login.""" + DESTINATION_TYPE: Final[Firebolt] = dataclasses.field(default=Firebolt.FIREBOLT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) engine: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('engine'), 'exclude': lambda f: f is None }}) r"""Engine name or url to connect to.""" host: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('host'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/destination_firestore.py b/src/airbyte/models/shared/destination_firestore.py index 54a1c962..b45f7dcf 100644 --- a/src/airbyte/models/shared/destination_firestore.py +++ b/src/airbyte/models/shared/destination_firestore.py @@ -16,8 +16,8 @@ class Firestore(str, Enum): class DestinationFirestore: project_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('project_id') }}) r"""The GCP project ID for the project containing the target BigQuery dataset.""" - DESTINATION_TYPE: Final[Firestore] = dataclasses.field(default=Firestore.FIRESTORE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) credentials_json: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials_json'), 'exclude': lambda f: f is None }}) r"""The contents of the JSON service account key. Check out the docs if you need help generating this key. Default credentials will be used if this field is left empty.""" + DESTINATION_TYPE: Final[Firestore] = dataclasses.field(default=Firestore.FIRESTORE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) diff --git a/src/airbyte/models/shared/destination_kinesis.py b/src/airbyte/models/shared/destination_kinesis.py index ba790f48..4490f52e 100644 --- a/src/airbyte/models/shared/destination_kinesis.py +++ b/src/airbyte/models/shared/destination_kinesis.py @@ -22,9 +22,9 @@ class DestinationKinesis: r"""The AWS Private Key - a string of numbers and letters that are unique for each account, also known as a \\"recovery phrase\\".""" region: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('region') }}) r"""AWS region. Your account determines the Regions that are available to you.""" - DESTINATION_TYPE: Final[Kinesis] = dataclasses.field(default=Kinesis.KINESIS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) buffer_size: Optional[int] = dataclasses.field(default=100, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('bufferSize'), 'exclude': lambda f: f is None }}) r"""Buffer size for storing kinesis records before being batch streamed.""" + DESTINATION_TYPE: Final[Kinesis] = dataclasses.field(default=Kinesis.KINESIS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) shard_count: Optional[int] = dataclasses.field(default=5, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('shardCount'), 'exclude': lambda f: f is None }}) r"""Number of shards to which the data should be streamed.""" diff --git a/src/airbyte/models/shared/destination_pubsub.py b/src/airbyte/models/shared/destination_pubsub.py index 618dfc14..465cbab6 100644 --- a/src/airbyte/models/shared/destination_pubsub.py +++ b/src/airbyte/models/shared/destination_pubsub.py @@ -20,7 +20,6 @@ class DestinationPubsub: r"""The GCP project ID for the project containing the target PubSub.""" topic_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('topic_id') }}) r"""The PubSub topic ID in the given GCP project ID.""" - DESTINATION_TYPE: Final[Pubsub] = dataclasses.field(default=Pubsub.PUBSUB, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) batching_delay_threshold: Optional[int] = dataclasses.field(default=1, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('batching_delay_threshold'), 'exclude': lambda f: f is None }}) r"""Number of ms before the buffer is flushed""" batching_element_count_threshold: Optional[int] = dataclasses.field(default=1, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('batching_element_count_threshold'), 'exclude': lambda f: f is None }}) @@ -29,6 +28,7 @@ class DestinationPubsub: r"""If TRUE messages will be buffered instead of sending them one by one""" batching_request_bytes_threshold: Optional[int] = dataclasses.field(default=1, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('batching_request_bytes_threshold'), 'exclude': lambda f: f is None }}) r"""Number of bytes before the buffer is flushed""" + DESTINATION_TYPE: Final[Pubsub] = dataclasses.field(default=Pubsub.PUBSUB, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) ordering_enabled: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ordering_enabled'), 'exclude': lambda f: f is None }}) r"""If TRUE PubSub publisher will have message ordering enabled. Every message will have an ordering key of stream""" diff --git a/src/airbyte/models/shared/destination_redis.py b/src/airbyte/models/shared/destination_redis.py index 7d925b42..51ddca94 100644 --- a/src/airbyte/models/shared/destination_redis.py +++ b/src/airbyte/models/shared/destination_redis.py @@ -109,9 +109,9 @@ class DestinationRedis: r"""Redis host to connect to.""" username: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('username') }}) r"""Username associated with Redis.""" - DESTINATION_TYPE: Final[Redis] = dataclasses.field(default=Redis.REDIS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) cache_type: Optional[CacheType] = dataclasses.field(default=CacheType.HASH, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('cache_type'), 'exclude': lambda f: f is None }}) r"""Redis cache type to store data in.""" + DESTINATION_TYPE: Final[Redis] = dataclasses.field(default=Redis.REDIS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) password: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('password'), 'exclude': lambda f: f is None }}) r"""Password associated with Redis.""" port: Optional[int] = dataclasses.field(default=6379, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('port'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/destination_redshift.py b/src/airbyte/models/shared/destination_redshift.py index 4894a849..aa506d55 100644 --- a/src/airbyte/models/shared/destination_redshift.py +++ b/src/airbyte/models/shared/destination_redshift.py @@ -154,13 +154,13 @@ class AWSS3Staging: r"""The name of the staging S3 bucket.""" secret_access_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('secret_access_key') }}) r"""The corresponding secret to the above access key id. See AWS docs on how to generate an access key ID and secret access key.""" - METHOD: Final[DestinationRedshiftMethod] = dataclasses.field(default=DestinationRedshiftMethod.S3_STAGING, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('method') }}) encryption: Optional[Union[NoEncryption, AESCBCEnvelopeEncryption]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('encryption'), 'exclude': lambda f: f is None }}) r"""How to encrypt the staging data""" file_buffer_count: Optional[int] = dataclasses.field(default=10, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('file_buffer_count'), 'exclude': lambda f: f is None }}) r"""Number of file buffers allocated for writing data. Increasing this number is beneficial for connections using Change Data Capture (CDC) and up to the number of streams within a connection. Increasing the number of file buffers past the maximum number of streams has deteriorating effects""" file_name_pattern: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('file_name_pattern'), 'exclude': lambda f: f is None }}) r"""The pattern allows you to set the file-name format for the S3 staging file(s)""" + METHOD: Final[DestinationRedshiftMethod] = dataclasses.field(default=DestinationRedshiftMethod.S3_STAGING, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('method') }}) purge_staging_data: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('purge_staging_data'), 'exclude': lambda f: f is None }}) r"""Whether to delete the staging files from S3 after completing the sync. See docs for details.""" s3_bucket_path: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('s3_bucket_path'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/destination_s3.py b/src/airbyte/models/shared/destination_s3.py index e0b28f70..c05ef878 100644 --- a/src/airbyte/models/shared/destination_s3.py +++ b/src/airbyte/models/shared/destination_s3.py @@ -261,9 +261,9 @@ class DestinationS3: r"""The name of the S3 bucket. Read more here.""" s3_bucket_path: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('s3_bucket_path') }}) r"""Directory under the S3 bucket where data will be written. Read more here""" - DESTINATION_TYPE: Final[S3] = dataclasses.field(default=S3.S3, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) access_key_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('access_key_id'), 'exclude': lambda f: f is None }}) r"""The access key ID to access the S3 bucket. Airbyte requires Read and Write permissions to the given bucket. Read more here.""" + DESTINATION_TYPE: Final[S3] = dataclasses.field(default=S3.S3, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) file_name_pattern: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('file_name_pattern'), 'exclude': lambda f: f is None }}) r"""The pattern allows you to set the file-name format for the S3 staging file(s)""" s3_bucket_region: Optional[DestinationS3S3BucketRegion] = dataclasses.field(default=DestinationS3S3BucketRegion.UNKNOWN, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('s3_bucket_region'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/destination_s3_glue.py b/src/airbyte/models/shared/destination_s3_glue.py index a53a5323..9a8f8083 100644 --- a/src/airbyte/models/shared/destination_s3_glue.py +++ b/src/airbyte/models/shared/destination_s3_glue.py @@ -106,9 +106,9 @@ class DestinationS3Glue: r"""The name of the S3 bucket. Read more here.""" s3_bucket_path: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('s3_bucket_path') }}) r"""Directory under the S3 bucket where data will be written. Read more here""" - DESTINATION_TYPE: Final[S3Glue] = dataclasses.field(default=S3Glue.S3_GLUE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) access_key_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('access_key_id'), 'exclude': lambda f: f is None }}) r"""The access key ID to access the S3 bucket. Airbyte requires Read and Write permissions to the given bucket. Read more here.""" + DESTINATION_TYPE: Final[S3Glue] = dataclasses.field(default=S3Glue.S3_GLUE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) file_name_pattern: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('file_name_pattern'), 'exclude': lambda f: f is None }}) r"""The pattern allows you to set the file-name format for the S3 staging file(s)""" glue_serialization_library: Optional[SerializationLibrary] = dataclasses.field(default=SerializationLibrary.ORG_OPENX_DATA_JSONSERDE_JSON_SER_DE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('glue_serialization_library'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/destination_snowflake.py b/src/airbyte/models/shared/destination_snowflake.py index 5fc14127..e6291426 100644 --- a/src/airbyte/models/shared/destination_snowflake.py +++ b/src/airbyte/models/shared/destination_snowflake.py @@ -73,8 +73,8 @@ class DestinationSnowflake: r"""Enter the name of the user you want to use to access the database""" warehouse: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('warehouse') }}) r"""Enter the name of the warehouse that you want to sync data into""" - DESTINATION_TYPE: Final[DestinationSnowflakeSnowflake] = dataclasses.field(default=DestinationSnowflakeSnowflake.SNOWFLAKE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) credentials: Optional[Union[DestinationSnowflakeOAuth20, KeyPairAuthentication, UsernameAndPassword]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) + DESTINATION_TYPE: Final[DestinationSnowflakeSnowflake] = dataclasses.field(default=DestinationSnowflakeSnowflake.SNOWFLAKE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) disable_type_dedupe: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('disable_type_dedupe'), 'exclude': lambda f: f is None }}) r"""Disable Writing Final Tables. WARNING! The data format in _airbyte_data is likely stable but there are no guarantees that other metadata columns will remain the same in future versions""" enable_incremental_final_table_updates: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_incremental_final_table_updates'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/destination_typesense.py b/src/airbyte/models/shared/destination_typesense.py index bbabadc9..9db797a8 100644 --- a/src/airbyte/models/shared/destination_typesense.py +++ b/src/airbyte/models/shared/destination_typesense.py @@ -18,9 +18,9 @@ class DestinationTypesense: r"""Typesense API Key""" host: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('host') }}) r"""Hostname of the Typesense instance without protocol.""" - DESTINATION_TYPE: Final[Typesense] = dataclasses.field(default=Typesense.TYPESENSE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) batch_size: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('batch_size'), 'exclude': lambda f: f is None }}) r"""How many documents should be imported together. Default 1000""" + DESTINATION_TYPE: Final[Typesense] = dataclasses.field(default=Typesense.TYPESENSE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('destinationType') }}) port: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('port'), 'exclude': lambda f: f is None }}) r"""Port of the Typesense instance. Ex: 8108, 80, 443. Default is 443""" protocol: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('protocol'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_alloydb.py b/src/airbyte/models/shared/source_alloydb.py index 4dc186b3..5104df44 100644 --- a/src/airbyte/models/shared/source_alloydb.py +++ b/src/airbyte/models/shared/source_alloydb.py @@ -40,12 +40,12 @@ class LogicalReplicationCDC: r"""A Postgres publication used for consuming changes. Read about publications and replication identities.""" replication_slot: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('replication_slot') }}) r"""A plugin logical replication slot. Read about replication slots.""" - METHOD: Final[SourceAlloydbSchemasMethod] = dataclasses.field(default=SourceAlloydbSchemasMethod.CDC, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('method') }}) additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) initial_waiting_seconds: Optional[int] = dataclasses.field(default=300, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('initial_waiting_seconds'), 'exclude': lambda f: f is None }}) r"""The amount of time the connector will wait when it launches to determine if there is new data to sync or not. Defaults to 300 seconds. Valid range: 120 seconds to 1200 seconds. Read about initial waiting time.""" lsn_commit_behaviour: Optional[LSNCommitBehaviour] = dataclasses.field(default=LSNCommitBehaviour.AFTER_LOADING_DATA_IN_THE_DESTINATION, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lsn_commit_behaviour'), 'exclude': lambda f: f is None }}) r"""Determines when Airbtye should flush the LSN of processed WAL logs in the source database. `After loading Data in the destination` is default. If `While reading Data` is selected, in case of a downstream failure (while loading data into the destination), next sync would result in a full sync.""" + METHOD: Final[SourceAlloydbSchemasMethod] = dataclasses.field(default=SourceAlloydbSchemasMethod.CDC, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('method') }}) plugin: Optional[Plugin] = dataclasses.field(default=Plugin.PGOUTPUT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('plugin'), 'exclude': lambda f: f is None }}) r"""A logical decoding plugin installed on the PostgreSQL server.""" queue_size: Optional[int] = dataclasses.field(default=10000, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('queue_size'), 'exclude': lambda f: f is None }}) @@ -78,7 +78,6 @@ class SourceAlloydbVerifyFull: r"""This is the most secure mode. Always require encryption and verifies the identity of the source database server.""" ca_certificate: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ca_certificate') }}) r"""CA certificate""" - MODE: Final[SourceAlloydbSchemasSSLModeSSLModes6Mode] = dataclasses.field(default=SourceAlloydbSchemasSSLModeSSLModes6Mode.VERIFY_FULL, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) client_certificate: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_certificate'), 'exclude': lambda f: f is None }}) r"""Client certificate""" @@ -86,6 +85,7 @@ class SourceAlloydbVerifyFull: r"""Client key""" client_key_password: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_key_password'), 'exclude': lambda f: f is None }}) r"""Password for keystorage. If you do not add it - the password will be generated automatically.""" + MODE: Final[SourceAlloydbSchemasSSLModeSSLModes6Mode] = dataclasses.field(default=SourceAlloydbSchemasSSLModeSSLModes6Mode.VERIFY_FULL, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -99,7 +99,6 @@ class SourceAlloydbVerifyCa: r"""Always require encryption and verifies that the source database server has a valid SSL certificate.""" ca_certificate: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ca_certificate') }}) r"""CA certificate""" - MODE: Final[SourceAlloydbSchemasSSLModeSSLModes5Mode] = dataclasses.field(default=SourceAlloydbSchemasSSLModeSSLModes5Mode.VERIFY_CA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) client_certificate: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_certificate'), 'exclude': lambda f: f is None }}) r"""Client certificate""" @@ -107,6 +106,7 @@ class SourceAlloydbVerifyCa: r"""Client key""" client_key_password: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_key_password'), 'exclude': lambda f: f is None }}) r"""Password for keystorage. If you do not add it - the password will be generated automatically.""" + MODE: Final[SourceAlloydbSchemasSSLModeSSLModes5Mode] = dataclasses.field(default=SourceAlloydbSchemasSSLModeSSLModes5Mode.VERIFY_CA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -118,8 +118,8 @@ class SourceAlloydbSchemasSSLModeSSLModesMode(str, Enum): @dataclasses.dataclass class SourceAlloydbRequire: r"""Always require encryption. If the source database server does not support encryption, connection will fail.""" - MODE: Final[SourceAlloydbSchemasSSLModeSSLModesMode] = dataclasses.field(default=SourceAlloydbSchemasSSLModeSSLModesMode.REQUIRE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + MODE: Final[SourceAlloydbSchemasSSLModeSSLModesMode] = dataclasses.field(default=SourceAlloydbSchemasSSLModeSSLModesMode.REQUIRE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -131,8 +131,8 @@ class SourceAlloydbSchemasSslModeMode(str, Enum): @dataclasses.dataclass class SourceAlloydbPrefer: r"""Allows unencrypted connection only if the source database does not support encryption.""" - MODE: Final[SourceAlloydbSchemasSslModeMode] = dataclasses.field(default=SourceAlloydbSchemasSslModeMode.PREFER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + MODE: Final[SourceAlloydbSchemasSslModeMode] = dataclasses.field(default=SourceAlloydbSchemasSslModeMode.PREFER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -144,8 +144,8 @@ class SourceAlloydbSchemasMode(str, Enum): @dataclasses.dataclass class SourceAlloydbAllow: r"""Enables encryption only when required by the source database.""" - MODE: Final[SourceAlloydbSchemasMode] = dataclasses.field(default=SourceAlloydbSchemasMode.ALLOW, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + MODE: Final[SourceAlloydbSchemasMode] = dataclasses.field(default=SourceAlloydbSchemasMode.ALLOW, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -157,8 +157,8 @@ class SourceAlloydbMode(str, Enum): @dataclasses.dataclass class SourceAlloydbDisable: r"""Disables encryption of communication between Airbyte and source database.""" - MODE: Final[SourceAlloydbMode] = dataclasses.field(default=SourceAlloydbMode.DISABLE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + MODE: Final[SourceAlloydbMode] = dataclasses.field(default=SourceAlloydbMode.DISABLE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -227,7 +227,6 @@ class SourceAlloydb: r"""Hostname of the database.""" username: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('username') }}) r"""Username to access the database.""" - SOURCE_TYPE: Final[Alloydb] = dataclasses.field(default=Alloydb.ALLOYDB, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) jdbc_url_params: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('jdbc_url_params'), 'exclude': lambda f: f is None }}) r"""Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (Eg. key1=value1&key2=value2&key3=value3). For more information read about JDBC URL parameters.""" password: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('password'), 'exclude': lambda f: f is None }}) @@ -238,6 +237,7 @@ class SourceAlloydb: r"""Replication method for extracting data from the database.""" schemas: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('schemas'), 'exclude': lambda f: f is None }}) r"""The list of schemas (case sensitive) to sync from. Defaults to public.""" + SOURCE_TYPE: Final[Alloydb] = dataclasses.field(default=Alloydb.ALLOYDB, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) ssl_mode: Optional[Union[SourceAlloydbDisable, SourceAlloydbAllow, SourceAlloydbPrefer, SourceAlloydbRequire, SourceAlloydbVerifyCa, SourceAlloydbVerifyFull]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ssl_mode'), 'exclude': lambda f: f is None }}) r"""SSL connection modes. Read more in the docs. diff --git a/src/airbyte/models/shared/source_amazon_ads.py b/src/airbyte/models/shared/source_amazon_ads.py index 44b5a346..0f77ca2b 100644 --- a/src/airbyte/models/shared/source_amazon_ads.py +++ b/src/airbyte/models/shared/source_amazon_ads.py @@ -45,7 +45,6 @@ class SourceAmazonAds: r"""The client secret of your Amazon Ads developer application. See the docs for more information.""" refresh_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('refresh_token') }}) r"""Amazon Ads refresh token. See the docs for more information on how to obtain this token.""" - SOURCE_TYPE: Final[SourceAmazonAdsAmazonAds] = dataclasses.field(default=SourceAmazonAdsAmazonAds.AMAZON_ADS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) AUTH_TYPE: Final[Optional[SourceAmazonAdsAuthType]] = dataclasses.field(default=SourceAmazonAdsAuthType.OAUTH2_0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_type'), 'exclude': lambda f: f is None }}) look_back_window: Optional[int] = dataclasses.field(default=3, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('look_back_window'), 'exclude': lambda f: f is None }}) r"""The amount of days to go back in time to get the updated data from Amazon Ads""" @@ -57,6 +56,7 @@ class SourceAmazonAds: r"""Region to pull data from (EU/NA/FE). See docs for more details.""" report_record_types: Optional[List[ReportRecordTypes]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('report_record_types'), 'exclude': lambda f: f is None }}) r"""Optional configuration which accepts an array of string of record types. Leave blank for default behaviour to pull all report types. Use this config option only if you want to pull specific report type(s). See docs for more details""" + SOURCE_TYPE: Final[SourceAmazonAdsAmazonAds] = dataclasses.field(default=SourceAmazonAdsAmazonAds.AMAZON_ADS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[date] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.dateisoformat(True), 'decoder': utils.datefromisoformat, 'exclude': lambda f: f is None }}) r"""The Start date for collecting reports, should not be more than 60 days in the past. In YYYY-MM-DD format""" state_filter: Optional[List[StateFilter]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('state_filter'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_amazon_seller_partner.py b/src/airbyte/models/shared/source_amazon_seller_partner.py index 7285c210..30875078 100644 --- a/src/airbyte/models/shared/source_amazon_seller_partner.py +++ b/src/airbyte/models/shared/source_amazon_seller_partner.py @@ -127,7 +127,6 @@ class SourceAmazonSellerPartner: r"""Your Login with Amazon Client Secret.""" refresh_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('refresh_token') }}) r"""The Refresh Token obtained via OAuth flow authorization.""" - SOURCE_TYPE: Final[SourceAmazonSellerPartnerAmazonSellerPartner] = dataclasses.field(default=SourceAmazonSellerPartnerAmazonSellerPartner.AMAZON_SELLER_PARTNER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) account_type: Optional[AWSSellerPartnerAccountType] = dataclasses.field(default=AWSSellerPartnerAccountType.SELLER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('account_type'), 'exclude': lambda f: f is None }}) r"""Type of the Account you're going to authorize the Airbyte application by""" AUTH_TYPE: Final[Optional[SourceAmazonSellerPartnerAuthType]] = dataclasses.field(default=SourceAmazonSellerPartnerAuthType.OAUTH2_0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_type'), 'exclude': lambda f: f is None }}) @@ -143,5 +142,6 @@ class SourceAmazonSellerPartner: r"""UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. If start date is not provided, the date 2 years ago from today will be used.""" report_options_list: Optional[List[ReportOptions]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('report_options_list'), 'exclude': lambda f: f is None }}) r"""Additional information passed to reports. This varies by report type.""" + SOURCE_TYPE: Final[SourceAmazonSellerPartnerAmazonSellerPartner] = dataclasses.field(default=SourceAmazonSellerPartnerAmazonSellerPartner.AMAZON_SELLER_PARTNER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_amazon_sqs.py b/src/airbyte/models/shared/source_amazon_sqs.py index 065aa9aa..cebbac94 100644 --- a/src/airbyte/models/shared/source_amazon_sqs.py +++ b/src/airbyte/models/shared/source_amazon_sqs.py @@ -54,7 +54,6 @@ class SourceAmazonSqs: r"""URL of the SQS Queue""" region: SourceAmazonSqsAWSRegion = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('region') }}) r"""AWS Region of the SQS Queue""" - SOURCE_TYPE: Final[AmazonSqs] = dataclasses.field(default=AmazonSqs.AMAZON_SQS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) access_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('access_key'), 'exclude': lambda f: f is None }}) r"""The Access Key ID of the AWS IAM Role to use for pulling messages""" attributes_to_return: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attributes_to_return'), 'exclude': lambda f: f is None }}) @@ -67,6 +66,7 @@ class SourceAmazonSqs: r"""Max amount of time in seconds to wait for messages in a single poll (20 max)""" secret_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('secret_key'), 'exclude': lambda f: f is None }}) r"""The Secret Key of the AWS IAM Role to use for pulling messages""" + SOURCE_TYPE: Final[AmazonSqs] = dataclasses.field(default=AmazonSqs.AMAZON_SQS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) visibility_timeout: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('visibility_timeout'), 'exclude': lambda f: f is None }}) r"""Modify the Visibility Timeout of the individual message from the Queue's default (seconds).""" diff --git a/src/airbyte/models/shared/source_amplitude.py b/src/airbyte/models/shared/source_amplitude.py index bbce6b42..dbcd376e 100644 --- a/src/airbyte/models/shared/source_amplitude.py +++ b/src/airbyte/models/shared/source_amplitude.py @@ -27,10 +27,10 @@ class SourceAmplitude: r"""Amplitude Secret Key. See the setup guide for more information on how to obtain this key.""" start_date: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) r"""UTC date and time in the format 2021-01-25T00:00:00Z. Any data before this date will not be replicated.""" - SOURCE_TYPE: Final[Amplitude] = dataclasses.field(default=Amplitude.AMPLITUDE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) data_region: Optional[DataRegion] = dataclasses.field(default=DataRegion.STANDARD_SERVER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data_region'), 'exclude': lambda f: f is None }}) r"""Amplitude data region server""" request_time_range: Optional[int] = dataclasses.field(default=24, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('request_time_range'), 'exclude': lambda f: f is None }}) r"""According to Considerations too big time range in request can cause a timeout error. In this case, set shorter time interval in hours.""" + SOURCE_TYPE: Final[Amplitude] = dataclasses.field(default=Amplitude.AMPLITUDE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_appfollow.py b/src/airbyte/models/shared/source_appfollow.py index 8b83b14e..47662061 100644 --- a/src/airbyte/models/shared/source_appfollow.py +++ b/src/airbyte/models/shared/source_appfollow.py @@ -14,8 +14,8 @@ class Appfollow(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceAppfollow: - SOURCE_TYPE: Final[Appfollow] = dataclasses.field(default=Appfollow.APPFOLLOW, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) api_secret: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_secret'), 'exclude': lambda f: f is None }}) r"""API Key provided by Appfollow""" + SOURCE_TYPE: Final[Appfollow] = dataclasses.field(default=Appfollow.APPFOLLOW, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_azure_blob_storage.py b/src/airbyte/models/shared/source_azure_blob_storage.py index 3ce4d18c..5bb2d78a 100644 --- a/src/airbyte/models/shared/source_azure_blob_storage.py +++ b/src/airbyte/models/shared/source_azure_blob_storage.py @@ -209,9 +209,9 @@ class SourceAzureBlobStorage: r"""The name of the Azure blob storage container.""" streams: List[FileBasedStreamConfig] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('streams') }}) r"""Each instance of this configuration defines a stream. Use this to define which files belong in the stream, their format, and how they should be parsed and validated. When sending data to warehouse destination such as Snowflake or BigQuery, each stream is a separate table.""" - SOURCE_TYPE: Final[SourceAzureBlobStorageAzureBlobStorage] = dataclasses.field(default=SourceAzureBlobStorageAzureBlobStorage.AZURE_BLOB_STORAGE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) azure_blob_storage_endpoint: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('azure_blob_storage_endpoint'), 'exclude': lambda f: f is None }}) r"""This is Azure Blob Storage endpoint domain name. Leave default value (or leave it empty if run container from command line) to use Microsoft native from example.""" + SOURCE_TYPE: Final[SourceAzureBlobStorageAzureBlobStorage] = dataclasses.field(default=SourceAzureBlobStorageAzureBlobStorage.AZURE_BLOB_STORAGE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""UTC date and time in the format 2017-01-25T00:00:00.000000Z. Any file modified before this date will not be replicated.""" diff --git a/src/airbyte/models/shared/source_bamboo_hr.py b/src/airbyte/models/shared/source_bamboo_hr.py index 3abd64e1..ff99aba0 100644 --- a/src/airbyte/models/shared/source_bamboo_hr.py +++ b/src/airbyte/models/shared/source_bamboo_hr.py @@ -18,10 +18,10 @@ class SourceBambooHr: r"""Api key of bamboo hr""" subdomain: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subdomain') }}) r"""Sub Domain of bamboo hr""" - SOURCE_TYPE: Final[BambooHr] = dataclasses.field(default=BambooHr.BAMBOO_HR, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) custom_reports_fields: Optional[str] = dataclasses.field(default='', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('custom_reports_fields'), 'exclude': lambda f: f is None }}) r"""Comma-separated list of fields to include in custom reports.""" custom_reports_include_default_fields: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('custom_reports_include_default_fields'), 'exclude': lambda f: f is None }}) r"""If true, the custom reports endpoint will include the default fields defined here: https://documentation.bamboohr.com/docs/list-of-field-names.""" + SOURCE_TYPE: Final[BambooHr] = dataclasses.field(default=BambooHr.BAMBOO_HR, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_bigquery.py b/src/airbyte/models/shared/source_bigquery.py index 0b2885fe..3b9c9a15 100644 --- a/src/airbyte/models/shared/source_bigquery.py +++ b/src/airbyte/models/shared/source_bigquery.py @@ -18,8 +18,8 @@ class SourceBigquery: r"""The contents of your Service Account Key JSON file. See the docs for more information on how to obtain this key.""" project_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('project_id') }}) r"""The GCP project ID for the project containing the target BigQuery dataset.""" - SOURCE_TYPE: Final[SourceBigqueryBigquery] = dataclasses.field(default=SourceBigqueryBigquery.BIGQUERY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) dataset_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('dataset_id'), 'exclude': lambda f: f is None }}) r"""The dataset ID to search for tables and views. If you are only loading data from one dataset, setting this option could result in much faster schema discovery.""" + SOURCE_TYPE: Final[SourceBigqueryBigquery] = dataclasses.field(default=SourceBigqueryBigquery.BIGQUERY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_bing_ads.py b/src/airbyte/models/shared/source_bing_ads.py index 963c8ed1..dcc5294a 100644 --- a/src/airbyte/models/shared/source_bing_ads.py +++ b/src/airbyte/models/shared/source_bing_ads.py @@ -93,7 +93,6 @@ class SourceBingAds: r"""Developer token associated with user. See more info in the docs.""" refresh_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('refresh_token') }}) r"""Refresh Token to renew the expired Access Token.""" - SOURCE_TYPE: Final[SourceBingAdsBingAds] = dataclasses.field(default=SourceBingAdsBingAds.BING_ADS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) account_names: Optional[List[AccountNames]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('account_names'), 'exclude': lambda f: f is None }}) r"""Predicates that will be used to sync data by specific accounts.""" AUTH_METHOD: Final[Optional[AuthMethod]] = dataclasses.field(default=AuthMethod.OAUTH2_0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_method'), 'exclude': lambda f: f is None }}) @@ -105,6 +104,7 @@ class SourceBingAds: r"""Also known as attribution or conversion window. How far into the past to look for records (in days). If your conversion window has an hours/minutes granularity, round it up to the number of days exceeding. Used only for performance report streams in incremental mode without specified Reports Start Date.""" reports_start_date: Optional[date] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reports_start_date'), 'encoder': utils.dateisoformat(True), 'decoder': utils.datefromisoformat, 'exclude': lambda f: f is None }}) r"""The start date from which to begin replicating report data. Any data generated before this date will not be replicated in reports. This is a UTC date in YYYY-MM-DD format. If not set, data from previous and current calendar year will be replicated.""" + SOURCE_TYPE: Final[SourceBingAdsBingAds] = dataclasses.field(default=SourceBingAdsBingAds.BING_ADS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) tenant_id: Optional[str] = dataclasses.field(default='common', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tenant_id'), 'exclude': lambda f: f is None }}) r"""The Tenant ID of your Microsoft Advertising developer application. Set this to \\"common\\" unless you know you need a different value.""" diff --git a/src/airbyte/models/shared/source_cart.py b/src/airbyte/models/shared/source_cart.py index 2d0ce0f2..84e0c84b 100644 --- a/src/airbyte/models/shared/source_cart.py +++ b/src/airbyte/models/shared/source_cart.py @@ -48,7 +48,7 @@ class Cart(str, Enum): class SourceCart: start_date: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date') }}) r"""The date from which you'd like to replicate the data""" - SOURCE_TYPE: Final[Cart] = dataclasses.field(default=Cart.CART, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) credentials: Optional[Union[CentralAPIRouter, SingleStoreAccessToken]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) + SOURCE_TYPE: Final[Cart] = dataclasses.field(default=Cart.CART, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_clickhouse.py b/src/airbyte/models/shared/source_clickhouse.py index 4fb9e7b7..5c170552 100644 --- a/src/airbyte/models/shared/source_clickhouse.py +++ b/src/airbyte/models/shared/source_clickhouse.py @@ -75,13 +75,13 @@ class SourceClickhouse: r"""The host endpoint of the Clickhouse cluster.""" username: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('username') }}) r"""The username which is used to access the database.""" - SOURCE_TYPE: Final[SourceClickhouseClickhouse] = dataclasses.field(default=SourceClickhouseClickhouse.CLICKHOUSE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) jdbc_url_params: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('jdbc_url_params'), 'exclude': lambda f: f is None }}) r"""Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (Eg. key1=value1&key2=value2&key3=value3). For more information read about JDBC URL parameters.""" password: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('password'), 'exclude': lambda f: f is None }}) r"""The password associated with this username.""" port: Optional[int] = dataclasses.field(default=8123, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('port'), 'exclude': lambda f: f is None }}) r"""The port of the database.""" + SOURCE_TYPE: Final[SourceClickhouseClickhouse] = dataclasses.field(default=SourceClickhouseClickhouse.CLICKHOUSE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) tunnel_method: Optional[Union[SourceClickhouseNoTunnel, SourceClickhouseSSHKeyAuthentication, SourceClickhousePasswordAuthentication]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tunnel_method'), 'exclude': lambda f: f is None }}) r"""Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.""" diff --git a/src/airbyte/models/shared/source_clickup_api.py b/src/airbyte/models/shared/source_clickup_api.py index 9cc15057..43da32ab 100644 --- a/src/airbyte/models/shared/source_clickup_api.py +++ b/src/airbyte/models/shared/source_clickup_api.py @@ -16,13 +16,13 @@ class ClickupAPI(str, Enum): class SourceClickupAPI: api_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_token') }}) r"""Every ClickUp API call required authentication. This field is your personal API token. See here.""" - SOURCE_TYPE: Final[ClickupAPI] = dataclasses.field(default=ClickupAPI.CLICKUP_API, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) folder_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('folder_id'), 'exclude': lambda f: f is None }}) r"""The ID of your folder in your space. Retrieve it from the `/space/{space_id}/folder` of the ClickUp API. See here.""" include_closed_tasks: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('include_closed_tasks'), 'exclude': lambda f: f is None }}) r"""Include or exclude closed tasks. By default, they are excluded. See here.""" list_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('list_id'), 'exclude': lambda f: f is None }}) r"""The ID of your list in your folder. Retrieve it from the `/folder/{folder_id}/list` of the ClickUp API. See here.""" + SOURCE_TYPE: Final[ClickupAPI] = dataclasses.field(default=ClickupAPI.CLICKUP_API, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) space_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('space_id'), 'exclude': lambda f: f is None }}) r"""The ID of your space in your workspace. Retrieve it from the `/team/{team_id}/space` of the ClickUp API. See here.""" team_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('team_id'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_clockify.py b/src/airbyte/models/shared/source_clockify.py index 50c918a1..907c72e1 100644 --- a/src/airbyte/models/shared/source_clockify.py +++ b/src/airbyte/models/shared/source_clockify.py @@ -18,8 +18,8 @@ class SourceClockify: r"""You can get your api access_key here This API is Case Sensitive.""" workspace_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('workspace_id') }}) r"""WorkSpace Id""" - SOURCE_TYPE: Final[Clockify] = dataclasses.field(default=Clockify.CLOCKIFY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) api_url: Optional[str] = dataclasses.field(default='https://api.clockify.me', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_url'), 'exclude': lambda f: f is None }}) r"""The URL for the Clockify API. This should only need to be modified if connecting to an enterprise version of Clockify.""" + SOURCE_TYPE: Final[Clockify] = dataclasses.field(default=Clockify.CLOCKIFY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_coin_api.py b/src/airbyte/models/shared/source_coin_api.py index a8c7896c..eb642f2d 100644 --- a/src/airbyte/models/shared/source_coin_api.py +++ b/src/airbyte/models/shared/source_coin_api.py @@ -29,7 +29,6 @@ class SourceCoinAPI: r"""The symbol ID to use. See the documentation for a list. https://docs.coinapi.io/#list-all-symbols-get """ - SOURCE_TYPE: Final[CoinAPI] = dataclasses.field(default=CoinAPI.COIN_API, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) end_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('end_date'), 'exclude': lambda f: f is None }}) r"""The end date in ISO 8601 format. If not supplied, data will be returned from the start date to the current time, or when the count of result @@ -42,5 +41,6 @@ class SourceCoinAPI: is 100. For numbers larger than 100, each 100 items is counted as one request for pricing purposes. Maximum value is 100000. """ + SOURCE_TYPE: Final[CoinAPI] = dataclasses.field(default=CoinAPI.COIN_API, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_dixa.py b/src/airbyte/models/shared/source_dixa.py index 419e0a54..5e648411 100644 --- a/src/airbyte/models/shared/source_dixa.py +++ b/src/airbyte/models/shared/source_dixa.py @@ -20,8 +20,8 @@ class SourceDixa: r"""Dixa API token""" start_date: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) r"""The connector pulls records updated from this date onwards.""" - SOURCE_TYPE: Final[Dixa] = dataclasses.field(default=Dixa.DIXA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) batch_size: Optional[int] = dataclasses.field(default=31, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('batch_size'), 'exclude': lambda f: f is None }}) r"""Number of days to batch into one request. Max 31.""" + SOURCE_TYPE: Final[Dixa] = dataclasses.field(default=Dixa.DIXA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_dremio.py b/src/airbyte/models/shared/source_dremio.py index 0dbf1e47..74bb110b 100644 --- a/src/airbyte/models/shared/source_dremio.py +++ b/src/airbyte/models/shared/source_dremio.py @@ -16,8 +16,8 @@ class Dremio(str, Enum): class SourceDremio: api_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_key') }}) r"""API Key that is generated when you authenticate to Dremio API""" - SOURCE_TYPE: Final[Dremio] = dataclasses.field(default=Dremio.DREMIO, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) base_url: Optional[str] = dataclasses.field(default='https://app.dremio.cloud', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('base_url'), 'exclude': lambda f: f is None }}) r"""URL of your Dremio instance""" + SOURCE_TYPE: Final[Dremio] = dataclasses.field(default=Dremio.DREMIO, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_dynamodb.py b/src/airbyte/models/shared/source_dynamodb.py index 6163a573..c7da4b76 100644 --- a/src/airbyte/models/shared/source_dynamodb.py +++ b/src/airbyte/models/shared/source_dynamodb.py @@ -55,12 +55,12 @@ class SourceDynamodb: r"""The access key id to access Dynamodb. Airbyte requires read permissions to the database""" secret_access_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('secret_access_key') }}) r"""The corresponding secret to the access key id.""" - SOURCE_TYPE: Final[SourceDynamodbDynamodb] = dataclasses.field(default=SourceDynamodbDynamodb.DYNAMODB, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) endpoint: Optional[str] = dataclasses.field(default='', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('endpoint'), 'exclude': lambda f: f is None }}) r"""the URL of the Dynamodb database""" region: Optional[SourceDynamodbDynamodbRegion] = dataclasses.field(default=SourceDynamodbDynamodbRegion.UNKNOWN, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('region'), 'exclude': lambda f: f is None }}) r"""The region of the Dynamodb database""" reserved_attribute_names: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reserved_attribute_names'), 'exclude': lambda f: f is None }}) r"""Comma separated reserved attribute names present in your tables""" + SOURCE_TYPE: Final[SourceDynamodbDynamodb] = dataclasses.field(default=SourceDynamodbDynamodb.DYNAMODB, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_exchange_rates.py b/src/airbyte/models/shared/source_exchange_rates.py index 08eccddf..821beb0e 100644 --- a/src/airbyte/models/shared/source_exchange_rates.py +++ b/src/airbyte/models/shared/source_exchange_rates.py @@ -19,10 +19,10 @@ class SourceExchangeRates: r"""Your API Key. See here. The key is case sensitive.""" start_date: date = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.dateisoformat(False), 'decoder': utils.datefromisoformat }}) r"""Start getting data from that date.""" - SOURCE_TYPE: Final[ExchangeRates] = dataclasses.field(default=ExchangeRates.EXCHANGE_RATES, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) base: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('base'), 'exclude': lambda f: f is None }}) r"""ISO reference currency. See here. Free plan doesn't support Source Currency Switching, default base currency is EUR""" ignore_weekends: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ignore_weekends'), 'exclude': lambda f: f is None }}) r"""Ignore weekends? (Exchanges don't run on weekends)""" + SOURCE_TYPE: Final[ExchangeRates] = dataclasses.field(default=ExchangeRates.EXCHANGE_RATES, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_facebook_marketing.py b/src/airbyte/models/shared/source_facebook_marketing.py index d1990bd6..3f1eace9 100644 --- a/src/airbyte/models/shared/source_facebook_marketing.py +++ b/src/airbyte/models/shared/source_facebook_marketing.py @@ -246,7 +246,6 @@ class SourceFacebookMarketing: r"""The value of the generated access token. From your App’s Dashboard, click on \\"Marketing API\\" then \\"Tools\\". Select permissions ads_management, ads_read, read_insights, business_management. Then click on \\"Get token\\". See the docs for more information.""" account_ids: List[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('account_ids') }}) r"""The Facebook Ad account ID(s) to pull data from. The Ad account ID number is in the account dropdown menu or in your browser's address bar of your Meta Ads Manager. See the docs for more information.""" - SOURCE_TYPE: Final[SourceFacebookMarketingFacebookMarketing] = dataclasses.field(default=SourceFacebookMarketingFacebookMarketing.FACEBOOK_MARKETING, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) action_breakdowns_allow_empty: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('action_breakdowns_allow_empty'), 'exclude': lambda f: f is None }}) r"""Allows action_breakdowns to be an empty list""" client_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_id'), 'exclude': lambda f: f is None }}) @@ -267,6 +266,7 @@ class SourceFacebookMarketing: r"""The attribution window. Facebook freezes insight data 28 days after it was generated, which means that all data from the past 28 days may have changed since we last emitted it, so you can retrieve refreshed insights from the past by setting this parameter. If you set a custom lookback window value in Facebook account, please provide the same value here.""" page_size: Optional[int] = dataclasses.field(default=100, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('page_size'), 'exclude': lambda f: f is None }}) r"""Page size used when sending requests to Facebook API to specify number of records per page when response has pagination. Most users do not need to set this field unless they specifically need to tune the connector to address specific issues or use cases.""" + SOURCE_TYPE: Final[SourceFacebookMarketingFacebookMarketing] = dataclasses.field(default=SourceFacebookMarketingFacebookMarketing.FACEBOOK_MARKETING, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""The date from which you'd like to replicate data for all incremental streams, in the format YYYY-MM-DDT00:00:00Z. If not set then all data will be replicated for usual streams and only last 2 years for insight streams.""" diff --git a/src/airbyte/models/shared/source_faker.py b/src/airbyte/models/shared/source_faker.py index bd90800a..2d3c6824 100644 --- a/src/airbyte/models/shared/source_faker.py +++ b/src/airbyte/models/shared/source_faker.py @@ -14,7 +14,6 @@ class Faker(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceFaker: - SOURCE_TYPE: Final[Faker] = dataclasses.field(default=Faker.FAKER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) always_updated: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('always_updated'), 'exclude': lambda f: f is None }}) r"""Should the updated_at values for every record be new each sync? Setting this to false will case the source to stop emitting records after COUNT records have been emitted.""" count: Optional[int] = dataclasses.field(default=1000, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('count'), 'exclude': lambda f: f is None }}) @@ -25,5 +24,6 @@ class SourceFaker: r"""How many fake records will be in each page (stream slice), before a state message is emitted?""" seed: Optional[int] = dataclasses.field(default=-1, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('seed'), 'exclude': lambda f: f is None }}) r"""Manually control the faker random seed to return the same values on subsequent runs (leave -1 for random)""" + SOURCE_TYPE: Final[Faker] = dataclasses.field(default=Faker.FAKER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_fauna.py b/src/airbyte/models/shared/source_fauna.py index 6c08e9d1..bc745522 100644 --- a/src/airbyte/models/shared/source_fauna.py +++ b/src/airbyte/models/shared/source_fauna.py @@ -14,9 +14,9 @@ class SourceFaunaSchemasDeletionMode(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class Enabled: - DELETION_MODE: Final[SourceFaunaSchemasDeletionMode] = dataclasses.field(default=SourceFaunaSchemasDeletionMode.DELETED_FIELD, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deletion_mode') }}) column: Optional[str] = dataclasses.field(default='deleted_at', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('column'), 'exclude': lambda f: f is None }}) r"""Name of the \\"deleted at\\" column.""" + DELETION_MODE: Final[SourceFaunaSchemasDeletionMode] = dataclasses.field(default=SourceFaunaSchemasDeletionMode.DELETED_FIELD, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('deletion_mode') }}) @@ -59,7 +59,6 @@ class Fauna(str, Enum): class SourceFauna: secret: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('secret') }}) r"""Fauna secret, used when authenticating with the database.""" - SOURCE_TYPE: Final[Fauna] = dataclasses.field(default=Fauna.FAUNA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) collection: Optional[Collection] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('collection'), 'exclude': lambda f: f is None }}) r"""Settings for the Fauna Collection.""" domain: Optional[str] = dataclasses.field(default='db.fauna.com', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('domain'), 'exclude': lambda f: f is None }}) @@ -68,5 +67,6 @@ class SourceFauna: r"""Endpoint port.""" scheme: Optional[str] = dataclasses.field(default='https', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('scheme'), 'exclude': lambda f: f is None }}) r"""URL scheme.""" + SOURCE_TYPE: Final[Fauna] = dataclasses.field(default=Fauna.FAUNA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_file.py b/src/airbyte/models/shared/source_file.py index dc4b8e33..65dbe354 100644 --- a/src/airbyte/models/shared/source_file.py +++ b/src/airbyte/models/shared/source_file.py @@ -27,9 +27,9 @@ class SourceFileSchemasProviderStorageProvider7Storage(str, Enum): class SFTPSecureFileTransferProtocol: host: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('host') }}) user: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('user') }}) - STORAGE: Final[SourceFileSchemasProviderStorageProvider7Storage] = dataclasses.field(default=SourceFileSchemasProviderStorageProvider7Storage.SFTP, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('storage') }}) password: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('password'), 'exclude': lambda f: f is None }}) port: Optional[str] = dataclasses.field(default='22', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('port'), 'exclude': lambda f: f is None }}) + STORAGE: Final[SourceFileSchemasProviderStorageProvider7Storage] = dataclasses.field(default=SourceFileSchemasProviderStorageProvider7Storage.SFTP, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('storage') }}) @@ -42,9 +42,9 @@ class SourceFileSchemasProviderStorageProvider6Storage(str, Enum): class SCPSecureCopyProtocol: host: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('host') }}) user: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('user') }}) - STORAGE: Final[SourceFileSchemasProviderStorageProvider6Storage] = dataclasses.field(default=SourceFileSchemasProviderStorageProvider6Storage.SCP, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('storage') }}) password: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('password'), 'exclude': lambda f: f is None }}) port: Optional[str] = dataclasses.field(default='22', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('port'), 'exclude': lambda f: f is None }}) + STORAGE: Final[SourceFileSchemasProviderStorageProvider6Storage] = dataclasses.field(default=SourceFileSchemasProviderStorageProvider6Storage.SCP, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('storage') }}) @@ -57,9 +57,9 @@ class SourceFileSchemasProviderStorageProviderStorage(str, Enum): class SSHSecureShell: host: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('host') }}) user: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('user') }}) - STORAGE: Final[SourceFileSchemasProviderStorageProviderStorage] = dataclasses.field(default=SourceFileSchemasProviderStorageProviderStorage.SSH, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('storage') }}) password: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('password'), 'exclude': lambda f: f is None }}) port: Optional[str] = dataclasses.field(default='22', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('port'), 'exclude': lambda f: f is None }}) + STORAGE: Final[SourceFileSchemasProviderStorageProviderStorage] = dataclasses.field(default=SourceFileSchemasProviderStorageProviderStorage.SSH, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('storage') }}) @@ -72,11 +72,11 @@ class SourceFileSchemasProviderStorage(str, Enum): class AzBlobAzureBlobStorage: storage_account: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('storage_account') }}) r"""The globally unique name of the storage account that the desired blob sits within. See here for more details.""" - STORAGE: Final[SourceFileSchemasProviderStorage] = dataclasses.field(default=SourceFileSchemasProviderStorage.AZ_BLOB, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('storage') }}) sas_token: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sas_token'), 'exclude': lambda f: f is None }}) r"""To access Azure Blob Storage, this connector would need credentials with the proper permissions. One option is a SAS (Shared Access Signature) token. If accessing publicly available data, this field is not necessary.""" shared_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('shared_key'), 'exclude': lambda f: f is None }}) r"""To access Azure Blob Storage, this connector would need credentials with the proper permissions. One option is a storage account shared key (aka account key or access key). If accessing publicly available data, this field is not necessary.""" + STORAGE: Final[SourceFileSchemasProviderStorage] = dataclasses.field(default=SourceFileSchemasProviderStorage.AZ_BLOB, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('storage') }}) @@ -87,11 +87,11 @@ class SourceFileSchemasStorage(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceFileS3AmazonWebServices: - STORAGE: Final[SourceFileSchemasStorage] = dataclasses.field(default=SourceFileSchemasStorage.S3, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('storage') }}) aws_access_key_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('aws_access_key_id'), 'exclude': lambda f: f is None }}) r"""In order to access private Buckets stored on AWS S3, this connector would need credentials with the proper permissions. If accessing publicly available data, this field is not necessary.""" aws_secret_access_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('aws_secret_access_key'), 'exclude': lambda f: f is None }}) r"""In order to access private Buckets stored on AWS S3, this connector would need credentials with the proper permissions. If accessing publicly available data, this field is not necessary.""" + STORAGE: Final[SourceFileSchemasStorage] = dataclasses.field(default=SourceFileSchemasStorage.S3, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('storage') }}) @@ -102,9 +102,9 @@ class SourceFileStorage(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class GCSGoogleCloudStorage: - STORAGE: Final[SourceFileStorage] = dataclasses.field(default=SourceFileStorage.GCS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('storage') }}) service_account_json: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('service_account_json'), 'exclude': lambda f: f is None }}) r"""In order to access private Buckets stored on Google Cloud, this connector would need a service account json credentials with the proper permissions as described here. Please generate the credentials.json file and copy/paste its content to this field (expecting JSON formats). If accessing publicly available data, this field is not necessary.""" + STORAGE: Final[SourceFileStorage] = dataclasses.field(default=SourceFileStorage.GCS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('storage') }}) @@ -134,10 +134,10 @@ class SourceFile: r"""The storage Provider or Location of the file(s) which should be replicated.""" url: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('url') }}) r"""The URL path to access the file which should be replicated.""" - SOURCE_TYPE: Final[File] = dataclasses.field(default=File.FILE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) format: Optional[FileFormat] = dataclasses.field(default=FileFormat.CSV, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('format'), 'exclude': lambda f: f is None }}) r"""The Format of the file which should be replicated (Warning: some formats may be experimental, please refer to the docs).""" reader_options: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('reader_options'), 'exclude': lambda f: f is None }}) r"""This should be a string in JSON format. It depends on the chosen file format to provide additional options and tune its behavior.""" + SOURCE_TYPE: Final[File] = dataclasses.field(default=File.FILE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_firebolt.py b/src/airbyte/models/shared/source_firebolt.py index 0850ffec..e849f3ea 100644 --- a/src/airbyte/models/shared/source_firebolt.py +++ b/src/airbyte/models/shared/source_firebolt.py @@ -20,12 +20,12 @@ class SourceFirebolt: r"""Firebolt password.""" username: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('username') }}) r"""Firebolt email address you use to login.""" - SOURCE_TYPE: Final[SourceFireboltFirebolt] = dataclasses.field(default=SourceFireboltFirebolt.FIREBOLT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) account: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('account'), 'exclude': lambda f: f is None }}) r"""Firebolt account to login.""" engine: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('engine'), 'exclude': lambda f: f is None }}) r"""Engine name or url to connect to.""" host: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('host'), 'exclude': lambda f: f is None }}) r"""The host name of your Firebolt database.""" + SOURCE_TYPE: Final[SourceFireboltFirebolt] = dataclasses.field(default=SourceFireboltFirebolt.FIREBOLT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_freshcaller.py b/src/airbyte/models/shared/source_freshcaller.py index 7fa093bc..a2b47f72 100644 --- a/src/airbyte/models/shared/source_freshcaller.py +++ b/src/airbyte/models/shared/source_freshcaller.py @@ -20,9 +20,9 @@ class SourceFreshcaller: r"""Freshcaller API Key. See the docs for more information on how to obtain this key.""" domain: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('domain') }}) r"""Used to construct Base URL for the Freshcaller APIs""" - SOURCE_TYPE: Final[Freshcaller] = dataclasses.field(default=Freshcaller.FRESHCALLER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) requests_per_minute: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('requests_per_minute'), 'exclude': lambda f: f is None }}) r"""The number of requests per minute that this source allowed to use. There is a rate limit of 50 requests per minute per app per account.""" + SOURCE_TYPE: Final[Freshcaller] = dataclasses.field(default=Freshcaller.FRESHCALLER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""UTC date and time. Any data created after this date will be replicated.""" sync_lag_minutes: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sync_lag_minutes'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_freshdesk.py b/src/airbyte/models/shared/source_freshdesk.py index 2fa64735..d516adfb 100644 --- a/src/airbyte/models/shared/source_freshdesk.py +++ b/src/airbyte/models/shared/source_freshdesk.py @@ -20,9 +20,9 @@ class SourceFreshdesk: r"""Freshdesk API Key. See the docs for more information on how to obtain this key.""" domain: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('domain') }}) r"""Freshdesk domain""" - SOURCE_TYPE: Final[Freshdesk] = dataclasses.field(default=Freshdesk.FRESHDESK, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) requests_per_minute: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('requests_per_minute'), 'exclude': lambda f: f is None }}) r"""The number of requests per minute that this source allowed to use. There is a rate limit of 50 requests per minute per app per account.""" + SOURCE_TYPE: Final[Freshdesk] = dataclasses.field(default=Freshdesk.FRESHDESK, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""UTC date and time. Any data created after this date will be replicated. If this parameter is not set, all data will be replicated.""" diff --git a/src/airbyte/models/shared/source_getlago.py b/src/airbyte/models/shared/source_getlago.py index 01f25045..74339911 100644 --- a/src/airbyte/models/shared/source_getlago.py +++ b/src/airbyte/models/shared/source_getlago.py @@ -16,8 +16,8 @@ class Getlago(str, Enum): class SourceGetlago: api_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_key') }}) r"""Your API Key. See here.""" - SOURCE_TYPE: Final[Getlago] = dataclasses.field(default=Getlago.GETLAGO, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) api_url: Optional[str] = dataclasses.field(default='https://api.getlago.com/api/v1', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_url'), 'exclude': lambda f: f is None }}) r"""Your Lago API URL""" + SOURCE_TYPE: Final[Getlago] = dataclasses.field(default=Getlago.GETLAGO, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_github.py b/src/airbyte/models/shared/source_github.py index 54d92334..f2469157 100644 --- a/src/airbyte/models/shared/source_github.py +++ b/src/airbyte/models/shared/source_github.py @@ -50,7 +50,6 @@ class SourceGithub: r"""Choose how to authenticate to GitHub""" repositories: List[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('repositories') }}) r"""List of GitHub organizations/repositories, e.g. `airbytehq/airbyte` for single repository, `airbytehq/*` for get all repositories from organization and `airbytehq/airbyte airbytehq/another-repo` for multiple repositories.""" - SOURCE_TYPE: Final[SourceGithubGithub] = dataclasses.field(default=SourceGithubGithub.GITHUB, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) api_url: Optional[str] = dataclasses.field(default='https://api.github.com/', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_url'), 'exclude': lambda f: f is None }}) r"""Please enter your basic URL from self-hosted GitHub instance or leave it empty to use GitHub.""" branch: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('branch'), 'exclude': lambda f: f is None }}) @@ -61,6 +60,7 @@ class SourceGithub: r"""(DEPRCATED) Space-delimited list of GitHub organizations/repositories, e.g. `airbytehq/airbyte` for single repository, `airbytehq/*` for get all repositories from organization and `airbytehq/airbyte airbytehq/another-repo` for multiple repositories.""" requests_per_hour: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('requests_per_hour'), 'exclude': lambda f: f is None }}) r"""The GitHub API allows for a maximum of 5000 requests per hour (15000 for Github Enterprise). You can specify a lower value to limit your use of the API quota.""" + SOURCE_TYPE: Final[SourceGithubGithub] = dataclasses.field(default=SourceGithubGithub.GITHUB, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""The date from which you'd like to replicate data from GitHub in the format YYYY-MM-DDT00:00:00Z. If the date is not set, all data will be replicated. For the streams which support this configuration, only data generated on or after the start date will be replicated. This field doesn't apply to all streams, see the docs for more info""" diff --git a/src/airbyte/models/shared/source_gitlab.py b/src/airbyte/models/shared/source_gitlab.py index 33581a45..4d4f5d74 100644 --- a/src/airbyte/models/shared/source_gitlab.py +++ b/src/airbyte/models/shared/source_gitlab.py @@ -51,7 +51,6 @@ class SourceGitlabGitlab(str, Enum): @dataclasses.dataclass class SourceGitlab: credentials: Union[SourceGitlabOAuth20, PrivateToken] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials') }}) - SOURCE_TYPE: Final[SourceGitlabGitlab] = dataclasses.field(default=SourceGitlabGitlab.GITLAB, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) api_url: Optional[str] = dataclasses.field(default='gitlab.com', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_url'), 'exclude': lambda f: f is None }}) r"""Please enter your basic URL from GitLab instance.""" groups: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('groups'), 'exclude': lambda f: f is None }}) @@ -62,6 +61,7 @@ class SourceGitlab: r"""[DEPRECATED] Space-delimited list of projects. e.g. airbyte.io/documentation meltano/tap-gitlab.""" projects_list: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('projects_list'), 'exclude': lambda f: f is None }}) r"""Space-delimited list of projects. e.g. airbyte.io/documentation meltano/tap-gitlab.""" + SOURCE_TYPE: Final[SourceGitlabGitlab] = dataclasses.field(default=SourceGitlabGitlab.GITLAB, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""The date from which you'd like to replicate data for GitLab API, in the format YYYY-MM-DDT00:00:00Z. Optional. If not set, all data will be replicated. All data generated after this date will be replicated.""" diff --git a/src/airbyte/models/shared/source_gnews.py b/src/airbyte/models/shared/source_gnews.py index 16998717..907d254f 100644 --- a/src/airbyte/models/shared/source_gnews.py +++ b/src/airbyte/models/shared/source_gnews.py @@ -119,7 +119,6 @@ class SourceGnews: For example the query: Apple NOT iPhone will return all articles matching the keyword Apple but not the keyword iPhone """ - SOURCE_TYPE: Final[Gnews] = dataclasses.field(default=Gnews.GNEWS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) country: Optional[Country] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('country'), 'exclude': lambda f: f is None }}) r"""This parameter allows you to specify the country where the news articles returned by the API were published, the contents of the articles are not necessarily related to the specified country. You have to set as value the 2 letters code of the country you want to filter.""" end_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('end_date'), 'exclude': lambda f: f is None }}) @@ -134,6 +133,7 @@ class SourceGnews: - publishedAt = sort by publication date, the articles with the most recent publication date are returned first - relevance = sort by best match to keywords, the articles with the best match are returned first """ + SOURCE_TYPE: Final[Gnews] = dataclasses.field(default=Gnews.GNEWS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'exclude': lambda f: f is None }}) r"""This parameter allows you to filter the articles that have a publication date greater than or equal to the specified value. The date must respect the following format: YYYY-MM-DD hh:mm:ss (in UTC)""" top_headlines_query: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('top_headlines_query'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_google_ads.py b/src/airbyte/models/shared/source_google_ads.py index 0022d5a0..172cccab 100644 --- a/src/airbyte/models/shared/source_google_ads.py +++ b/src/airbyte/models/shared/source_google_ads.py @@ -52,7 +52,6 @@ class SourceGoogleAdsGoogleAds(str, Enum): @dataclasses.dataclass class SourceGoogleAds: credentials: GoogleCredentials = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials') }}) - SOURCE_TYPE: Final[SourceGoogleAdsGoogleAds] = dataclasses.field(default=SourceGoogleAdsGoogleAds.GOOGLE_ADS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) conversion_window_days: Optional[int] = dataclasses.field(default=14, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('conversion_window_days'), 'exclude': lambda f: f is None }}) r"""A conversion window is the number of days after an ad interaction (such as an ad click or video view) during which a conversion, such as a purchase, is recorded in Google Ads. For more information, see Google's documentation.""" custom_queries_array: Optional[List[CustomQueriesArray]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('custom_queries_array'), 'exclude': lambda f: f is None }}) @@ -62,6 +61,7 @@ class SourceGoogleAds: r"""A list of customer statuses to filter on. For detailed info about what each status mean refer to Google Ads documentation.""" end_date: Optional[date] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('end_date'), 'encoder': utils.dateisoformat(True), 'decoder': utils.datefromisoformat, 'exclude': lambda f: f is None }}) r"""UTC date in the format YYYY-MM-DD. Any data after this date will not be replicated. (Default value of today is used if not set)""" + SOURCE_TYPE: Final[SourceGoogleAdsGoogleAds] = dataclasses.field(default=SourceGoogleAdsGoogleAds.GOOGLE_ADS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[date] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.dateisoformat(True), 'decoder': utils.datefromisoformat, 'exclude': lambda f: f is None }}) r"""UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. (Default value of two years ago is used if not set)""" diff --git a/src/airbyte/models/shared/source_google_analytics_data_api.py b/src/airbyte/models/shared/source_google_analytics_data_api.py index 0201b082..a00dadd4 100644 --- a/src/airbyte/models/shared/source_google_analytics_data_api.py +++ b/src/airbyte/models/shared/source_google_analytics_data_api.py @@ -235,8 +235,8 @@ class SourceGoogleAnalyticsDataAPIFilterName(str, Enum): @dataclasses.dataclass class InListFilter: values: List[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('values') }}) - FILTER_NAME: Final[SourceGoogleAnalyticsDataAPIFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPIFilterName.IN_LIST_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caseSensitive'), 'exclude': lambda f: f is None }}) + FILTER_NAME: Final[SourceGoogleAnalyticsDataAPIFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPIFilterName.IN_LIST_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) @@ -257,8 +257,8 @@ class SourceGoogleAnalyticsDataAPIValidEnums(str, Enum): @dataclasses.dataclass class StringFilter: value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) - FILTER_NAME: Final[FilterName] = dataclasses.field(default=FilterName.STRING_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caseSensitive'), 'exclude': lambda f: f is None }}) + FILTER_NAME: Final[FilterName] = dataclasses.field(default=FilterName.STRING_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) match_type: Optional[List[SourceGoogleAnalyticsDataAPIValidEnums]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('matchType'), 'exclude': lambda f: f is None }}) @@ -391,8 +391,8 @@ class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimens @dataclasses.dataclass class SourceGoogleAnalyticsDataAPISchemasInListFilter: values: List[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('values') }}) - FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterName.IN_LIST_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caseSensitive'), 'exclude': lambda f: f is None }}) + FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3ExpressionFilterName.IN_LIST_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) @@ -413,8 +413,8 @@ class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimens @dataclasses.dataclass class SourceGoogleAnalyticsDataAPISchemasStringFilter: value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) - FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3FilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3FilterName.STRING_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caseSensitive'), 'exclude': lambda f: f is None }}) + FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3FilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter3FilterName.STRING_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) match_type: Optional[List[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterValidEnums]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('matchType'), 'exclude': lambda f: f is None }}) @@ -555,8 +555,8 @@ class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimens @dataclasses.dataclass class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterInListFilter: values: List[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('values') }}) - FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterFilterName.IN_LIST_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caseSensitive'), 'exclude': lambda f: f is None }}) + FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilterFilterName.IN_LIST_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) @@ -577,8 +577,8 @@ class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimens @dataclasses.dataclass class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterStringFilter: value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) - FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFilterName.STRING_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caseSensitive'), 'exclude': lambda f: f is None }}) + FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterFilterName.STRING_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) match_type: Optional[List[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter2ValidEnums]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('matchType'), 'exclude': lambda f: f is None }}) @@ -719,8 +719,8 @@ class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimens @dataclasses.dataclass class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayInListFilter: values: List[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('values') }}) - FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterName.IN_LIST_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caseSensitive'), 'exclude': lambda f: f is None }}) + FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ExpressionsFilterName.IN_LIST_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) @@ -741,8 +741,8 @@ class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimens @dataclasses.dataclass class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayStringFilter: value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) - FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1FilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1FilterName.STRING_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caseSensitive'), 'exclude': lambda f: f is None }}) + FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1FilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1FilterName.STRING_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) match_type: Optional[List[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayDimensionFilterDimensionsFilter1ValidEnums]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('matchType'), 'exclude': lambda f: f is None }}) @@ -883,8 +883,8 @@ class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFi @dataclasses.dataclass class SourceGoogleAnalyticsDataAPIInListFilter: values: List[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('values') }}) - FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilterName.IN_LIST_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caseSensitive'), 'exclude': lambda f: f is None }}) + FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterFilterName.IN_LIST_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) @@ -905,8 +905,8 @@ class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayValidEnums(str, Enum) @dataclasses.dataclass class SourceGoogleAnalyticsDataAPIStringFilter: value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) - FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilterName.STRING_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caseSensitive'), 'exclude': lambda f: f is None }}) + FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterFilterName.STRING_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) match_type: Optional[List[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayValidEnums]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('matchType'), 'exclude': lambda f: f is None }}) @@ -1039,8 +1039,8 @@ class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFi @dataclasses.dataclass class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3InListFilter: values: List[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('values') }}) - FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterName.IN_LIST_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caseSensitive'), 'exclude': lambda f: f is None }}) + FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ExpressionFilterName.IN_LIST_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) @@ -1061,8 +1061,8 @@ class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFi @dataclasses.dataclass class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3StringFilter: value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) - FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3FilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3FilterName.STRING_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caseSensitive'), 'exclude': lambda f: f is None }}) + FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3FilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3FilterName.STRING_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) match_type: Optional[List[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter3ValidEnums]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('matchType'), 'exclude': lambda f: f is None }}) @@ -1203,8 +1203,8 @@ class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFi @dataclasses.dataclass class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterInListFilter: values: List[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('values') }}) - FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterName.IN_LIST_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caseSensitive'), 'exclude': lambda f: f is None }}) + FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ExpressionsFilterName.IN_LIST_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) @@ -1225,8 +1225,8 @@ class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFi @dataclasses.dataclass class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilterStringFilter: value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) - FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2FilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2FilterName.STRING_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caseSensitive'), 'exclude': lambda f: f is None }}) + FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2FilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2FilterName.STRING_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) match_type: Optional[List[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter2ValidEnums]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('matchType'), 'exclude': lambda f: f is None }}) @@ -1367,8 +1367,8 @@ class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFi @dataclasses.dataclass class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterInListFilter: values: List[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('values') }}) - FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterFilterName.IN_LIST_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caseSensitive'), 'exclude': lambda f: f is None }}) + FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterFilterName.IN_LIST_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) @@ -1389,8 +1389,8 @@ class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFi @dataclasses.dataclass class SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterStringFilter: value: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('value') }}) - FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterName.STRING_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) case_sensitive: Optional[bool] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('caseSensitive'), 'exclude': lambda f: f is None }}) + FILTER_NAME: Final[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterName] = dataclasses.field(default=SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ExpressionsFilterFilterName.STRING_FILTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('filter_name') }}) match_type: Optional[List[SourceGoogleAnalyticsDataAPISchemasCustomReportsArrayMetricFilterMetricsFilter1ValidEnums]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('matchType'), 'exclude': lambda f: f is None }}) @@ -1445,7 +1445,6 @@ class SourceGoogleAnalyticsDataAPIGoogleAnalyticsDataAPI(str, Enum): class SourceGoogleAnalyticsDataAPI: property_ids: List[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('property_ids') }}) r"""A list of your Property IDs. The Property ID is a unique number assigned to each property in Google Analytics, found in your GA4 property URL. This ID allows the connector to track the specific events associated with your property. Refer to the Google Analytics documentation to locate your property ID.""" - SOURCE_TYPE: Final[SourceGoogleAnalyticsDataAPIGoogleAnalyticsDataAPI] = dataclasses.field(default=SourceGoogleAnalyticsDataAPIGoogleAnalyticsDataAPI.GOOGLE_ANALYTICS_DATA_API, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) credentials: Optional[Union[AuthenticateViaGoogleOauth, ServiceAccountKeyAuthentication]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) r"""Credentials for the service""" custom_reports_array: Optional[List[SourceGoogleAnalyticsDataAPICustomReportConfig]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('custom_reports_array'), 'exclude': lambda f: f is None }}) @@ -1454,6 +1453,7 @@ class SourceGoogleAnalyticsDataAPI: r"""The start date from which to replicate report data in the format YYYY-MM-DD. Data generated before this date will not be included in the report. Not applied to custom Cohort reports.""" keep_empty_rows: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('keep_empty_rows'), 'exclude': lambda f: f is None }}) r"""If false, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. More information is available in the documentation.""" + SOURCE_TYPE: Final[SourceGoogleAnalyticsDataAPIGoogleAnalyticsDataAPI] = dataclasses.field(default=SourceGoogleAnalyticsDataAPIGoogleAnalyticsDataAPI.GOOGLE_ANALYTICS_DATA_API, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) window_in_days: Optional[int] = dataclasses.field(default=1, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('window_in_days'), 'exclude': lambda f: f is None }}) r"""The interval in days for each data request made to the Google Analytics API. A larger value speeds up data sync, but increases the chance of data sampling, which may result in inaccuracies. We recommend a value of 1 to minimize sampling, unless speed is an absolute priority over accuracy. Acceptable values range from 1 to 364. Does not apply to custom Cohort reports. More information is available in the documentation.""" diff --git a/src/airbyte/models/shared/source_google_directory.py b/src/airbyte/models/shared/source_google_directory.py index 356a37ff..1808de11 100644 --- a/src/airbyte/models/shared/source_google_directory.py +++ b/src/airbyte/models/shared/source_google_directory.py @@ -52,8 +52,8 @@ class GoogleDirectory(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceGoogleDirectory: - SOURCE_TYPE: Final[GoogleDirectory] = dataclasses.field(default=GoogleDirectory.GOOGLE_DIRECTORY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) credentials: Optional[Union[SignInViaGoogleOAuth, ServiceAccountKey]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) r"""Google APIs use the OAuth 2.0 protocol for authentication and authorization. The Source supports Web server application and Service accounts scenarios.""" + SOURCE_TYPE: Final[GoogleDirectory] = dataclasses.field(default=GoogleDirectory.GOOGLE_DIRECTORY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_google_pagespeed_insights.py b/src/airbyte/models/shared/source_google_pagespeed_insights.py index 941b0075..10f4989c 100644 --- a/src/airbyte/models/shared/source_google_pagespeed_insights.py +++ b/src/airbyte/models/shared/source_google_pagespeed_insights.py @@ -31,8 +31,8 @@ class SourceGooglePagespeedInsights: r"""The analyses strategy to use. Either \\"desktop\\" or \\"mobile\\".""" urls: List[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('urls') }}) r"""The URLs to retrieve pagespeed information from. The connector will attempt to sync PageSpeed reports for all the defined URLs. Format: https://(www.)url.domain""" - SOURCE_TYPE: Final[GooglePagespeedInsights] = dataclasses.field(default=GooglePagespeedInsights.GOOGLE_PAGESPEED_INSIGHTS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) api_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_key'), 'exclude': lambda f: f is None }}) r"""Google PageSpeed API Key. See here. The key is optional - however the API is heavily rate limited when using without API Key. Creating and using the API key therefore is recommended. The key is case sensitive.""" + SOURCE_TYPE: Final[GooglePagespeedInsights] = dataclasses.field(default=GooglePagespeedInsights.GOOGLE_PAGESPEED_INSIGHTS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_google_search_console.py b/src/airbyte/models/shared/source_google_search_console.py index 5f7abef8..d195921e 100644 --- a/src/airbyte/models/shared/source_google_search_console.py +++ b/src/airbyte/models/shared/source_google_search_console.py @@ -37,9 +37,9 @@ class SourceGoogleSearchConsoleOAuth: r"""The client secret of your Google Search Console developer application. Read more here.""" refresh_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('refresh_token') }}) r"""The token for obtaining a new access token. Read more here.""" - AUTH_TYPE: Final[SourceGoogleSearchConsoleAuthType] = dataclasses.field(default=SourceGoogleSearchConsoleAuthType.CLIENT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_type') }}) access_token: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('access_token'), 'exclude': lambda f: f is None }}) r"""Access token for making authenticated requests. Read more here.""" + AUTH_TYPE: Final[SourceGoogleSearchConsoleAuthType] = dataclasses.field(default=SourceGoogleSearchConsoleAuthType.CLIENT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_type') }}) @@ -77,7 +77,6 @@ class SourceGoogleSearchConsole: authorization: Union[SourceGoogleSearchConsoleOAuth, SourceGoogleSearchConsoleServiceAccountKeyAuthentication] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('authorization') }}) site_urls: List[str] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('site_urls') }}) r"""The URLs of the website property attached to your GSC account. Learn more about properties here.""" - SOURCE_TYPE: Final[SourceGoogleSearchConsoleGoogleSearchConsole] = dataclasses.field(default=SourceGoogleSearchConsoleGoogleSearchConsole.GOOGLE_SEARCH_CONSOLE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) custom_reports: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('custom_reports'), 'exclude': lambda f: f is None }}) r"""(DEPRCATED) A JSON array describing the custom reports you want to sync from Google Search Console. See our documentation for more information on formulating custom reports.""" custom_reports_array: Optional[List[SourceGoogleSearchConsoleCustomReportConfig]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('custom_reports_array'), 'exclude': lambda f: f is None }}) @@ -86,6 +85,7 @@ class SourceGoogleSearchConsole: r"""If set to 'final', the returned data will include only finalized, stable data. If set to 'all', fresh data will be included. When using Incremental sync mode, we do not recommend setting this parameter to 'all' as it may cause data loss. More information can be found in our full documentation.""" end_date: Optional[date] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('end_date'), 'encoder': utils.dateisoformat(True), 'decoder': utils.datefromisoformat, 'exclude': lambda f: f is None }}) r"""UTC date in the format YYYY-MM-DD. Any data created after this date will not be replicated. Must be greater or equal to the start date field. Leaving this field blank will replicate all data from the start date onward.""" + SOURCE_TYPE: Final[SourceGoogleSearchConsoleGoogleSearchConsole] = dataclasses.field(default=SourceGoogleSearchConsoleGoogleSearchConsole.GOOGLE_SEARCH_CONSOLE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[date] = dataclasses.field(default=dateutil.parser.parse('2021-01-01').date(), metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.dateisoformat(True), 'decoder': utils.datefromisoformat, 'exclude': lambda f: f is None }}) r"""UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated.""" diff --git a/src/airbyte/models/shared/source_google_sheets.py b/src/airbyte/models/shared/source_google_sheets.py index 5a7c2f14..df954c0b 100644 --- a/src/airbyte/models/shared/source_google_sheets.py +++ b/src/airbyte/models/shared/source_google_sheets.py @@ -48,8 +48,8 @@ class SourceGoogleSheets: r"""Credentials for connecting to the Google Sheets API""" spreadsheet_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('spreadsheet_id') }}) r"""Enter the link to the Google spreadsheet you want to sync. To copy the link, click the 'Share' button in the top-right corner of the spreadsheet, then click 'Copy link'.""" - SOURCE_TYPE: Final[SourceGoogleSheetsGoogleSheets] = dataclasses.field(default=SourceGoogleSheetsGoogleSheets.GOOGLE_SHEETS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) names_conversion: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('names_conversion'), 'exclude': lambda f: f is None }}) r"""Enables the conversion of column names to a standardized, SQL-compliant format. For example, 'My Name' -> 'my_name'. Enable this option if your destination is SQL-based.""" + SOURCE_TYPE: Final[SourceGoogleSheetsGoogleSheets] = dataclasses.field(default=SourceGoogleSheetsGoogleSheets.GOOGLE_SHEETS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_google_webfonts.py b/src/airbyte/models/shared/source_google_webfonts.py index d3f221ca..2feb1ff7 100644 --- a/src/airbyte/models/shared/source_google_webfonts.py +++ b/src/airbyte/models/shared/source_google_webfonts.py @@ -16,12 +16,12 @@ class GoogleWebfonts(str, Enum): class SourceGoogleWebfonts: api_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_key') }}) r"""API key is required to access google apis, For getting your's goto google console and generate api key for Webfonts""" - SOURCE_TYPE: Final[GoogleWebfonts] = dataclasses.field(default=GoogleWebfonts.GOOGLE_WEBFONTS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) alt: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('alt'), 'exclude': lambda f: f is None }}) r"""Optional, Available params- json, media, proto""" pretty_print: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('prettyPrint'), 'exclude': lambda f: f is None }}) r"""Optional, boolean type""" sort: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sort'), 'exclude': lambda f: f is None }}) r"""Optional, to find how to sort""" + SOURCE_TYPE: Final[GoogleWebfonts] = dataclasses.field(default=GoogleWebfonts.GOOGLE_WEBFONTS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_google_workspace_admin_reports.py b/src/airbyte/models/shared/source_google_workspace_admin_reports.py index d72f5446..63c4aac1 100644 --- a/src/airbyte/models/shared/source_google_workspace_admin_reports.py +++ b/src/airbyte/models/shared/source_google_workspace_admin_reports.py @@ -18,8 +18,8 @@ class SourceGoogleWorkspaceAdminReports: r"""The contents of the JSON service account key. See the docs for more information on how to generate this key.""" email: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('email') }}) r"""The email of the user, which has permissions to access the Google Workspace Admin APIs.""" - SOURCE_TYPE: Final[GoogleWorkspaceAdminReports] = dataclasses.field(default=GoogleWorkspaceAdminReports.GOOGLE_WORKSPACE_ADMIN_REPORTS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) lookback: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lookback'), 'exclude': lambda f: f is None }}) r"""Sets the range of time shown in the report. Reports API allows from up to 180 days ago.""" + SOURCE_TYPE: Final[GoogleWorkspaceAdminReports] = dataclasses.field(default=GoogleWorkspaceAdminReports.GOOGLE_WORKSPACE_ADMIN_REPORTS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_harvest.py b/src/airbyte/models/shared/source_harvest.py index 2d76245a..01e7fc06 100644 --- a/src/airbyte/models/shared/source_harvest.py +++ b/src/airbyte/models/shared/source_harvest.py @@ -52,10 +52,10 @@ class SourceHarvest: r"""Harvest account ID. Required for all Harvest requests in pair with Personal Access Token""" replication_start_date: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('replication_start_date'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) r"""UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.""" - SOURCE_TYPE: Final[SourceHarvestHarvest] = dataclasses.field(default=SourceHarvestHarvest.HARVEST, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) credentials: Optional[Union[AuthenticateViaHarvestOAuth, SourceHarvestAuthenticateWithPersonalAccessToken]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) r"""Choose how to authenticate to Harvest.""" replication_end_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('replication_end_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""UTC date and time in the format 2017-01-25T00:00:00Z. Any data after this date will not be replicated.""" + SOURCE_TYPE: Final[SourceHarvestHarvest] = dataclasses.field(default=SourceHarvestHarvest.HARVEST, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_hubspot.py b/src/airbyte/models/shared/source_hubspot.py index 731319d3..fd17d02b 100644 --- a/src/airbyte/models/shared/source_hubspot.py +++ b/src/airbyte/models/shared/source_hubspot.py @@ -54,8 +54,8 @@ class SourceHubspot: r"""Choose how to authenticate to HubSpot.""" start_date: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) r"""UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.""" - SOURCE_TYPE: Final[SourceHubspotHubspot] = dataclasses.field(default=SourceHubspotHubspot.HUBSPOT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) enable_experimental_streams: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_experimental_streams'), 'exclude': lambda f: f is None }}) r"""If enabled then experimental streams become available for sync.""" + SOURCE_TYPE: Final[SourceHubspotHubspot] = dataclasses.field(default=SourceHubspotHubspot.HUBSPOT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_instagram.py b/src/airbyte/models/shared/source_instagram.py index f3902803..e7db1b0c 100644 --- a/src/airbyte/models/shared/source_instagram.py +++ b/src/airbyte/models/shared/source_instagram.py @@ -18,11 +18,11 @@ class SourceInstagramInstagram(str, Enum): class SourceInstagram: access_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('access_token') }}) r"""The value of the access token generated with instagram_basic, instagram_manage_insights, pages_show_list, pages_read_engagement, Instagram Public Content Access permissions. See the docs for more information""" - SOURCE_TYPE: Final[SourceInstagramInstagram] = dataclasses.field(default=SourceInstagramInstagram.INSTAGRAM, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) client_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_id'), 'exclude': lambda f: f is None }}) r"""The Client ID for your Oauth application""" client_secret: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_secret'), 'exclude': lambda f: f is None }}) r"""The Client Secret for your Oauth application""" + SOURCE_TYPE: Final[SourceInstagramInstagram] = dataclasses.field(default=SourceInstagramInstagram.INSTAGRAM, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""The date from which you'd like to replicate data for User Insights, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated. If left blank, the start date will be set to 2 years before the present date.""" diff --git a/src/airbyte/models/shared/source_intercom.py b/src/airbyte/models/shared/source_intercom.py index 017b9e2c..286b4c1e 100644 --- a/src/airbyte/models/shared/source_intercom.py +++ b/src/airbyte/models/shared/source_intercom.py @@ -20,10 +20,10 @@ class SourceIntercom: r"""Access token for making authenticated requests. See the Intercom docs for more information.""" start_date: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) r"""UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.""" - SOURCE_TYPE: Final[SourceIntercomIntercom] = dataclasses.field(default=SourceIntercomIntercom.INTERCOM, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) client_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_id'), 'exclude': lambda f: f is None }}) r"""Client Id for your Intercom application.""" client_secret: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_secret'), 'exclude': lambda f: f is None }}) r"""Client Secret for your Intercom application.""" + SOURCE_TYPE: Final[SourceIntercomIntercom] = dataclasses.field(default=SourceIntercomIntercom.INTERCOM, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_jira.py b/src/airbyte/models/shared/source_jira.py index acb3dd3a..9fd3e552 100644 --- a/src/airbyte/models/shared/source_jira.py +++ b/src/airbyte/models/shared/source_jira.py @@ -27,7 +27,6 @@ class SourceJira: r"""The Domain for your Jira account, e.g. airbyteio.atlassian.net, airbyteio.jira.com, jira.your-domain.com""" email: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('email') }}) r"""The user email for your Jira account which you used to generate the API token. This field is used for Authorization to your account by BasicAuth.""" - SOURCE_TYPE: Final[Jira] = dataclasses.field(default=Jira.JIRA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) enable_experimental_streams: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('enable_experimental_streams'), 'exclude': lambda f: f is None }}) r"""Allow the use of experimental streams which rely on undocumented Jira API endpoints. See https://docs.airbyte.com/integrations/sources/jira#experimental-tables for more info.""" expand_issue_changelog: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('expand_issue_changelog'), 'exclude': lambda f: f is None }}) @@ -42,6 +41,7 @@ class SourceJira: r"""List of Jira project keys to replicate data for, or leave it empty if you want to replicate data for all projects.""" render_fields: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('render_fields'), 'exclude': lambda f: f is None }}) r"""(DEPRECATED) Render issue fields in HTML format in addition to Jira JSON-like format.""" + SOURCE_TYPE: Final[Jira] = dataclasses.field(default=Jira.JIRA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""The date from which you want to replicate data from Jira, use the format YYYY-MM-DDT00:00:00Z. Note that this field only applies to certain streams, and only data generated on or after the start date will be replicated. Or leave it empty if you want to replicate all data. For more information, refer to the documentation.""" diff --git a/src/airbyte/models/shared/source_klarna.py b/src/airbyte/models/shared/source_klarna.py index 53405623..72cfd356 100644 --- a/src/airbyte/models/shared/source_klarna.py +++ b/src/airbyte/models/shared/source_klarna.py @@ -26,8 +26,8 @@ class SourceKlarna: r"""Base url region (For playground eu https://docs.klarna.com/klarna-payments/api/payments-api/#tag/API-URLs). Supported 'eu', 'us', 'oc'""" username: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('username') }}) r"""Consists of your Merchant ID (eid) - a unique number that identifies your e-store, combined with a random string (https://developers.klarna.com/api/#authentication)""" - SOURCE_TYPE: Final[Klarna] = dataclasses.field(default=Klarna.KLARNA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) playground: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('playground'), 'exclude': lambda f: f is None }}) r"""Propertie defining if connector is used against playground or production environment""" + SOURCE_TYPE: Final[Klarna] = dataclasses.field(default=Klarna.KLARNA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_kyve.py b/src/airbyte/models/shared/source_kyve.py index b85587c5..63e43bbb 100644 --- a/src/airbyte/models/shared/source_kyve.py +++ b/src/airbyte/models/shared/source_kyve.py @@ -18,11 +18,11 @@ class SourceKyve: r"""The IDs of the KYVE storage pool you want to archive. (Comma separated)""" start_ids: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_ids') }}) r"""The start-id defines, from which bundle id the pipeline should start to extract the data. (Comma separated)""" - SOURCE_TYPE: Final[Kyve] = dataclasses.field(default=Kyve.KYVE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) max_pages: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('max_pages'), 'exclude': lambda f: f is None }}) r"""The maximum amount of pages to go trough. Set to 'null' for all pages.""" page_size: Optional[int] = dataclasses.field(default=100, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('page_size'), 'exclude': lambda f: f is None }}) r"""The pagesize for pagination, smaller numbers are used in integration tests.""" + SOURCE_TYPE: Final[Kyve] = dataclasses.field(default=Kyve.KYVE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) url_base: Optional[str] = dataclasses.field(default='https://api.kyve.network', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('url_base'), 'exclude': lambda f: f is None }}) r"""URL to the KYVE Chain API.""" diff --git a/src/airbyte/models/shared/source_lever_hiring.py b/src/airbyte/models/shared/source_lever_hiring.py index eff2c972..6193e793 100644 --- a/src/airbyte/models/shared/source_lever_hiring.py +++ b/src/airbyte/models/shared/source_lever_hiring.py @@ -51,10 +51,10 @@ class SourceLeverHiringLeverHiring(str, Enum): class SourceLeverHiring: start_date: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date') }}) r"""UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated. Note that it will be used only in the following incremental streams: comments, commits, and issues.""" - SOURCE_TYPE: Final[SourceLeverHiringLeverHiring] = dataclasses.field(default=SourceLeverHiringLeverHiring.LEVER_HIRING, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) credentials: Optional[Union[AuthenticateViaLeverOAuth, AuthenticateViaLeverAPIKey]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) r"""Choose how to authenticate to Lever Hiring.""" environment: Optional[SourceLeverHiringEnvironment] = dataclasses.field(default=SourceLeverHiringEnvironment.SANDBOX, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('environment'), 'exclude': lambda f: f is None }}) r"""The environment in which you'd like to replicate data for Lever. This is used to determine which Lever API endpoint to use.""" + SOURCE_TYPE: Final[SourceLeverHiringLeverHiring] = dataclasses.field(default=SourceLeverHiringLeverHiring.LEVER_HIRING, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_linkedin_ads.py b/src/airbyte/models/shared/source_linkedin_ads.py index 76fae38f..82903fbc 100644 --- a/src/airbyte/models/shared/source_linkedin_ads.py +++ b/src/airbyte/models/shared/source_linkedin_ads.py @@ -92,10 +92,10 @@ class SourceLinkedinAdsLinkedinAds(str, Enum): class SourceLinkedinAds: start_date: date = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.dateisoformat(False), 'decoder': utils.datefromisoformat }}) r"""UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated.""" - SOURCE_TYPE: Final[SourceLinkedinAdsLinkedinAds] = dataclasses.field(default=SourceLinkedinAdsLinkedinAds.LINKEDIN_ADS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) account_ids: Optional[List[int]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('account_ids'), 'exclude': lambda f: f is None }}) r"""Specify the account IDs to pull data from, separated by a space. Leave this field empty if you want to pull the data from all accounts accessible by the authenticated user. See the LinkedIn docs to locate these IDs.""" ad_analytics_reports: Optional[List[AdAnalyticsReportConfiguration]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ad_analytics_reports'), 'exclude': lambda f: f is None }}) credentials: Optional[Union[SourceLinkedinAdsOAuth20, AccessToken]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) + SOURCE_TYPE: Final[SourceLinkedinAdsLinkedinAds] = dataclasses.field(default=SourceLinkedinAdsLinkedinAds.LINKEDIN_ADS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_linkedin_pages.py b/src/airbyte/models/shared/source_linkedin_pages.py index 7218a622..f9640a4d 100644 --- a/src/airbyte/models/shared/source_linkedin_pages.py +++ b/src/airbyte/models/shared/source_linkedin_pages.py @@ -46,7 +46,7 @@ class LinkedinPages(str, Enum): class SourceLinkedinPages: org_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('org_id') }}) r"""Specify the Organization ID""" - SOURCE_TYPE: Final[LinkedinPages] = dataclasses.field(default=LinkedinPages.LINKEDIN_PAGES, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) credentials: Optional[Union[SourceLinkedinPagesOAuth20, SourceLinkedinPagesAccessToken]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) + SOURCE_TYPE: Final[LinkedinPages] = dataclasses.field(default=LinkedinPages.LINKEDIN_PAGES, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_mailchimp.py b/src/airbyte/models/shared/source_mailchimp.py index 98bf0016..86d13cb2 100644 --- a/src/airbyte/models/shared/source_mailchimp.py +++ b/src/airbyte/models/shared/source_mailchimp.py @@ -46,9 +46,9 @@ class SourceMailchimpMailchimp(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceMailchimp: - SOURCE_TYPE: Final[SourceMailchimpMailchimp] = dataclasses.field(default=SourceMailchimpMailchimp.MAILCHIMP, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) campaign_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('campaign_id'), 'exclude': lambda f: f is None }}) credentials: Optional[Union[SourceMailchimpOAuth20, APIKey]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) + SOURCE_TYPE: Final[SourceMailchimpMailchimp] = dataclasses.field(default=SourceMailchimpMailchimp.MAILCHIMP, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""The date from which you want to start syncing data for Incremental streams. Only records that have been created or modified since this date will be synced. If left blank, all data will by synced.""" diff --git a/src/airbyte/models/shared/source_mailgun.py b/src/airbyte/models/shared/source_mailgun.py index d1a0faaa..500e7382 100644 --- a/src/airbyte/models/shared/source_mailgun.py +++ b/src/airbyte/models/shared/source_mailgun.py @@ -18,9 +18,9 @@ class Mailgun(str, Enum): class SourceMailgun: private_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('private_key') }}) r"""Primary account API key to access your Mailgun data.""" - SOURCE_TYPE: Final[Mailgun] = dataclasses.field(default=Mailgun.MAILGUN, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) domain_region: Optional[str] = dataclasses.field(default='US', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('domain_region'), 'exclude': lambda f: f is None }}) r"""Domain region code. 'EU' or 'US' are possible values. The default is 'US'.""" + SOURCE_TYPE: Final[Mailgun] = dataclasses.field(default=Mailgun.MAILGUN, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""UTC date and time in the format 2020-10-01 00:00:00. Any data before this date will not be replicated. If omitted, defaults to 3 days ago.""" diff --git a/src/airbyte/models/shared/source_mailjet_sms.py b/src/airbyte/models/shared/source_mailjet_sms.py index 03068427..95efa0ac 100644 --- a/src/airbyte/models/shared/source_mailjet_sms.py +++ b/src/airbyte/models/shared/source_mailjet_sms.py @@ -16,9 +16,9 @@ class MailjetSms(str, Enum): class SourceMailjetSms: token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('token') }}) r"""Your access token. See here.""" - SOURCE_TYPE: Final[MailjetSms] = dataclasses.field(default=MailjetSms.MAILJET_SMS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) end_date: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('end_date'), 'exclude': lambda f: f is None }}) r"""Retrieve SMS messages created before the specified timestamp. Required format - Unix timestamp.""" + SOURCE_TYPE: Final[MailjetSms] = dataclasses.field(default=MailjetSms.MAILJET_SMS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'exclude': lambda f: f is None }}) r"""Retrieve SMS messages created after the specified timestamp. Required format - Unix timestamp.""" diff --git a/src/airbyte/models/shared/source_metabase.py b/src/airbyte/models/shared/source_metabase.py index 7f056d34..6cecc487 100644 --- a/src/airbyte/models/shared/source_metabase.py +++ b/src/airbyte/models/shared/source_metabase.py @@ -16,7 +16,6 @@ class Metabase(str, Enum): class SourceMetabase: instance_api_url: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('instance_api_url') }}) r"""URL to your metabase instance API""" - SOURCE_TYPE: Final[Metabase] = dataclasses.field(default=Metabase.METABASE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) password: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('password'), 'exclude': lambda f: f is None }}) session_token: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('session_token'), 'exclude': lambda f: f is None }}) r"""To generate your session token, you need to run the following command: ``` curl -X POST \ @@ -26,6 +25,7 @@ class SourceMetabase: ``` Then copy the value of the `id` field returned by a successful call to that API. Note that by default, sessions are good for 14 days and needs to be regenerated. """ + SOURCE_TYPE: Final[Metabase] = dataclasses.field(default=Metabase.METABASE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) username: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('username'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_microsoft_teams.py b/src/airbyte/models/shared/source_microsoft_teams.py index 8a9127e0..ddcfe8d8 100644 --- a/src/airbyte/models/shared/source_microsoft_teams.py +++ b/src/airbyte/models/shared/source_microsoft_teams.py @@ -52,8 +52,8 @@ class SourceMicrosoftTeamsMicrosoftTeams(str, Enum): class SourceMicrosoftTeams: period: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('period') }}) r"""Specifies the length of time over which the Team Device Report stream is aggregated. The supported values are: D7, D30, D90, and D180.""" - SOURCE_TYPE: Final[SourceMicrosoftTeamsMicrosoftTeams] = dataclasses.field(default=SourceMicrosoftTeamsMicrosoftTeams.MICROSOFT_TEAMS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) credentials: Optional[Union[AuthenticateViaMicrosoftOAuth20, AuthenticateViaMicrosoft]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) r"""Choose how to authenticate to Microsoft""" + SOURCE_TYPE: Final[SourceMicrosoftTeamsMicrosoftTeams] = dataclasses.field(default=SourceMicrosoftTeamsMicrosoftTeams.MICROSOFT_TEAMS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_mixpanel.py b/src/airbyte/models/shared/source_mixpanel.py index 74d28292..7bca42f4 100644 --- a/src/airbyte/models/shared/source_mixpanel.py +++ b/src/airbyte/models/shared/source_mixpanel.py @@ -52,7 +52,6 @@ class Mixpanel(str, Enum): class SourceMixpanel: credentials: Union[ServiceAccount, ProjectSecret] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials') }}) r"""Choose how to authenticate to Mixpanel""" - SOURCE_TYPE: Final[Mixpanel] = dataclasses.field(default=Mixpanel.MIXPANEL, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) attribution_window: Optional[int] = dataclasses.field(default=5, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('attribution_window'), 'exclude': lambda f: f is None }}) r"""A period of time for attributing results to ads and the lookback period after those actions occur during which ad results are counted. Default attribution window is 5 days. (This value should be non-negative integer)""" date_window_size: Optional[int] = dataclasses.field(default=30, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('date_window_size'), 'exclude': lambda f: f is None }}) @@ -65,6 +64,7 @@ class SourceMixpanel: r"""The region of mixpanel domain instance either US or EU.""" select_properties_by_default: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('select_properties_by_default'), 'exclude': lambda f: f is None }}) r"""Setting this config parameter to TRUE ensures that new properties on events and engage records are captured. Otherwise new properties will be ignored.""" + SOURCE_TYPE: Final[Mixpanel] = dataclasses.field(default=Mixpanel.MIXPANEL, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[date] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.dateisoformat(True), 'decoder': utils.datefromisoformat, 'exclude': lambda f: f is None }}) r"""The date in the format YYYY-MM-DD. Any data before this date will not be replicated. If this option is not set, the connector will replicate data from up to one year ago by default.""" diff --git a/src/airbyte/models/shared/source_monday.py b/src/airbyte/models/shared/source_monday.py index cb918276..0697048c 100644 --- a/src/airbyte/models/shared/source_monday.py +++ b/src/airbyte/models/shared/source_monday.py @@ -46,7 +46,7 @@ class SourceMondayMonday(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceMonday: - SOURCE_TYPE: Final[SourceMondayMonday] = dataclasses.field(default=SourceMondayMonday.MONDAY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) credentials: Optional[Union[SourceMondayOAuth20, APIToken]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) + SOURCE_TYPE: Final[SourceMondayMonday] = dataclasses.field(default=SourceMondayMonday.MONDAY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_mongodb_internal_poc.py b/src/airbyte/models/shared/source_mongodb_internal_poc.py index ca2eb609..85ad3676 100644 --- a/src/airbyte/models/shared/source_mongodb_internal_poc.py +++ b/src/airbyte/models/shared/source_mongodb_internal_poc.py @@ -14,7 +14,6 @@ class MongodbInternalPoc(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceMongodbInternalPoc: - SOURCE_TYPE: Final[MongodbInternalPoc] = dataclasses.field(default=MongodbInternalPoc.MONGODB_INTERNAL_POC, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) auth_source: Optional[str] = dataclasses.field(default='admin', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_source'), 'exclude': lambda f: f is None }}) r"""The authentication source where the user information is stored.""" connection_string: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('connection_string'), 'exclude': lambda f: f is None }}) @@ -23,6 +22,7 @@ class SourceMongodbInternalPoc: r"""The password associated with this username.""" replica_set: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('replica_set'), 'exclude': lambda f: f is None }}) r"""The name of the replica set to be replicated.""" + SOURCE_TYPE: Final[MongodbInternalPoc] = dataclasses.field(default=MongodbInternalPoc.MONGODB_INTERNAL_POC, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) user: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('user'), 'exclude': lambda f: f is None }}) r"""The username which is used to access the database.""" diff --git a/src/airbyte/models/shared/source_mongodb_v2.py b/src/airbyte/models/shared/source_mongodb_v2.py index 7d007cbe..50495bfd 100644 --- a/src/airbyte/models/shared/source_mongodb_v2.py +++ b/src/airbyte/models/shared/source_mongodb_v2.py @@ -19,10 +19,10 @@ class SelfManagedReplicaSet: r"""The connection string of the cluster that you want to replicate. https://www.mongodb.com/docs/manual/reference/connection-string/#find-your-self-hosted-deployment-s-connection-string for more information.""" database: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('database') }}) r"""The name of the MongoDB database that contains the collection(s) to replicate.""" - CLUSTER_TYPE: Final[SourceMongodbV2SchemasClusterType] = dataclasses.field(default=SourceMongodbV2SchemasClusterType.SELF_MANAGED_REPLICA_SET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('cluster_type') }}) additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) auth_source: Optional[str] = dataclasses.field(default='admin', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_source'), 'exclude': lambda f: f is None }}) r"""The authentication source where the user information is stored.""" + CLUSTER_TYPE: Final[SourceMongodbV2SchemasClusterType] = dataclasses.field(default=SourceMongodbV2SchemasClusterType.SELF_MANAGED_REPLICA_SET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('cluster_type') }}) password: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('password'), 'exclude': lambda f: f is None }}) r"""The password associated with this username.""" schema_enforced: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('schema_enforced'), 'exclude': lambda f: f is None }}) @@ -48,10 +48,10 @@ class MongoDBAtlasReplicaSet: r"""The password associated with this username.""" username: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('username') }}) r"""The username which is used to access the database.""" - CLUSTER_TYPE: Final[SourceMongodbV2ClusterType] = dataclasses.field(default=SourceMongodbV2ClusterType.ATLAS_REPLICA_SET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('cluster_type') }}) additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) auth_source: Optional[str] = dataclasses.field(default='admin', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_source'), 'exclude': lambda f: f is None }}) r"""The authentication source where the user information is stored. See https://www.mongodb.com/docs/manual/reference/connection-string/#mongodb-urioption-urioption.authSource for more details.""" + CLUSTER_TYPE: Final[SourceMongodbV2ClusterType] = dataclasses.field(default=SourceMongodbV2ClusterType.ATLAS_REPLICA_SET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('cluster_type') }}) schema_enforced: Optional[bool] = dataclasses.field(default=True, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('schema_enforced'), 'exclude': lambda f: f is None }}) r"""When enabled, syncs will validate and structure records against the stream's schema.""" @@ -66,12 +66,12 @@ class MongodbV2(str, Enum): class SourceMongodbV2: database_config: Union[MongoDBAtlasReplicaSet, SelfManagedReplicaSet] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('database_config') }}) r"""Configures the MongoDB cluster type.""" - SOURCE_TYPE: Final[MongodbV2] = dataclasses.field(default=MongodbV2.MONGODB_V2, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) discover_sample_size: Optional[int] = dataclasses.field(default=10000, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discover_sample_size'), 'exclude': lambda f: f is None }}) r"""The maximum number of documents to sample when attempting to discover the unique fields for a collection.""" initial_waiting_seconds: Optional[int] = dataclasses.field(default=300, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('initial_waiting_seconds'), 'exclude': lambda f: f is None }}) r"""The amount of time the connector will wait when it launches to determine if there is new data to sync or not. Defaults to 300 seconds. Valid range: 120 seconds to 1200 seconds.""" queue_size: Optional[int] = dataclasses.field(default=10000, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('queue_size'), 'exclude': lambda f: f is None }}) r"""The size of the internal queue. This may interfere with memory consumption and efficiency of the connector, please be careful.""" + SOURCE_TYPE: Final[MongodbV2] = dataclasses.field(default=MongodbV2.MONGODB_V2, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_mssql.py b/src/airbyte/models/shared/source_mssql.py index e47b7cda..7d98dc18 100644 --- a/src/airbyte/models/shared/source_mssql.py +++ b/src/airbyte/models/shared/source_mssql.py @@ -27,9 +27,9 @@ class SourceMssqlMethod(str, Enum): @dataclasses.dataclass class ReadChangesUsingChangeDataCaptureCDC: r"""Recommended - Incrementally reads new inserts, updates, and deletes using the SQL Server's change data capture feature. This must be enabled on your database.""" - METHOD: Final[SourceMssqlMethod] = dataclasses.field(default=SourceMssqlMethod.CDC, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('method') }}) initial_waiting_seconds: Optional[int] = dataclasses.field(default=300, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('initial_waiting_seconds'), 'exclude': lambda f: f is None }}) r"""The amount of time the connector will wait when it launches to determine if there is new data to sync or not. Defaults to 300 seconds. Valid range: 120 seconds to 1200 seconds. Read about initial waiting time.""" + METHOD: Final[SourceMssqlMethod] = dataclasses.field(default=SourceMssqlMethod.CDC, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('method') }}) @@ -44,11 +44,11 @@ class SourceMssqlSchemasSSLMethodSSLMethodSSLMethod(str, Enum): @dataclasses.dataclass class SourceMssqlEncryptedVerifyCertificate: r"""Verify and use the certificate provided by the server.""" - SSL_METHOD: Final[SourceMssqlSchemasSSLMethodSSLMethodSSLMethod] = dataclasses.field(default=SourceMssqlSchemasSSLMethodSSLMethodSSLMethod.ENCRYPTED_VERIFY_CERTIFICATE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ssl_method') }}) certificate: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('certificate'), 'exclude': lambda f: f is None }}) r"""certificate of the server, or of the CA that signed the server certificate""" host_name_in_certificate: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hostNameInCertificate'), 'exclude': lambda f: f is None }}) r"""Specifies the host name of the server. The value of this property must match the subject property of the certificate.""" + SSL_METHOD: Final[SourceMssqlSchemasSSLMethodSSLMethodSSLMethod] = dataclasses.field(default=SourceMssqlSchemasSSLMethodSSLMethodSSLMethod.ENCRYPTED_VERIFY_CERTIFICATE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ssl_method') }}) @@ -145,13 +145,13 @@ class SourceMssql: r"""The port of the database.""" username: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('username') }}) r"""The username which is used to access the database.""" - SOURCE_TYPE: Final[SourceMssqlMssql] = dataclasses.field(default=SourceMssqlMssql.MSSQL, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) jdbc_url_params: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('jdbc_url_params'), 'exclude': lambda f: f is None }}) r"""Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).""" replication_method: Optional[Union[ReadChangesUsingChangeDataCaptureCDC, ScanChangesWithUserDefinedCursor]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('replication_method'), 'exclude': lambda f: f is None }}) r"""Configures how data is extracted from the database.""" schemas: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('schemas'), 'exclude': lambda f: f is None }}) r"""The list of schemas to sync from. Defaults to user. Case sensitive.""" + SOURCE_TYPE: Final[SourceMssqlMssql] = dataclasses.field(default=SourceMssqlMssql.MSSQL, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) ssl_method: Optional[Union[Unencrypted, SourceMssqlEncryptedTrustServerCertificate, SourceMssqlEncryptedVerifyCertificate]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ssl_method'), 'exclude': lambda f: f is None }}) r"""The encryption method which is used when communicating with the database.""" tunnel_method: Optional[Union[SourceMssqlNoTunnel, SourceMssqlSSHKeyAuthentication, SourceMssqlPasswordAuthentication]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tunnel_method'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_my_hours.py b/src/airbyte/models/shared/source_my_hours.py index fd22157a..49080c98 100644 --- a/src/airbyte/models/shared/source_my_hours.py +++ b/src/airbyte/models/shared/source_my_hours.py @@ -20,8 +20,8 @@ class SourceMyHours: r"""The password associated to the username""" start_date: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date') }}) r"""Start date for collecting time logs""" - SOURCE_TYPE: Final[MyHours] = dataclasses.field(default=MyHours.MY_HOURS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) logs_batch_size: Optional[int] = dataclasses.field(default=30, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('logs_batch_size'), 'exclude': lambda f: f is None }}) r"""Pagination size used for retrieving logs in days""" + SOURCE_TYPE: Final[MyHours] = dataclasses.field(default=MyHours.MY_HOURS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_mysql.py b/src/airbyte/models/shared/source_mysql.py index 87ed9307..53de87e9 100644 --- a/src/airbyte/models/shared/source_mysql.py +++ b/src/airbyte/models/shared/source_mysql.py @@ -27,9 +27,9 @@ class SourceMysqlMethod(str, Enum): @dataclasses.dataclass class ReadChangesUsingBinaryLogCDC: r"""Recommended - Incrementally reads new inserts, updates, and deletes using the MySQL binary log. This must be enabled on your database.""" - METHOD: Final[SourceMysqlMethod] = dataclasses.field(default=SourceMysqlMethod.CDC, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('method') }}) initial_waiting_seconds: Optional[int] = dataclasses.field(default=300, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('initial_waiting_seconds'), 'exclude': lambda f: f is None }}) r"""The amount of time the connector will wait when it launches to determine if there is new data to sync or not. Defaults to 300 seconds. Valid range: 120 seconds to 1200 seconds. Read about initial waiting time.""" + METHOD: Final[SourceMysqlMethod] = dataclasses.field(default=SourceMysqlMethod.CDC, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('method') }}) server_time_zone: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('server_time_zone'), 'exclude': lambda f: f is None }}) r"""Enter the configured MySQL server timezone. This should only be done if the configured timezone in your MySQL instance does not conform to IANNA standard.""" @@ -48,13 +48,13 @@ class VerifyIdentity: r"""Always connect with SSL. Verify both CA and Hostname.""" ca_certificate: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ca_certificate') }}) r"""CA certificate""" - MODE: Final[SourceMysqlSchemasSSLModeSSLModesMode] = dataclasses.field(default=SourceMysqlSchemasSSLModeSSLModesMode.VERIFY_IDENTITY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) client_certificate: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_certificate'), 'exclude': lambda f: f is None }}) r"""Client certificate (this is not a required field, but if you want to use it, you will need to add the Client key as well)""" client_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_key'), 'exclude': lambda f: f is None }}) r"""Client key (this is not a required field, but if you want to use it, you will need to add the Client certificate as well)""" client_key_password: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_key_password'), 'exclude': lambda f: f is None }}) r"""Password for keystorage. This field is optional. If you do not add it - the password will be generated automatically.""" + MODE: Final[SourceMysqlSchemasSSLModeSSLModesMode] = dataclasses.field(default=SourceMysqlSchemasSSLModeSSLModesMode.VERIFY_IDENTITY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -68,13 +68,13 @@ class SourceMysqlVerifyCA: r"""Always connect with SSL. Verifies CA, but allows connection even if Hostname does not match.""" ca_certificate: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ca_certificate') }}) r"""CA certificate""" - MODE: Final[SourceMysqlSchemasSslModeMode] = dataclasses.field(default=SourceMysqlSchemasSslModeMode.VERIFY_CA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) client_certificate: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_certificate'), 'exclude': lambda f: f is None }}) r"""Client certificate (this is not a required field, but if you want to use it, you will need to add the Client key as well)""" client_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_key'), 'exclude': lambda f: f is None }}) r"""Client key (this is not a required field, but if you want to use it, you will need to add the Client certificate as well)""" client_key_password: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_key_password'), 'exclude': lambda f: f is None }}) r"""Password for keystorage. This field is optional. If you do not add it - the password will be generated automatically.""" + MODE: Final[SourceMysqlSchemasSslModeMode] = dataclasses.field(default=SourceMysqlSchemasSslModeMode.VERIFY_CA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -169,13 +169,13 @@ class SourceMysql: r"""Configures how data is extracted from the database.""" username: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('username') }}) r"""The username which is used to access the database.""" - SOURCE_TYPE: Final[SourceMysqlMysql] = dataclasses.field(default=SourceMysqlMysql.MYSQL, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) jdbc_url_params: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('jdbc_url_params'), 'exclude': lambda f: f is None }}) r"""Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3). For more information read about JDBC URL parameters.""" password: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('password'), 'exclude': lambda f: f is None }}) r"""The password associated with the username.""" port: Optional[int] = dataclasses.field(default=3306, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('port'), 'exclude': lambda f: f is None }}) r"""The port to connect to.""" + SOURCE_TYPE: Final[SourceMysqlMysql] = dataclasses.field(default=SourceMysqlMysql.MYSQL, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) ssl_mode: Optional[Union[Preferred, Required, SourceMysqlVerifyCA, VerifyIdentity]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ssl_mode'), 'exclude': lambda f: f is None }}) r"""SSL connection modes. Read more in the docs.""" tunnel_method: Optional[Union[SourceMysqlNoTunnel, SourceMysqlSSHKeyAuthentication, SourceMysqlPasswordAuthentication]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tunnel_method'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_netsuite.py b/src/airbyte/models/shared/source_netsuite.py index 86879909..cf5d494e 100644 --- a/src/airbyte/models/shared/source_netsuite.py +++ b/src/airbyte/models/shared/source_netsuite.py @@ -26,9 +26,9 @@ class SourceNetsuite: r"""Access token key""" token_secret: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('token_secret') }}) r"""Access token secret""" - SOURCE_TYPE: Final[Netsuite] = dataclasses.field(default=Netsuite.NETSUITE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) object_types: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('object_types'), 'exclude': lambda f: f is None }}) r"""The API names of the Netsuite objects you want to sync. Setting this speeds up the connection setup process by limiting the number of schemas that need to be retrieved from Netsuite.""" + SOURCE_TYPE: Final[Netsuite] = dataclasses.field(default=Netsuite.NETSUITE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) window_in_days: Optional[int] = dataclasses.field(default=30, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('window_in_days'), 'exclude': lambda f: f is None }}) r"""The amount of days used to query the data with date chunks. Set smaller value, if you have lots of data.""" diff --git a/src/airbyte/models/shared/source_nytimes.py b/src/airbyte/models/shared/source_nytimes.py index 65a2aed8..e9c1e2af 100644 --- a/src/airbyte/models/shared/source_nytimes.py +++ b/src/airbyte/models/shared/source_nytimes.py @@ -31,10 +31,10 @@ class SourceNytimes: r"""Period of time (in days)""" start_date: date = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.dateisoformat(False), 'decoder': utils.datefromisoformat }}) r"""Start date to begin the article retrieval (format YYYY-MM)""" - SOURCE_TYPE: Final[Nytimes] = dataclasses.field(default=Nytimes.NYTIMES, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) end_date: Optional[date] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('end_date'), 'encoder': utils.dateisoformat(True), 'decoder': utils.datefromisoformat, 'exclude': lambda f: f is None }}) r"""End date to stop the article retrieval (format YYYY-MM)""" share_type: Optional[ShareTypeUsedForMostPopularSharedStream] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('share_type'), 'exclude': lambda f: f is None }}) r"""Share Type""" + SOURCE_TYPE: Final[Nytimes] = dataclasses.field(default=Nytimes.NYTIMES, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_okta.py b/src/airbyte/models/shared/source_okta.py index 944b2853..f14153cc 100644 --- a/src/airbyte/models/shared/source_okta.py +++ b/src/airbyte/models/shared/source_okta.py @@ -44,10 +44,10 @@ class Okta(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceOkta: - SOURCE_TYPE: Final[Okta] = dataclasses.field(default=Okta.OKTA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) credentials: Optional[Union[SourceOktaOAuth20, SourceOktaAPIToken]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) domain: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('domain'), 'exclude': lambda f: f is None }}) r"""The Okta domain. See the docs for instructions on how to find it.""" + SOURCE_TYPE: Final[Okta] = dataclasses.field(default=Okta.OKTA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'exclude': lambda f: f is None }}) r"""UTC date and time in the format YYYY-MM-DDTHH:MM:SSZ. Any data before this date will not be replicated.""" diff --git a/src/airbyte/models/shared/source_oracle.py b/src/airbyte/models/shared/source_oracle.py index 9e9c7da0..d211d198 100644 --- a/src/airbyte/models/shared/source_oracle.py +++ b/src/airbyte/models/shared/source_oracle.py @@ -61,9 +61,9 @@ class EncryptionMethod(str, Enum): @dataclasses.dataclass class NativeNetworkEncryptionNNE: r"""The native network encryption gives you the ability to encrypt database connections, without the configuration overhead of TCP/IP and SSL/TLS and without the need to open and listen on different ports.""" - ENCRYPTION_METHOD: Final[EncryptionMethod] = dataclasses.field(default=EncryptionMethod.CLIENT_NNE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('encryption_method') }}) encryption_algorithm: Optional[EncryptionAlgorithm] = dataclasses.field(default=EncryptionAlgorithm.AES256, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('encryption_algorithm'), 'exclude': lambda f: f is None }}) r"""This parameter defines what encryption algorithm is used.""" + ENCRYPTION_METHOD: Final[EncryptionMethod] = dataclasses.field(default=EncryptionMethod.CLIENT_NNE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('encryption_method') }}) @@ -135,7 +135,6 @@ class SourceOracle: r"""Hostname of the database.""" username: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('username') }}) r"""The username which is used to access the database.""" - SOURCE_TYPE: Final[SourceOracleOracle] = dataclasses.field(default=SourceOracleOracle.ORACLE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) connection_data: Optional[Union[ServiceName, SystemIDSID]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('connection_data'), 'exclude': lambda f: f is None }}) r"""Connect data that will be used for DB connection""" jdbc_url_params: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('jdbc_url_params'), 'exclude': lambda f: f is None }}) @@ -150,6 +149,7 @@ class SourceOracle: """ schemas: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('schemas'), 'exclude': lambda f: f is None }}) r"""The list of schemas to sync from. Defaults to user. Case sensitive.""" + SOURCE_TYPE: Final[SourceOracleOracle] = dataclasses.field(default=SourceOracleOracle.ORACLE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) tunnel_method: Optional[Union[SourceOracleNoTunnel, SourceOracleSSHKeyAuthentication, SourceOraclePasswordAuthentication]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tunnel_method'), 'exclude': lambda f: f is None }}) r"""Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.""" diff --git a/src/airbyte/models/shared/source_orb.py b/src/airbyte/models/shared/source_orb.py index 1ed2b08f..7c6a9bfd 100644 --- a/src/airbyte/models/shared/source_orb.py +++ b/src/airbyte/models/shared/source_orb.py @@ -18,13 +18,13 @@ class SourceOrb: r"""Orb API Key, issued from the Orb admin console.""" start_date: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date') }}) r"""UTC date and time in the format 2022-03-01T00:00:00Z. Any data with created_at before this data will not be synced. For Subscription Usage, this becomes the `timeframe_start` API parameter.""" - SOURCE_TYPE: Final[Orb] = dataclasses.field(default=Orb.ORB, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) lookback_window_days: Optional[int] = dataclasses.field(default=0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lookback_window_days'), 'exclude': lambda f: f is None }}) r"""When set to N, the connector will always refresh resources created within the past N days. By default, updated objects that are not newly created are not incrementally synced.""" numeric_event_properties_keys: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('numeric_event_properties_keys'), 'exclude': lambda f: f is None }}) r"""Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction.""" plan_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('plan_id'), 'exclude': lambda f: f is None }}) r"""Orb Plan ID to filter subscriptions that should have usage fetched.""" + SOURCE_TYPE: Final[Orb] = dataclasses.field(default=Orb.ORB, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) string_event_properties_keys: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('string_event_properties_keys'), 'exclude': lambda f: f is None }}) r"""Property key names to extract from all events, in order to enrich ledger entries corresponding to an event deduction.""" subscription_usage_grouping_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subscription_usage_grouping_key'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_outbrain_amplify.py b/src/airbyte/models/shared/source_outbrain_amplify.py index d6bab7f4..3e973a49 100644 --- a/src/airbyte/models/shared/source_outbrain_amplify.py +++ b/src/airbyte/models/shared/source_outbrain_amplify.py @@ -58,12 +58,12 @@ class SourceOutbrainAmplify: r"""Credentials for making authenticated requests requires either username/password or access_token.""" start_date: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date') }}) r"""Date in the format YYYY-MM-DD eg. 2017-01-25. Any data before this date will not be replicated.""" - SOURCE_TYPE: Final[OutbrainAmplify] = dataclasses.field(default=OutbrainAmplify.OUTBRAIN_AMPLIFY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) end_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('end_date'), 'exclude': lambda f: f is None }}) r"""Date in the format YYYY-MM-DD.""" geo_location_breakdown: Optional[GranularityForGeoLocationRegion] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('geo_location_breakdown'), 'exclude': lambda f: f is None }}) r"""The granularity used for geo location data in reports.""" report_granularity: Optional[GranularityForPeriodicReports] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('report_granularity'), 'exclude': lambda f: f is None }}) r"""The granularity used for periodic data in reports. See the docs.""" + SOURCE_TYPE: Final[OutbrainAmplify] = dataclasses.field(default=OutbrainAmplify.OUTBRAIN_AMPLIFY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_paypal_transaction.py b/src/airbyte/models/shared/source_paypal_transaction.py index 81092db7..630fda79 100644 --- a/src/airbyte/models/shared/source_paypal_transaction.py +++ b/src/airbyte/models/shared/source_paypal_transaction.py @@ -22,11 +22,11 @@ class SourcePaypalTransaction: r"""The Client Secret of your Paypal developer application.""" start_date: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) r"""Start Date for data extraction in ISO format. Date must be in range from 3 years till 12 hrs before present time.""" - SOURCE_TYPE: Final[PaypalTransaction] = dataclasses.field(default=PaypalTransaction.PAYPAL_TRANSACTION, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) is_sandbox: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('is_sandbox'), 'exclude': lambda f: f is None }}) r"""Determines whether to use the sandbox or production environment.""" refresh_token: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('refresh_token'), 'exclude': lambda f: f is None }}) r"""The key to refresh the expired access token.""" + SOURCE_TYPE: Final[PaypalTransaction] = dataclasses.field(default=PaypalTransaction.PAYPAL_TRANSACTION, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) time_window: Optional[int] = dataclasses.field(default=7, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('time_window'), 'exclude': lambda f: f is None }}) r"""The number of days per request. Must be a number between 1 and 31.""" diff --git a/src/airbyte/models/shared/source_paystack.py b/src/airbyte/models/shared/source_paystack.py index b80800d5..13dab288 100644 --- a/src/airbyte/models/shared/source_paystack.py +++ b/src/airbyte/models/shared/source_paystack.py @@ -20,8 +20,8 @@ class SourcePaystack: r"""The Paystack API key (usually starts with 'sk_live_'; find yours here).""" start_date: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) r"""UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.""" - SOURCE_TYPE: Final[Paystack] = dataclasses.field(default=Paystack.PAYSTACK, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) lookback_window_days: Optional[int] = dataclasses.field(default=0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lookback_window_days'), 'exclude': lambda f: f is None }}) r"""When set, the connector will always reload data from the past N days, where N is the value set here. This is useful if your data is updated after creation.""" + SOURCE_TYPE: Final[Paystack] = dataclasses.field(default=Paystack.PAYSTACK, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_pexels_api.py b/src/airbyte/models/shared/source_pexels_api.py index 9d11ef5b..9a1a9438 100644 --- a/src/airbyte/models/shared/source_pexels_api.py +++ b/src/airbyte/models/shared/source_pexels_api.py @@ -18,7 +18,6 @@ class SourcePexelsAPI: r"""API key is required to access pexels api, For getting your's goto https://www.pexels.com/api/documentation and create account for free.""" query: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('query') }}) r"""Optional, the search query, Example Ocean, Tigers, Pears, etc.""" - SOURCE_TYPE: Final[PexelsAPI] = dataclasses.field(default=PexelsAPI.PEXELS_API, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) color: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('color'), 'exclude': lambda f: f is None }}) r"""Optional, Desired photo color. Supported colors red, orange, yellow, green, turquoise, blue, violet, pink, brown, black, gray, white or any hexidecimal color code.""" locale: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('locale'), 'exclude': lambda f: f is None }}) @@ -27,5 +26,6 @@ class SourcePexelsAPI: r"""Optional, Desired photo orientation. The current supported orientations are landscape, portrait or square""" size: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('size'), 'exclude': lambda f: f is None }}) r"""Optional, Minimum photo size. The current supported sizes are large(24MP), medium(12MP) or small(4MP).""" + SOURCE_TYPE: Final[PexelsAPI] = dataclasses.field(default=PexelsAPI.PEXELS_API, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_pocket.py b/src/airbyte/models/shared/source_pocket.py index 1e1b1a4c..df678049 100644 --- a/src/airbyte/models/shared/source_pocket.py +++ b/src/airbyte/models/shared/source_pocket.py @@ -42,7 +42,6 @@ class SourcePocket: r"""The user's Pocket access token.""" consumer_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('consumer_key') }}) r"""Your application's Consumer Key.""" - SOURCE_TYPE: Final[Pocket] = dataclasses.field(default=Pocket.POCKET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) content_type: Optional[ContentType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('content_type'), 'exclude': lambda f: f is None }}) r"""Select the content type of the items to retrieve.""" detail_type: Optional[DetailType] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('detail_type'), 'exclude': lambda f: f is None }}) @@ -57,6 +56,7 @@ class SourcePocket: r"""Only return items modified since the given timestamp.""" sort: Optional[SourcePocketSortBy] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sort'), 'exclude': lambda f: f is None }}) r"""Sort retrieved items by the given criteria.""" + SOURCE_TYPE: Final[Pocket] = dataclasses.field(default=Pocket.POCKET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) state: Optional[State] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('state'), 'exclude': lambda f: f is None }}) r"""Select the state of the items to retrieve.""" tag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tag'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_polygon_stock_api.py b/src/airbyte/models/shared/source_polygon_stock_api.py index 075aa7ae..e4069169 100644 --- a/src/airbyte/models/shared/source_polygon_stock_api.py +++ b/src/airbyte/models/shared/source_polygon_stock_api.py @@ -27,12 +27,12 @@ class SourcePolygonStockAPI: r"""The exchange symbol that this item is traded under.""" timespan: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('timespan') }}) r"""The size of the time window.""" - SOURCE_TYPE: Final[PolygonStockAPI] = dataclasses.field(default=PolygonStockAPI.POLYGON_STOCK_API, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) adjusted: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('adjusted'), 'exclude': lambda f: f is None }}) r"""Determines whether or not the results are adjusted for splits. By default, results are adjusted and set to true. Set this to false to get results that are NOT adjusted for splits.""" limit: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('limit'), 'exclude': lambda f: f is None }}) r"""The target date for the aggregate window.""" sort: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sort'), 'exclude': lambda f: f is None }}) r"""Sort the results by timestamp. asc will return results in ascending order (oldest at the top), desc will return results in descending order (newest at the top).""" + SOURCE_TYPE: Final[PolygonStockAPI] = dataclasses.field(default=PolygonStockAPI.POLYGON_STOCK_API, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_postgres.py b/src/airbyte/models/shared/source_postgres.py index 8663a0e7..118da3cc 100644 --- a/src/airbyte/models/shared/source_postgres.py +++ b/src/airbyte/models/shared/source_postgres.py @@ -52,12 +52,12 @@ class ReadChangesUsingWriteAheadLogCDC: r"""A Postgres publication used for consuming changes. Read about publications and replication identities.""" replication_slot: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('replication_slot') }}) r"""A plugin logical replication slot. Read about replication slots.""" - METHOD: Final[SourcePostgresMethod] = dataclasses.field(default=SourcePostgresMethod.CDC, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('method') }}) additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) initial_waiting_seconds: Optional[int] = dataclasses.field(default=1200, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('initial_waiting_seconds'), 'exclude': lambda f: f is None }}) r"""The amount of time the connector will wait when it launches to determine if there is new data to sync or not. Defaults to 1200 seconds. Valid range: 120 seconds to 2400 seconds. Read about initial waiting time.""" lsn_commit_behaviour: Optional[SourcePostgresLSNCommitBehaviour] = dataclasses.field(default=SourcePostgresLSNCommitBehaviour.AFTER_LOADING_DATA_IN_THE_DESTINATION, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lsn_commit_behaviour'), 'exclude': lambda f: f is None }}) r"""Determines when Airbyte should flush the LSN of processed WAL logs in the source database. `After loading Data in the destination` is default. If `While reading Data` is selected, in case of a downstream failure (while loading data into the destination), next sync would result in a full sync.""" + METHOD: Final[SourcePostgresMethod] = dataclasses.field(default=SourcePostgresMethod.CDC, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('method') }}) plugin: Optional[SourcePostgresPlugin] = dataclasses.field(default=SourcePostgresPlugin.PGOUTPUT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('plugin'), 'exclude': lambda f: f is None }}) r"""A logical decoding plugin installed on the PostgreSQL server.""" queue_size: Optional[int] = dataclasses.field(default=10000, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('queue_size'), 'exclude': lambda f: f is None }}) @@ -78,7 +78,6 @@ class SourcePostgresVerifyFull: r"""This is the most secure mode. Always require encryption and verifies the identity of the source database server.""" ca_certificate: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ca_certificate') }}) r"""CA certificate""" - MODE: Final[SourcePostgresSchemasSSLModeSSLModes6Mode] = dataclasses.field(default=SourcePostgresSchemasSSLModeSSLModes6Mode.VERIFY_FULL, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) client_certificate: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_certificate'), 'exclude': lambda f: f is None }}) r"""Client certificate""" @@ -86,6 +85,7 @@ class SourcePostgresVerifyFull: r"""Client key""" client_key_password: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_key_password'), 'exclude': lambda f: f is None }}) r"""Password for keystorage. If you do not add it - the password will be generated automatically.""" + MODE: Final[SourcePostgresSchemasSSLModeSSLModes6Mode] = dataclasses.field(default=SourcePostgresSchemasSSLModeSSLModes6Mode.VERIFY_FULL, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -99,7 +99,6 @@ class SourcePostgresVerifyCa: r"""Always require encryption and verifies that the source database server has a valid SSL certificate.""" ca_certificate: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ca_certificate') }}) r"""CA certificate""" - MODE: Final[SourcePostgresSchemasSSLModeSSLModes5Mode] = dataclasses.field(default=SourcePostgresSchemasSSLModeSSLModes5Mode.VERIFY_CA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) client_certificate: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_certificate'), 'exclude': lambda f: f is None }}) r"""Client certificate""" @@ -107,6 +106,7 @@ class SourcePostgresVerifyCa: r"""Client key""" client_key_password: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_key_password'), 'exclude': lambda f: f is None }}) r"""Password for keystorage. If you do not add it - the password will be generated automatically.""" + MODE: Final[SourcePostgresSchemasSSLModeSSLModes5Mode] = dataclasses.field(default=SourcePostgresSchemasSSLModeSSLModes5Mode.VERIFY_CA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -118,8 +118,8 @@ class SourcePostgresSchemasSSLModeSSLModesMode(str, Enum): @dataclasses.dataclass class SourcePostgresRequire: r"""Always require encryption. If the source database server does not support encryption, connection will fail.""" - MODE: Final[SourcePostgresSchemasSSLModeSSLModesMode] = dataclasses.field(default=SourcePostgresSchemasSSLModeSSLModesMode.REQUIRE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + MODE: Final[SourcePostgresSchemasSSLModeSSLModesMode] = dataclasses.field(default=SourcePostgresSchemasSSLModeSSLModesMode.REQUIRE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -131,8 +131,8 @@ class SourcePostgresSchemasSslModeMode(str, Enum): @dataclasses.dataclass class SourcePostgresPrefer: r"""Allows unencrypted connection only if the source database does not support encryption.""" - MODE: Final[SourcePostgresSchemasSslModeMode] = dataclasses.field(default=SourcePostgresSchemasSslModeMode.PREFER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + MODE: Final[SourcePostgresSchemasSslModeMode] = dataclasses.field(default=SourcePostgresSchemasSslModeMode.PREFER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -144,8 +144,8 @@ class SourcePostgresSchemasMode(str, Enum): @dataclasses.dataclass class SourcePostgresAllow: r"""Enables encryption only when required by the source database.""" - MODE: Final[SourcePostgresSchemasMode] = dataclasses.field(default=SourcePostgresSchemasMode.ALLOW, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + MODE: Final[SourcePostgresSchemasMode] = dataclasses.field(default=SourcePostgresSchemasMode.ALLOW, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -157,8 +157,8 @@ class SourcePostgresMode(str, Enum): @dataclasses.dataclass class SourcePostgresDisable: r"""Disables encryption of communication between Airbyte and source database.""" - MODE: Final[SourcePostgresMode] = dataclasses.field(default=SourcePostgresMode.DISABLE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) + MODE: Final[SourcePostgresMode] = dataclasses.field(default=SourcePostgresMode.DISABLE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -227,7 +227,6 @@ class SourcePostgres: r"""Hostname of the database.""" username: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('username') }}) r"""Username to access the database.""" - SOURCE_TYPE: Final[SourcePostgresPostgres] = dataclasses.field(default=SourcePostgresPostgres.POSTGRES, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) jdbc_url_params: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('jdbc_url_params'), 'exclude': lambda f: f is None }}) r"""Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (Eg. key1=value1&key2=value2&key3=value3). For more information read about JDBC URL parameters.""" password: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('password'), 'exclude': lambda f: f is None }}) @@ -238,6 +237,7 @@ class SourcePostgres: r"""Configures how data is extracted from the database.""" schemas: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('schemas'), 'exclude': lambda f: f is None }}) r"""The list of schemas (case sensitive) to sync from. Defaults to public.""" + SOURCE_TYPE: Final[SourcePostgresPostgres] = dataclasses.field(default=SourcePostgresPostgres.POSTGRES, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) ssl_mode: Optional[Union[SourcePostgresDisable, SourcePostgresAllow, SourcePostgresPrefer, SourcePostgresRequire, SourcePostgresVerifyCa, SourcePostgresVerifyFull]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ssl_mode'), 'exclude': lambda f: f is None }}) r"""SSL connection modes. Read more in the docs. diff --git a/src/airbyte/models/shared/source_posthog.py b/src/airbyte/models/shared/source_posthog.py index aefd6c13..daf6a2f6 100644 --- a/src/airbyte/models/shared/source_posthog.py +++ b/src/airbyte/models/shared/source_posthog.py @@ -20,10 +20,10 @@ class SourcePosthog: r"""API Key. See the docs for information on how to generate this key.""" start_date: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) r"""The date from which you'd like to replicate the data. Any data before this date will not be replicated.""" - SOURCE_TYPE: Final[Posthog] = dataclasses.field(default=Posthog.POSTHOG, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) base_url: Optional[str] = dataclasses.field(default='https://app.posthog.com', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('base_url'), 'exclude': lambda f: f is None }}) r"""Base PostHog url. Defaults to PostHog Cloud (https://app.posthog.com).""" events_time_step: Optional[int] = dataclasses.field(default=30, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('events_time_step'), 'exclude': lambda f: f is None }}) r"""Set lower value in case of failing long running sync of events stream.""" + SOURCE_TYPE: Final[Posthog] = dataclasses.field(default=Posthog.POSTHOG, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_punk_api.py b/src/airbyte/models/shared/source_punk_api.py index 0078c2c7..3a2f594c 100644 --- a/src/airbyte/models/shared/source_punk_api.py +++ b/src/airbyte/models/shared/source_punk_api.py @@ -18,8 +18,8 @@ class SourcePunkAPI: r"""To extract specific data with Unique ID""" brewed_before: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('brewed_before') }}) r"""To extract specific data with Unique ID""" - SOURCE_TYPE: Final[PunkAPI] = dataclasses.field(default=PunkAPI.PUNK_API, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) r"""To extract specific data with Unique ID""" + SOURCE_TYPE: Final[PunkAPI] = dataclasses.field(default=PunkAPI.PUNK_API, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_quickbooks.py b/src/airbyte/models/shared/source_quickbooks.py index f626232c..2ffdbf72 100644 --- a/src/airbyte/models/shared/source_quickbooks.py +++ b/src/airbyte/models/shared/source_quickbooks.py @@ -42,8 +42,8 @@ class SourceQuickbooks: credentials: Union[SourceQuickbooksOAuth20] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials') }}) start_date: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) r"""The default value to use if no bookmark exists for an endpoint (rfc3339 date string). E.g, 2021-03-20T00:00:00Z. Any data before this date will not be replicated.""" - SOURCE_TYPE: Final[Quickbooks] = dataclasses.field(default=Quickbooks.QUICKBOOKS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) sandbox: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sandbox'), 'exclude': lambda f: f is None }}) r"""Determines whether to use the sandbox or production environment.""" + SOURCE_TYPE: Final[Quickbooks] = dataclasses.field(default=Quickbooks.QUICKBOOKS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_recreation.py b/src/airbyte/models/shared/source_recreation.py index 9f0b94b8..83b3a240 100644 --- a/src/airbyte/models/shared/source_recreation.py +++ b/src/airbyte/models/shared/source_recreation.py @@ -16,7 +16,7 @@ class Recreation(str, Enum): class SourceRecreation: apikey: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('apikey') }}) r"""API Key""" - SOURCE_TYPE: Final[Recreation] = dataclasses.field(default=Recreation.RECREATION, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) query_campsites: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('query_campsites'), 'exclude': lambda f: f is None }}) + SOURCE_TYPE: Final[Recreation] = dataclasses.field(default=Recreation.RECREATION, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_recurly.py b/src/airbyte/models/shared/source_recurly.py index d4ffe900..d73ae8e3 100644 --- a/src/airbyte/models/shared/source_recurly.py +++ b/src/airbyte/models/shared/source_recurly.py @@ -16,10 +16,10 @@ class Recurly(str, Enum): class SourceRecurly: api_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_key') }}) r"""Recurly API Key. See the docs for more information on how to generate this key.""" - SOURCE_TYPE: Final[Recurly] = dataclasses.field(default=Recurly.RECURLY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) begin_time: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('begin_time'), 'exclude': lambda f: f is None }}) r"""ISO8601 timestamp from which the replication from Recurly API will start from.""" end_time: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('end_time'), 'exclude': lambda f: f is None }}) r"""ISO8601 timestamp to which the replication from Recurly API will stop. Records after that date won't be imported.""" + SOURCE_TYPE: Final[Recurly] = dataclasses.field(default=Recurly.RECURLY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_redshift.py b/src/airbyte/models/shared/source_redshift.py index fdb87ff3..76e6df68 100644 --- a/src/airbyte/models/shared/source_redshift.py +++ b/src/airbyte/models/shared/source_redshift.py @@ -22,12 +22,12 @@ class SourceRedshift: r"""Password associated with the username.""" username: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('username') }}) r"""Username to use to access the database.""" - SOURCE_TYPE: Final[SourceRedshiftRedshift] = dataclasses.field(default=SourceRedshiftRedshift.REDSHIFT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) jdbc_url_params: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('jdbc_url_params'), 'exclude': lambda f: f is None }}) r"""Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).""" port: Optional[int] = dataclasses.field(default=5439, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('port'), 'exclude': lambda f: f is None }}) r"""Port of the database.""" schemas: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('schemas'), 'exclude': lambda f: f is None }}) r"""The list of schemas to sync from. Specify one or more explicitly or keep empty to process all schemas. Schema names are case sensitive.""" + SOURCE_TYPE: Final[SourceRedshiftRedshift] = dataclasses.field(default=SourceRedshiftRedshift.REDSHIFT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_s3.py b/src/airbyte/models/shared/source_s3.py index 2a1384a1..6001c7db 100644 --- a/src/airbyte/models/shared/source_s3.py +++ b/src/airbyte/models/shared/source_s3.py @@ -311,7 +311,6 @@ class SourceS3: r"""Name of the S3 bucket where the file(s) exist.""" streams: List[SourceS3FileBasedStreamConfig] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('streams') }}) r"""Each instance of this configuration defines a stream. Use this to define which files belong in the stream, their format, and how they should be parsed and validated. When sending data to warehouse destination such as Snowflake or BigQuery, each stream is a separate table.""" - SOURCE_TYPE: Final[SourceS3S3] = dataclasses.field(default=SourceS3S3.S3, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) aws_access_key_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('aws_access_key_id'), 'exclude': lambda f: f is None }}) r"""In order to access private Buckets stored on AWS S3, this connector requires credentials with the proper permissions. If accessing publicly available data, this field is not necessary.""" aws_secret_access_key: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('aws_secret_access_key'), 'exclude': lambda f: f is None }}) @@ -328,6 +327,7 @@ class SourceS3: r"""Deprecated and will be removed soon. Please do not use this field anymore and use bucket, aws_access_key_id, aws_secret_access_key and endpoint instead. Use this to load files from S3 or S3-compatible services""" schema: Optional[str] = dataclasses.field(default='{}', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('schema'), 'exclude': lambda f: f is None }}) r"""Deprecated and will be removed soon. Please do not use this field anymore and use streams.input_schema instead. Optionally provide a schema to enforce, as a valid JSON string. Ensure this is a mapping of { \\"column\\" : \\"type\\" }, where types are valid JSON Schema datatypes. Leave as {} to auto-infer the schema.""" + SOURCE_TYPE: Final[SourceS3S3] = dataclasses.field(default=SourceS3S3.S3, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""UTC date and time in the format 2017-01-25T00:00:00.000000Z. Any file modified before this date will not be replicated.""" diff --git a/src/airbyte/models/shared/source_salesforce.py b/src/airbyte/models/shared/source_salesforce.py index 1d718b0a..9a033223 100644 --- a/src/airbyte/models/shared/source_salesforce.py +++ b/src/airbyte/models/shared/source_salesforce.py @@ -44,12 +44,12 @@ class SourceSalesforce: r"""Enter your Salesforce developer application's Client secret""" refresh_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('refresh_token') }}) r"""Enter your application's Salesforce Refresh Token used for Airbyte to access your Salesforce account.""" - SOURCE_TYPE: Final[SourceSalesforceSalesforce] = dataclasses.field(default=SourceSalesforceSalesforce.SALESFORCE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) AUTH_TYPE: Final[Optional[AuthType]] = dataclasses.field(default=AuthType.CLIENT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_type'), 'exclude': lambda f: f is None }}) force_use_bulk_api: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('force_use_bulk_api'), 'exclude': lambda f: f is None }}) r"""Toggle to use Bulk API (this might cause empty fields for some streams)""" is_sandbox: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('is_sandbox'), 'exclude': lambda f: f is None }}) r"""Toggle if you're using a Salesforce Sandbox""" + SOURCE_TYPE: Final[SourceSalesforceSalesforce] = dataclasses.field(default=SourceSalesforceSalesforce.SALESFORCE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""Enter the date (or date-time) in the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ssZ format. Airbyte will replicate the data updated on and after this date. If this field is blank, Airbyte will replicate the data for last two years.""" streams_criteria: Optional[List[StreamsCriteria]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('streams_criteria'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_senseforce.py b/src/airbyte/models/shared/source_senseforce.py index 764de98e..167ac137 100644 --- a/src/airbyte/models/shared/source_senseforce.py +++ b/src/airbyte/models/shared/source_senseforce.py @@ -23,8 +23,8 @@ class SourceSenseforce: r"""The ID of the dataset you want to synchronize. The ID can be found in the URL when opening the dataset. See here for more details. (Note: As the Senseforce API only allows to synchronize a specific dataset, each dataset you want to synchronize needs to be implemented as a separate airbyte source).""" start_date: date = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.dateisoformat(False), 'decoder': utils.datefromisoformat }}) r"""UTC date and time in the format 2017-01-25. Only data with \\"Timestamp\\" after this date will be replicated. Important note: This start date must be set to the first day of where your dataset provides data. If your dataset has data from 2020-10-10 10:21:10, set the start_date to 2020-10-10 or later""" - SOURCE_TYPE: Final[Senseforce] = dataclasses.field(default=Senseforce.SENSEFORCE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) slice_range: Optional[int] = dataclasses.field(default=10, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('slice_range'), 'exclude': lambda f: f is None }}) r"""The time increment used by the connector when requesting data from the Senseforce API. The bigger the value is, the less requests will be made and faster the sync will be. On the other hand, the more seldom the state is persisted and the more likely one could run into rate limites. Furthermore, consider that large chunks of time might take a long time for the Senseforce query to return data - meaning it could take in effect longer than with more smaller time slices. If there are a lot of data per day, set this setting to 1. If there is only very little data per day, you might change the setting to 10 or more.""" + SOURCE_TYPE: Final[Senseforce] = dataclasses.field(default=Senseforce.SENSEFORCE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_sentry.py b/src/airbyte/models/shared/source_sentry.py index 3a9f8fa0..d7947bfe 100644 --- a/src/airbyte/models/shared/source_sentry.py +++ b/src/airbyte/models/shared/source_sentry.py @@ -20,10 +20,10 @@ class SourceSentry: r"""The slug of the organization the groups belong to.""" project: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('project') }}) r"""The name (slug) of the Project you want to sync.""" - SOURCE_TYPE: Final[Sentry] = dataclasses.field(default=Sentry.SENTRY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) discover_fields: Optional[List[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('discover_fields'), 'exclude': lambda f: f is None }}) r"""Fields to retrieve when fetching discover events""" hostname: Optional[str] = dataclasses.field(default='sentry.io', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('hostname'), 'exclude': lambda f: f is None }}) r"""Host name of Sentry API server.For self-hosted, specify your host name here. Otherwise, leave it empty.""" + SOURCE_TYPE: Final[Sentry] = dataclasses.field(default=Sentry.SENTRY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_sftp.py b/src/airbyte/models/shared/source_sftp.py index 05da0fb8..8b6393a3 100644 --- a/src/airbyte/models/shared/source_sftp.py +++ b/src/airbyte/models/shared/source_sftp.py @@ -48,7 +48,6 @@ class SourceSftp: r"""The server host address""" user: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('user') }}) r"""The server user""" - SOURCE_TYPE: Final[Sftp] = dataclasses.field(default=Sftp.SFTP, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) credentials: Optional[Union[SourceSftpPasswordAuthentication, SourceSftpSSHKeyAuthentication]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) r"""The server authentication method""" file_pattern: Optional[str] = dataclasses.field(default='', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('file_pattern'), 'exclude': lambda f: f is None }}) @@ -59,5 +58,6 @@ class SourceSftp: r"""The directory to search files for sync""" port: Optional[int] = dataclasses.field(default=22, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('port'), 'exclude': lambda f: f is None }}) r"""The server port""" + SOURCE_TYPE: Final[Sftp] = dataclasses.field(default=Sftp.SFTP, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_sftp_bulk.py b/src/airbyte/models/shared/source_sftp_bulk.py index 821f1fe2..c93589e9 100644 --- a/src/airbyte/models/shared/source_sftp_bulk.py +++ b/src/airbyte/models/shared/source_sftp_bulk.py @@ -29,7 +29,6 @@ class SourceSftpBulk: r"""The name of the stream or table you want to create""" username: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('username') }}) r"""The server user""" - SOURCE_TYPE: Final[SftpBulk] = dataclasses.field(default=SftpBulk.SFTP_BULK, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) file_most_recent: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('file_most_recent'), 'exclude': lambda f: f is None }}) r"""Sync only the most recent file for the configured folder path and file pattern""" file_pattern: Optional[str] = dataclasses.field(default='', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('file_pattern'), 'exclude': lambda f: f is None }}) @@ -46,5 +45,6 @@ class SourceSftpBulk: r"""The private key""" separator: Optional[str] = dataclasses.field(default=',', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('separator'), 'exclude': lambda f: f is None }}) r"""The separator used in the CSV files. Define None if you want to use the Sniffer functionality""" + SOURCE_TYPE: Final[SftpBulk] = dataclasses.field(default=SftpBulk.SFTP_BULK, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_shopify.py b/src/airbyte/models/shared/source_shopify.py index a50b611b..922b7eac 100644 --- a/src/airbyte/models/shared/source_shopify.py +++ b/src/airbyte/models/shared/source_shopify.py @@ -31,9 +31,9 @@ class SourceShopifyAuthMethod(str, Enum): @dataclasses.dataclass class SourceShopifyOAuth20: r"""OAuth2.0""" - AUTH_METHOD: Final[SourceShopifyAuthMethod] = dataclasses.field(default=SourceShopifyAuthMethod.OAUTH2_0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_method') }}) access_token: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('access_token'), 'exclude': lambda f: f is None }}) r"""The Access Token for making authenticated requests.""" + AUTH_METHOD: Final[SourceShopifyAuthMethod] = dataclasses.field(default=SourceShopifyAuthMethod.OAUTH2_0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_method') }}) client_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_id'), 'exclude': lambda f: f is None }}) r"""The Client ID of the Shopify developer application.""" client_secret: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_secret'), 'exclude': lambda f: f is None }}) @@ -50,9 +50,9 @@ class SourceShopifyShopify(str, Enum): class SourceShopify: shop: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('shop') }}) r"""The name of your Shopify store found in the URL. For example, if your URL was https://NAME.myshopify.com, then the name would be 'NAME' or 'NAME.myshopify.com'.""" - SOURCE_TYPE: Final[SourceShopifyShopify] = dataclasses.field(default=SourceShopifyShopify.SHOPIFY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) credentials: Optional[Union[SourceShopifyOAuth20, APIPassword]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) r"""The authorization method to use to retrieve data from Shopify""" + SOURCE_TYPE: Final[SourceShopifyShopify] = dataclasses.field(default=SourceShopifyShopify.SHOPIFY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[date] = dataclasses.field(default=dateutil.parser.parse('2020-01-01').date(), metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.dateisoformat(True), 'decoder': utils.datefromisoformat, 'exclude': lambda f: f is None }}) r"""The date you would like to replicate data from. Format: YYYY-MM-DD. Any data before this date will not be replicated.""" diff --git a/src/airbyte/models/shared/source_slack.py b/src/airbyte/models/shared/source_slack.py index e14f6331..e816645f 100644 --- a/src/airbyte/models/shared/source_slack.py +++ b/src/airbyte/models/shared/source_slack.py @@ -48,7 +48,6 @@ class SourceSlackSlack(str, Enum): class SourceSlack: start_date: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) r"""UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.""" - SOURCE_TYPE: Final[SourceSlackSlack] = dataclasses.field(default=SourceSlackSlack.SLACK, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) channel_filter: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('channel_filter'), 'exclude': lambda f: f is None }}) r"""A channel name list (without leading '#' char) which limit the channels from which you'd like to sync. Empty list means no filter.""" credentials: Optional[Union[SignInViaSlackOAuth, SourceSlackAPIToken]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) @@ -57,5 +56,6 @@ class SourceSlack: r"""Whether to join all channels or to sync data only from channels the bot is already in. If false, you'll need to manually add the bot to all the channels from which you'd like to sync messages.""" lookback_window: Optional[int] = dataclasses.field(default=0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lookback_window'), 'exclude': lambda f: f is None }}) r"""How far into the past to look for messages in threads, default is 0 days""" + SOURCE_TYPE: Final[SourceSlackSlack] = dataclasses.field(default=SourceSlackSlack.SLACK, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_smartsheets.py b/src/airbyte/models/shared/source_smartsheets.py index 53e72a17..5ff2546e 100644 --- a/src/airbyte/models/shared/source_smartsheets.py +++ b/src/airbyte/models/shared/source_smartsheets.py @@ -72,9 +72,9 @@ class SourceSmartsheets: credentials: Union[SourceSmartsheetsOAuth20, APIAccessToken] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials') }}) spreadsheet_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('spreadsheet_id') }}) r"""The spreadsheet ID. Find it by opening the spreadsheet then navigating to File > Properties""" - SOURCE_TYPE: Final[SourceSmartsheetsSmartsheets] = dataclasses.field(default=SourceSmartsheetsSmartsheets.SMARTSHEETS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) metadata_fields: Optional[List[Validenums]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('metadata_fields'), 'exclude': lambda f: f is None }}) r"""A List of available columns which metadata can be pulled from.""" + SOURCE_TYPE: Final[SourceSmartsheetsSmartsheets] = dataclasses.field(default=SourceSmartsheetsSmartsheets.SMARTSHEETS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_datetime: Optional[datetime] = dataclasses.field(default=dateutil.parser.isoparse('2020-01-01T00:00:00+00:00'), metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_datetime'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""Only rows modified after this date/time will be replicated. This should be an ISO 8601 string, for instance: `2000-01-01T13:00:00`""" diff --git a/src/airbyte/models/shared/source_snapchat_marketing.py b/src/airbyte/models/shared/source_snapchat_marketing.py index c7f8a416..305cab14 100644 --- a/src/airbyte/models/shared/source_snapchat_marketing.py +++ b/src/airbyte/models/shared/source_snapchat_marketing.py @@ -22,9 +22,9 @@ class SourceSnapchatMarketing: r"""The Client Secret of your Snapchat developer application.""" refresh_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('refresh_token') }}) r"""Refresh Token to renew the expired Access Token.""" - SOURCE_TYPE: Final[SourceSnapchatMarketingSnapchatMarketing] = dataclasses.field(default=SourceSnapchatMarketingSnapchatMarketing.SNAPCHAT_MARKETING, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) end_date: Optional[date] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('end_date'), 'encoder': utils.dateisoformat(True), 'decoder': utils.datefromisoformat, 'exclude': lambda f: f is None }}) r"""Date in the format 2017-01-25. Any data after this date will not be replicated.""" + SOURCE_TYPE: Final[SourceSnapchatMarketingSnapchatMarketing] = dataclasses.field(default=SourceSnapchatMarketingSnapchatMarketing.SNAPCHAT_MARKETING, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[date] = dataclasses.field(default=dateutil.parser.parse('2022-01-01').date(), metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.dateisoformat(True), 'decoder': utils.datefromisoformat, 'exclude': lambda f: f is None }}) r"""Date in the format 2022-01-01. Any data before this date will not be replicated.""" diff --git a/src/airbyte/models/shared/source_snowflake.py b/src/airbyte/models/shared/source_snowflake.py index 2f30644a..5c0f5e18 100644 --- a/src/airbyte/models/shared/source_snowflake.py +++ b/src/airbyte/models/shared/source_snowflake.py @@ -33,9 +33,9 @@ class SourceSnowflakeOAuth20: r"""The Client ID of your Snowflake developer application.""" client_secret: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_secret') }}) r"""The Client Secret of your Snowflake developer application.""" - AUTH_TYPE: Final[SourceSnowflakeAuthType] = dataclasses.field(default=SourceSnowflakeAuthType.O_AUTH, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_type') }}) access_token: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('access_token'), 'exclude': lambda f: f is None }}) r"""Access Token for making authenticated requests.""" + AUTH_TYPE: Final[SourceSnowflakeAuthType] = dataclasses.field(default=SourceSnowflakeAuthType.O_AUTH, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_type') }}) refresh_token: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('refresh_token'), 'exclude': lambda f: f is None }}) r"""Refresh Token for making authenticated requests.""" @@ -56,11 +56,11 @@ class SourceSnowflake: r"""The role you created for Airbyte to access Snowflake.""" warehouse: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('warehouse') }}) r"""The warehouse you created for Airbyte to access data.""" - SOURCE_TYPE: Final[SourceSnowflakeSnowflake] = dataclasses.field(default=SourceSnowflakeSnowflake.SNOWFLAKE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) credentials: Optional[Union[SourceSnowflakeOAuth20, SourceSnowflakeUsernameAndPassword]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) jdbc_url_params: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('jdbc_url_params'), 'exclude': lambda f: f is None }}) r"""Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).""" schema: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('schema'), 'exclude': lambda f: f is None }}) r"""The source Snowflake schema tables. Leave empty to access tables from multiple schemas.""" + SOURCE_TYPE: Final[SourceSnowflakeSnowflake] = dataclasses.field(default=SourceSnowflakeSnowflake.SNOWFLAKE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_sonar_cloud.py b/src/airbyte/models/shared/source_sonar_cloud.py index d9957d26..4cd0ab80 100644 --- a/src/airbyte/models/shared/source_sonar_cloud.py +++ b/src/airbyte/models/shared/source_sonar_cloud.py @@ -21,9 +21,9 @@ class SourceSonarCloud: r"""Organization key. See here.""" user_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('user_token') }}) r"""Your User Token. See here. The token is case sensitive.""" - SOURCE_TYPE: Final[SonarCloud] = dataclasses.field(default=SonarCloud.SONAR_CLOUD, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) end_date: Optional[date] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('end_date'), 'encoder': utils.dateisoformat(True), 'decoder': utils.datefromisoformat, 'exclude': lambda f: f is None }}) r"""To retrieve issues created before the given date (inclusive).""" + SOURCE_TYPE: Final[SonarCloud] = dataclasses.field(default=SonarCloud.SONAR_CLOUD, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[date] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.dateisoformat(True), 'decoder': utils.datefromisoformat, 'exclude': lambda f: f is None }}) r"""To retrieve issues created after the given date (inclusive).""" diff --git a/src/airbyte/models/shared/source_spacex_api.py b/src/airbyte/models/shared/source_spacex_api.py index 9ba43b4d..c9903df9 100644 --- a/src/airbyte/models/shared/source_spacex_api.py +++ b/src/airbyte/models/shared/source_spacex_api.py @@ -14,8 +14,8 @@ class SpacexAPI(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceSpacexAPI: - SOURCE_TYPE: Final[SpacexAPI] = dataclasses.field(default=SpacexAPI.SPACEX_API, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('id'), 'exclude': lambda f: f is None }}) options: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('options'), 'exclude': lambda f: f is None }}) + SOURCE_TYPE: Final[SpacexAPI] = dataclasses.field(default=SpacexAPI.SPACEX_API, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_square.py b/src/airbyte/models/shared/source_square.py index e86ef402..bfb068d5 100644 --- a/src/airbyte/models/shared/source_square.py +++ b/src/airbyte/models/shared/source_square.py @@ -46,13 +46,13 @@ class SourceSquareSquare(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceSquare: - SOURCE_TYPE: Final[SourceSquareSquare] = dataclasses.field(default=SourceSquareSquare.SQUARE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) credentials: Optional[Union[OauthAuthentication, SourceSquareAPIKey]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) r"""Choose how to authenticate to Square.""" include_deleted_objects: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('include_deleted_objects'), 'exclude': lambda f: f is None }}) r"""In some streams there is an option to include deleted objects (Items, Categories, Discounts, Taxes)""" is_sandbox: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('is_sandbox'), 'exclude': lambda f: f is None }}) r"""Determines whether to use the sandbox or production environment.""" + SOURCE_TYPE: Final[SourceSquareSquare] = dataclasses.field(default=SourceSquareSquare.SQUARE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[date] = dataclasses.field(default=dateutil.parser.parse('2021-01-01').date(), metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.dateisoformat(True), 'decoder': utils.datefromisoformat, 'exclude': lambda f: f is None }}) r"""UTC date in the format YYYY-MM-DD. Any data before this date will not be replicated. If not set, all data will be replicated.""" diff --git a/src/airbyte/models/shared/source_strava.py b/src/airbyte/models/shared/source_strava.py index f764e4f3..4f0f2205 100644 --- a/src/airbyte/models/shared/source_strava.py +++ b/src/airbyte/models/shared/source_strava.py @@ -29,7 +29,7 @@ class SourceStrava: r"""The Refresh Token with the activity: read_all permissions.""" start_date: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) r"""UTC date and time. Any data before this date will not be replicated.""" - SOURCE_TYPE: Final[SourceStravaStrava] = dataclasses.field(default=SourceStravaStrava.STRAVA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) AUTH_TYPE: Final[Optional[SourceStravaAuthType]] = dataclasses.field(default=SourceStravaAuthType.CLIENT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('auth_type'), 'exclude': lambda f: f is None }}) + SOURCE_TYPE: Final[SourceStravaStrava] = dataclasses.field(default=SourceStravaStrava.STRAVA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_stripe.py b/src/airbyte/models/shared/source_stripe.py index 5b542e6c..de85b241 100644 --- a/src/airbyte/models/shared/source_stripe.py +++ b/src/airbyte/models/shared/source_stripe.py @@ -20,7 +20,6 @@ class SourceStripe: r"""Your Stripe account ID (starts with 'acct_', find yours here).""" client_secret: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_secret') }}) r"""Stripe API key (usually starts with 'sk_live_'; find yours here).""" - SOURCE_TYPE: Final[Stripe] = dataclasses.field(default=Stripe.STRIPE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) call_rate_limit: Optional[int] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('call_rate_limit'), 'exclude': lambda f: f is None }}) r"""The number of API calls per second that you allow connector to make. This value can not be bigger than real API call rate limit (https://stripe.com/docs/rate-limits). If not specified the default maximum is 25 and 100 calls per second for test and production tokens respectively.""" lookback_window_days: Optional[int] = dataclasses.field(default=0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lookback_window_days'), 'exclude': lambda f: f is None }}) @@ -29,6 +28,7 @@ class SourceStripe: r"""The number of worker thread to use for the sync. The performance upper boundary depends on call_rate_limit setting and type of account.""" slice_range: Optional[int] = dataclasses.field(default=365, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('slice_range'), 'exclude': lambda f: f is None }}) r"""The time increment used by the connector when requesting data from the Stripe API. The bigger the value is, the less requests will be made and faster the sync will be. On the other hand, the more seldom the state is persisted.""" + SOURCE_TYPE: Final[Stripe] = dataclasses.field(default=Stripe.STRIPE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[datetime] = dataclasses.field(default=dateutil.parser.isoparse('2017-01-25T00:00:00Z'), metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""UTC date and time in the format 2017-01-25T00:00:00Z. Only data generated after this date will be replicated.""" diff --git a/src/airbyte/models/shared/source_survey_sparrow.py b/src/airbyte/models/shared/source_survey_sparrow.py index 40d90c9c..2c8b7fda 100644 --- a/src/airbyte/models/shared/source_survey_sparrow.py +++ b/src/airbyte/models/shared/source_survey_sparrow.py @@ -38,9 +38,9 @@ class SurveySparrow(str, Enum): class SourceSurveySparrow: access_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('access_token') }}) r"""Your access token. See here. The key is case sensitive.""" - SOURCE_TYPE: Final[SurveySparrow] = dataclasses.field(default=SurveySparrow.SURVEY_SPARROW, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) region: Optional[Union[EUBasedAccount, GlobalAccount]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('region'), 'exclude': lambda f: f is None }}) r"""Is your account location is EU based? If yes, the base url to retrieve data will be different.""" + SOURCE_TYPE: Final[SurveySparrow] = dataclasses.field(default=SurveySparrow.SURVEY_SPARROW, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) survey_id: Optional[List[Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('survey_id'), 'exclude': lambda f: f is None }}) r"""A List of your survey ids for survey-specific stream""" diff --git a/src/airbyte/models/shared/source_surveymonkey.py b/src/airbyte/models/shared/source_surveymonkey.py index a9f23b7c..7f9a1221 100644 --- a/src/airbyte/models/shared/source_surveymonkey.py +++ b/src/airbyte/models/shared/source_surveymonkey.py @@ -42,11 +42,11 @@ class SourceSurveymonkeySurveymonkey(str, Enum): class SourceSurveymonkey: start_date: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) r"""UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.""" - SOURCE_TYPE: Final[SourceSurveymonkeySurveymonkey] = dataclasses.field(default=SourceSurveymonkeySurveymonkey.SURVEYMONKEY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) credentials: Optional[SurveyMonkeyAuthorizationMethod] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) r"""The authorization method to use to retrieve data from SurveyMonkey""" origin: Optional[OriginDatacenterOfTheSurveyMonkeyAccount] = dataclasses.field(default=OriginDatacenterOfTheSurveyMonkeyAccount.USA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('origin'), 'exclude': lambda f: f is None }}) r"""Depending on the originating datacenter of the SurveyMonkey account, the API access URL may be different.""" + SOURCE_TYPE: Final[SourceSurveymonkeySurveymonkey] = dataclasses.field(default=SourceSurveymonkeySurveymonkey.SURVEYMONKEY, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) survey_ids: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('survey_ids'), 'exclude': lambda f: f is None }}) r"""IDs of the surveys from which you'd like to replicate data. If left empty, data from all boards to which you have access will be replicated.""" diff --git a/src/airbyte/models/shared/source_the_guardian_api.py b/src/airbyte/models/shared/source_the_guardian_api.py index 73535e38..b8305d8c 100644 --- a/src/airbyte/models/shared/source_the_guardian_api.py +++ b/src/airbyte/models/shared/source_the_guardian_api.py @@ -18,13 +18,13 @@ class SourceTheGuardianAPI: r"""Your API Key. See here. The key is case sensitive.""" start_date: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date') }}) r"""Use this to set the minimum date (YYYY-MM-DD) of the results. Results older than the start_date will not be shown.""" - SOURCE_TYPE: Final[TheGuardianAPI] = dataclasses.field(default=TheGuardianAPI.THE_GUARDIAN_API, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) end_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('end_date'), 'exclude': lambda f: f is None }}) r"""(Optional) Use this to set the maximum date (YYYY-MM-DD) of the results. Results newer than the end_date will not be shown. Default is set to the current date (today) for incremental syncs.""" query: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('query'), 'exclude': lambda f: f is None }}) r"""(Optional) The query (q) parameter filters the results to only those that include that search term. The q parameter supports AND, OR and NOT operators.""" section: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('section'), 'exclude': lambda f: f is None }}) r"""(Optional) Use this to filter the results by a particular section. See here for a list of all sections, and here for the sections endpoint documentation.""" + SOURCE_TYPE: Final[TheGuardianAPI] = dataclasses.field(default=TheGuardianAPI.THE_GUARDIAN_API, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) tag: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tag'), 'exclude': lambda f: f is None }}) r"""(Optional) A tag is a piece of data that is used by The Guardian to categorise content. Use this parameter to filter results by showing only the ones matching the entered tag. See here for a list of all tags, and here for the tags endpoint documentation.""" diff --git a/src/airbyte/models/shared/source_trello.py b/src/airbyte/models/shared/source_trello.py index 76d08405..f3af6ad1 100644 --- a/src/airbyte/models/shared/source_trello.py +++ b/src/airbyte/models/shared/source_trello.py @@ -22,8 +22,8 @@ class SourceTrello: r"""UTC date and time in the format 2017-01-25T00:00:00Z. Any data before this date will not be replicated.""" token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('token') }}) r"""Trello API token. See the docs for instructions on how to generate it.""" - SOURCE_TYPE: Final[Trello] = dataclasses.field(default=Trello.TRELLO, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) board_ids: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('board_ids'), 'exclude': lambda f: f is None }}) r"""IDs of the boards to replicate data from. If left empty, data from all boards to which you have access will be replicated. Please note that this is not the 8-character ID in the board's shortLink (URL of the board). Rather, what is required here is the 24-character ID usually returned by the API""" + SOURCE_TYPE: Final[Trello] = dataclasses.field(default=Trello.TRELLO, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_tvmaze_schedule.py b/src/airbyte/models/shared/source_tvmaze_schedule.py index bbe926ba..ed18e757 100644 --- a/src/airbyte/models/shared/source_tvmaze_schedule.py +++ b/src/airbyte/models/shared/source_tvmaze_schedule.py @@ -18,9 +18,9 @@ class SourceTvmazeSchedule: r"""Country code for domestic TV schedule retrieval.""" start_date: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date') }}) r"""Start date for TV schedule retrieval. May be in the future.""" - SOURCE_TYPE: Final[TvmazeSchedule] = dataclasses.field(default=TvmazeSchedule.TVMAZE_SCHEDULE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) end_date: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('end_date'), 'exclude': lambda f: f is None }}) r"""End date for TV schedule retrieval. May be in the future. Optional.""" + SOURCE_TYPE: Final[TvmazeSchedule] = dataclasses.field(default=TvmazeSchedule.TVMAZE_SCHEDULE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) web_schedule_country_code: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('web_schedule_country_code'), 'exclude': lambda f: f is None }}) r"""ISO 3166-1 country code for web TV schedule retrieval. Leave blank for all countries plus global web channels (e.g. Netflix). Alternatively, diff --git a/src/airbyte/models/shared/source_twilio.py b/src/airbyte/models/shared/source_twilio.py index 3bc9b2e0..ff931a09 100644 --- a/src/airbyte/models/shared/source_twilio.py +++ b/src/airbyte/models/shared/source_twilio.py @@ -22,8 +22,8 @@ class SourceTwilio: r"""Twilio Auth Token.""" start_date: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) r"""UTC date and time in the format 2020-10-01T00:00:00Z. Any data before this date will not be replicated.""" - SOURCE_TYPE: Final[Twilio] = dataclasses.field(default=Twilio.TWILIO, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) lookback_window: Optional[int] = dataclasses.field(default=0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('lookback_window'), 'exclude': lambda f: f is None }}) r"""How far into the past to look for records. (in minutes)""" + SOURCE_TYPE: Final[Twilio] = dataclasses.field(default=Twilio.TWILIO, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_twitter.py b/src/airbyte/models/shared/source_twitter.py index 08b7e796..6b513674 100644 --- a/src/airbyte/models/shared/source_twitter.py +++ b/src/airbyte/models/shared/source_twitter.py @@ -20,9 +20,9 @@ class SourceTwitter: r"""App only Bearer Token. See the docs for more information on how to obtain this token.""" query: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('query') }}) r"""Query for matching Tweets. You can learn how to build this query by reading build a query guide .""" - SOURCE_TYPE: Final[Twitter] = dataclasses.field(default=Twitter.TWITTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) end_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('end_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""The end date for retrieving tweets must be a minimum of 10 seconds prior to the request time.""" + SOURCE_TYPE: Final[Twitter] = dataclasses.field(default=Twitter.TWITTER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""The start date for retrieving tweets cannot be more than 7 days in the past.""" diff --git a/src/airbyte/models/shared/source_typeform.py b/src/airbyte/models/shared/source_typeform.py index fda1bc62..72670efe 100644 --- a/src/airbyte/models/shared/source_typeform.py +++ b/src/airbyte/models/shared/source_typeform.py @@ -51,9 +51,9 @@ class SourceTypeformTypeform(str, Enum): @dataclasses.dataclass class SourceTypeform: credentials: Union[SourceTypeformOAuth20, SourceTypeformPrivateToken] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials') }}) - SOURCE_TYPE: Final[SourceTypeformTypeform] = dataclasses.field(default=SourceTypeformTypeform.TYPEFORM, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) form_ids: Optional[List[str]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('form_ids'), 'exclude': lambda f: f is None }}) r"""When this parameter is set, the connector will replicate data only from the input forms. Otherwise, all forms in your Typeform account will be replicated. You can find form IDs in your form URLs. For example, in the URL \\"https://mysite.typeform.com/to/u6nXL7\\" the form_id is u6nXL7. You can find form URLs on Share panel""" + SOURCE_TYPE: Final[SourceTypeformTypeform] = dataclasses.field(default=SourceTypeformTypeform.TYPEFORM, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""The date from which you'd like to replicate data for Typeform API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.""" diff --git a/src/airbyte/models/shared/source_us_census.py b/src/airbyte/models/shared/source_us_census.py index 5c5795cf..cfe7b152 100644 --- a/src/airbyte/models/shared/source_us_census.py +++ b/src/airbyte/models/shared/source_us_census.py @@ -18,8 +18,8 @@ class SourceUsCensus: r"""Your API Key. Get your key here.""" query_path: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('query_path') }}) r"""The path portion of the GET request""" - SOURCE_TYPE: Final[UsCensus] = dataclasses.field(default=UsCensus.US_CENSUS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) query_params: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('query_params'), 'exclude': lambda f: f is None }}) r"""The query parameters portion of the GET request, without the api key""" + SOURCE_TYPE: Final[UsCensus] = dataclasses.field(default=UsCensus.US_CENSUS, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_webflow.py b/src/airbyte/models/shared/source_webflow.py index ae0c4c4d..17d79913 100644 --- a/src/airbyte/models/shared/source_webflow.py +++ b/src/airbyte/models/shared/source_webflow.py @@ -18,8 +18,8 @@ class SourceWebflow: r"""The API token for authenticating to Webflow. See https://university.webflow.com/lesson/intro-to-the-webflow-api""" site_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('site_id') }}) r"""The id of the Webflow site you are requesting data from. See https://developers.webflow.com/#sites""" - SOURCE_TYPE: Final[Webflow] = dataclasses.field(default=Webflow.WEBFLOW, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) accept_version: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('accept_version'), 'exclude': lambda f: f is None }}) r"""The version of the Webflow API to use. See https://developers.webflow.com/#versioning""" + SOURCE_TYPE: Final[Webflow] = dataclasses.field(default=Webflow.WEBFLOW, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_yandex_metrica.py b/src/airbyte/models/shared/source_yandex_metrica.py index bb0529a1..58271507 100644 --- a/src/airbyte/models/shared/source_yandex_metrica.py +++ b/src/airbyte/models/shared/source_yandex_metrica.py @@ -21,8 +21,8 @@ class SourceYandexMetrica: r"""Counter ID""" start_date: date = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.dateisoformat(False), 'decoder': utils.datefromisoformat }}) r"""Starting point for your data replication, in format of \\"YYYY-MM-DD\\".""" - SOURCE_TYPE: Final[YandexMetrica] = dataclasses.field(default=YandexMetrica.YANDEX_METRICA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) end_date: Optional[date] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('end_date'), 'encoder': utils.dateisoformat(True), 'decoder': utils.datefromisoformat, 'exclude': lambda f: f is None }}) r"""Starting point for your data replication, in format of \\"YYYY-MM-DD\\". If not provided will sync till most recent date.""" + SOURCE_TYPE: Final[YandexMetrica] = dataclasses.field(default=YandexMetrica.YANDEX_METRICA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_yotpo.py b/src/airbyte/models/shared/source_yotpo.py index cee400a2..5fb944d8 100644 --- a/src/airbyte/models/shared/source_yotpo.py +++ b/src/airbyte/models/shared/source_yotpo.py @@ -22,8 +22,8 @@ class SourceYotpo: r"""App key found at settings (Ref- https://settings.yotpo.com/#/general_settings)""" start_date: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) r"""Date time filter for incremental filter, Specify which date to extract from.""" - SOURCE_TYPE: Final[Yotpo] = dataclasses.field(default=Yotpo.YOTPO, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) email: Optional[str] = dataclasses.field(default='example@gmail.com', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('email'), 'exclude': lambda f: f is None }}) r"""Email address registered with yotpo.""" + SOURCE_TYPE: Final[Yotpo] = dataclasses.field(default=Yotpo.YOTPO, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_zendesk_chat.py b/src/airbyte/models/shared/source_zendesk_chat.py index ef10a7d3..23dc8fbe 100644 --- a/src/airbyte/models/shared/source_zendesk_chat.py +++ b/src/airbyte/models/shared/source_zendesk_chat.py @@ -29,13 +29,13 @@ class SourceZendeskChatCredentials(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceZendeskChatOAuth20: - CREDENTIALS: Final[SourceZendeskChatCredentials] = dataclasses.field(default=SourceZendeskChatCredentials.OAUTH2_0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials') }}) access_token: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('access_token'), 'exclude': lambda f: f is None }}) r"""Access Token for making authenticated requests.""" client_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_id'), 'exclude': lambda f: f is None }}) r"""The Client ID of your OAuth application""" client_secret: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_secret'), 'exclude': lambda f: f is None }}) r"""The Client Secret of your OAuth application.""" + CREDENTIALS: Final[SourceZendeskChatCredentials] = dataclasses.field(default=SourceZendeskChatCredentials.OAUTH2_0, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials') }}) refresh_token: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('refresh_token'), 'exclude': lambda f: f is None }}) r"""Refresh Token to obtain new Access Token, when it's expired.""" @@ -50,8 +50,8 @@ class SourceZendeskChatZendeskChat(str, Enum): class SourceZendeskChat: start_date: datetime = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(False), 'decoder': dateutil.parser.isoparse }}) r"""The date from which you'd like to replicate data for Zendesk Chat API, in the format YYYY-MM-DDT00:00:00Z.""" - SOURCE_TYPE: Final[SourceZendeskChatZendeskChat] = dataclasses.field(default=SourceZendeskChatZendeskChat.ZENDESK_CHAT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) credentials: Optional[Union[SourceZendeskChatOAuth20, SourceZendeskChatAccessToken]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) + SOURCE_TYPE: Final[SourceZendeskChatZendeskChat] = dataclasses.field(default=SourceZendeskChatZendeskChat.ZENDESK_CHAT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) subdomain: Optional[str] = dataclasses.field(default='', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subdomain'), 'exclude': lambda f: f is None }}) r"""Required if you access Zendesk Chat from a Zendesk Support subdomain.""" diff --git a/src/airbyte/models/shared/source_zendesk_sunshine.py b/src/airbyte/models/shared/source_zendesk_sunshine.py index 0ee81b35..609e1de5 100644 --- a/src/airbyte/models/shared/source_zendesk_sunshine.py +++ b/src/airbyte/models/shared/source_zendesk_sunshine.py @@ -52,7 +52,7 @@ class SourceZendeskSunshine: r"""The date from which you'd like to replicate data for Zendesk Sunshine API, in the format YYYY-MM-DDT00:00:00Z.""" subdomain: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subdomain') }}) r"""The subdomain for your Zendesk Account.""" - SOURCE_TYPE: Final[SourceZendeskSunshineZendeskSunshine] = dataclasses.field(default=SourceZendeskSunshineZendeskSunshine.ZENDESK_SUNSHINE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) credentials: Optional[Union[SourceZendeskSunshineOAuth20, SourceZendeskSunshineAPIToken]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) + SOURCE_TYPE: Final[SourceZendeskSunshineZendeskSunshine] = dataclasses.field(default=SourceZendeskSunshineZendeskSunshine.ZENDESK_SUNSHINE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_zendesk_support.py b/src/airbyte/models/shared/source_zendesk_support.py index 9b8a6164..097bf5f6 100644 --- a/src/airbyte/models/shared/source_zendesk_support.py +++ b/src/airbyte/models/shared/source_zendesk_support.py @@ -52,11 +52,11 @@ class SourceZendeskSupportZendeskSupport(str, Enum): class SourceZendeskSupport: subdomain: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subdomain') }}) r"""This is your unique Zendesk subdomain that can be found in your account URL. For example, in https://MY_SUBDOMAIN.zendesk.com/, MY_SUBDOMAIN is the value of your subdomain.""" - SOURCE_TYPE: Final[SourceZendeskSupportZendeskSupport] = dataclasses.field(default=SourceZendeskSupportZendeskSupport.ZENDESK_SUPPORT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) credentials: Optional[Union[SourceZendeskSupportOAuth20, SourceZendeskSupportAPIToken]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) r"""Zendesk allows two authentication methods. We recommend using `OAuth2.0` for Airbyte Cloud users and `API token` for Airbyte Open Source users.""" ignore_pagination: Optional[bool] = dataclasses.field(default=False, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ignore_pagination'), 'exclude': lambda f: f is None }}) r"""Makes each stream read a single page of data.""" + SOURCE_TYPE: Final[SourceZendeskSupportZendeskSupport] = dataclasses.field(default=SourceZendeskSupportZendeskSupport.ZENDESK_SUPPORT, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_date: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is None }}) r"""The UTC date and time from which you'd like to replicate data, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.""" diff --git a/src/airbyte/models/shared/source_zendesk_talk.py b/src/airbyte/models/shared/source_zendesk_talk.py index 98804aec..41b52947 100644 --- a/src/airbyte/models/shared/source_zendesk_talk.py +++ b/src/airbyte/models/shared/source_zendesk_talk.py @@ -54,8 +54,8 @@ class SourceZendeskTalk: r"""The date from which you'd like to replicate data for Zendesk Talk API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.""" subdomain: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('subdomain') }}) r"""This is your Zendesk subdomain that can be found in your account URL. For example, in https://{MY_SUBDOMAIN}.zendesk.com/, where MY_SUBDOMAIN is the value of your subdomain.""" - SOURCE_TYPE: Final[SourceZendeskTalkZendeskTalk] = dataclasses.field(default=SourceZendeskTalkZendeskTalk.ZENDESK_TALK, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) credentials: Optional[Union[SourceZendeskTalkAPIToken, SourceZendeskTalkOAuth20]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) r"""Zendesk service provides two authentication methods. Choose between: `OAuth2.0` or `API token`.""" + SOURCE_TYPE: Final[SourceZendeskTalkZendeskTalk] = dataclasses.field(default=SourceZendeskTalkZendeskTalk.ZENDESK_TALK, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) diff --git a/src/airbyte/models/shared/source_zenloop.py b/src/airbyte/models/shared/source_zenloop.py index b6e1782d..cf929340 100644 --- a/src/airbyte/models/shared/source_zenloop.py +++ b/src/airbyte/models/shared/source_zenloop.py @@ -16,9 +16,9 @@ class Zenloop(str, Enum): class SourceZenloop: api_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_token') }}) r"""Zenloop API Token. You can get the API token in settings page here""" - SOURCE_TYPE: Final[Zenloop] = dataclasses.field(default=Zenloop.ZENLOOP, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) date_from: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('date_from'), 'exclude': lambda f: f is None }}) r"""Zenloop date_from. Format: 2021-10-24T03:30:30Z or 2021-10-24. Leave empty if only data from current data should be synced""" + SOURCE_TYPE: Final[Zenloop] = dataclasses.field(default=Zenloop.ZENLOOP, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) survey_group_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('survey_group_id'), 'exclude': lambda f: f is None }}) r"""Zenloop Survey Group ID. Can be found by pulling All Survey Groups via SurveyGroups stream. Leave empty to pull answers from all survey groups""" survey_id: Optional[str] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('survey_id'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_zoho_crm.py b/src/airbyte/models/shared/source_zoho_crm.py index b02e85d2..50d92bff 100644 --- a/src/airbyte/models/shared/source_zoho_crm.py +++ b/src/airbyte/models/shared/source_zoho_crm.py @@ -49,9 +49,9 @@ class SourceZohoCrm: r"""Please choose the environment""" refresh_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('refresh_token') }}) r"""OAuth2.0 Refresh Token""" - SOURCE_TYPE: Final[ZohoCrm] = dataclasses.field(default=ZohoCrm.ZOHO_CRM, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) edition: Optional[ZohoCRMEdition] = dataclasses.field(default=ZohoCRMEdition.FREE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edition'), 'exclude': lambda f: f is None }}) r"""Choose your Edition of Zoho CRM to determine API Concurrency Limits""" + SOURCE_TYPE: Final[ZohoCrm] = dataclasses.field(default=ZohoCrm.ZOHO_CRM, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) start_datetime: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_datetime'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse }}) r"""ISO 8601, for instance: `YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS+HH:MM`""" diff --git a/src/airbyte/models/shared/source_zuora.py b/src/airbyte/models/shared/source_zuora.py index 8b2bb8e8..e4d67251 100644 --- a/src/airbyte/models/shared/source_zuora.py +++ b/src/airbyte/models/shared/source_zuora.py @@ -39,9 +39,9 @@ class SourceZuora: r"""Start Date in format: YYYY-MM-DD""" tenant_endpoint: TenantEndpointLocation = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('tenant_endpoint') }}) r"""Please choose the right endpoint where your Tenant is located. More info by this Link""" - SOURCE_TYPE: Final[Zuora] = dataclasses.field(default=Zuora.ZUORA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) data_query: Optional[DataQueryType] = dataclasses.field(default=DataQueryType.LIVE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('data_query'), 'exclude': lambda f: f is None }}) r"""Choose between `Live`, or `Unlimited` - the optimized, replicated database at 12 hours freshness for high volume extraction Link""" + SOURCE_TYPE: Final[Zuora] = dataclasses.field(default=Zuora.ZUORA, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) window_in_days: Optional[str] = dataclasses.field(default='90', metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('window_in_days'), 'exclude': lambda f: f is None }}) r"""The amount of days for each data-chunk begining from start_date. Bigger the value - faster the fetch. (0.1 - as for couple of hours, 1 - as for a Day; 364 - as for a Year).""" diff --git a/src/airbyte/sdkconfiguration.py b/src/airbyte/sdkconfiguration.py index 2ec18200..fe02b389 100644 --- a/src/airbyte/sdkconfiguration.py +++ b/src/airbyte/sdkconfiguration.py @@ -22,9 +22,9 @@ class SDKConfiguration: server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' - sdk_version: str = '0.46.0' - gen_version: str = '2.248.1' - user_agent: str = 'speakeasy-sdk/python 0.46.0 2.248.1 1.0.0 airbyte-api' + sdk_version: str = '0.47.0' + gen_version: str = '2.250.12' + user_agent: str = 'speakeasy-sdk/python 0.47.0 2.250.12 1.0.0 airbyte-api' retry_config: RetryConfig = None def get_server_details(self) -> Tuple[str, Dict[str, str]]: From bd7dba1094e4bc8a92a2eee998ce67c9708788ee Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 13 Feb 2024 00:14:39 +0000 Subject: [PATCH 4/4] ci: regenerated with OpenAPI Doc 1.0.0, Speakeasy CLI 1.178.0 --- .speakeasy/gen.lock | 2 +- README.md | 94 +------------------ RELEASES.md | 10 ++ USAGE.md | 18 ---- docs/models/operations/canceljobresponse.md | 12 +-- .../operations/createdestinationresponse.md | 12 +-- docs/models/operations/createjobresponse.md | 12 +-- .../models/operations/createsourceresponse.md | 12 +-- .../operations/getdestinationresponse.md | 12 +-- docs/models/operations/getjobresponse.md | 12 +-- docs/models/operations/getsourceresponse.md | 12 +-- .../operations/listconnectionsresponse.md | 12 +-- .../operations/listdestinationsresponse.md | 12 +-- docs/models/operations/listjobsresponse.md | 12 +-- docs/models/operations/listsourcesresponse.md | 12 +-- .../operations/listworkspacesresponse.md | 12 +-- .../operations/patchdestinationresponse.md | 12 +-- docs/models/operations/patchsourceresponse.md | 12 +-- .../operations/putdestinationresponse.md | 12 +-- docs/models/operations/putsourceresponse.md | 12 +-- docs/models/shared/initiateoauthrequest.md | 12 +-- docs/sdks/connections/README.md | 42 +-------- docs/sdks/destinations/README.md | 39 ++------ docs/sdks/jobs/README.md | 9 +- docs/sdks/sources/README.md | 33 ++----- docs/sdks/workspaces/README.md | 10 +- src/airbyte/models/shared/source_alloydb.py | 7 ++ .../models/shared/source_e2e_test_cloud.py | 1 + src/airbyte/models/shared/source_harvest.py | 2 + .../models/shared/source_mongodb_v2.py | 2 + src/airbyte/models/shared/source_pinterest.py | 3 +- src/airbyte/models/shared/source_postgres.py | 7 ++ src/airbyte/models/shared/source_retently.py | 2 + .../models/shared/source_youtube_analytics.py | 1 + .../models/shared/source_zendesk_support.py | 2 + .../models/shared/source_zendesk_talk.py | 2 + src/airbyte/models/shared/source_zoho_crm.py | 3 +- src/airbyte/sdkconfiguration.py | 15 +-- 38 files changed, 171 insertions(+), 337 deletions(-) diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index d2d84ab5..1d81e93a 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -4,7 +4,7 @@ management: docChecksum: c101e6356aa26bcdee80457c4dc64471 docVersion: 1.0.0 speakeasyVersion: internal - generationVersion: 2.250.12 + generationVersion: 2.253.0 releaseVersion: 0.47.0 configChecksum: 3fcff865c11ce83075716a8313369445 repoURL: https://github.com/airbytehq/airbyte-api-python-sdk.git diff --git a/README.md b/README.md index 386738cc..415fcefd 100755 --- a/README.md +++ b/README.md @@ -42,25 +42,7 @@ s = airbyte.Airbyte( req = shared.ConnectionCreateRequest( destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', - configurations=shared.StreamConfigurations( - streams=[ - shared.StreamConfiguration( - name='string', - cursor_field=[ - 'string', - ], - primary_key=[ - [ - 'string', - ], - ], - ), - ], - ), namespace_format='${SOURCE_NAMESPACE}', - schedule=shared.ConnectionSchedule( - schedule_type=shared.ScheduleTypeEnum.CRON, - ), ) res = s.connections.create_connection(req) @@ -141,7 +123,7 @@ Handling errors in this SDK should largely match your expectations. All operati ```python import airbyte -from airbyte.models import shared +from airbyte.models import errors, shared s = airbyte.Airbyte( security=shared.Security( @@ -155,32 +137,14 @@ s = airbyte.Airbyte( req = shared.ConnectionCreateRequest( destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', - configurations=shared.StreamConfigurations( - streams=[ - shared.StreamConfiguration( - name='string', - cursor_field=[ - 'string', - ], - primary_key=[ - [ - 'string', - ], - ], - ), - ], - ), namespace_format='${SOURCE_NAMESPACE}', - schedule=shared.ConnectionSchedule( - schedule_type=shared.ScheduleTypeEnum.CRON, - ), ) res = None try: res = s.connections.create_connection(req) except errors.SDKError as e: - print(e) # handle exception + # handle exception raise(e) if res.connection_response is not None: @@ -221,25 +185,7 @@ s = airbyte.Airbyte( req = shared.ConnectionCreateRequest( destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', - configurations=shared.StreamConfigurations( - streams=[ - shared.StreamConfiguration( - name='string', - cursor_field=[ - 'string', - ], - primary_key=[ - [ - 'string', - ], - ], - ), - ], - ), namespace_format='${SOURCE_NAMESPACE}', - schedule=shared.ConnectionSchedule( - schedule_type=shared.ScheduleTypeEnum.CRON, - ), ) res = s.connections.create_connection(req) @@ -270,25 +216,7 @@ s = airbyte.Airbyte( req = shared.ConnectionCreateRequest( destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', - configurations=shared.StreamConfigurations( - streams=[ - shared.StreamConfiguration( - name='string', - cursor_field=[ - 'string', - ], - primary_key=[ - [ - 'string', - ], - ], - ), - ], - ), namespace_format='${SOURCE_NAMESPACE}', - schedule=shared.ConnectionSchedule( - schedule_type=shared.ScheduleTypeEnum.CRON, - ), ) res = s.connections.create_connection(req) @@ -348,25 +276,7 @@ s = airbyte.Airbyte( req = shared.ConnectionCreateRequest( destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', - configurations=shared.StreamConfigurations( - streams=[ - shared.StreamConfiguration( - name='string', - cursor_field=[ - 'string', - ], - primary_key=[ - [ - 'string', - ], - ], - ), - ], - ), namespace_format='${SOURCE_NAMESPACE}', - schedule=shared.ConnectionSchedule( - schedule_type=shared.ScheduleTypeEnum.CRON, - ), ) res = s.connections.create_connection(req) diff --git a/RELEASES.md b/RELEASES.md index 3c4b4d88..de88426a 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -838,4 +838,14 @@ Based on: ### Generated - [python v0.47.0] . ### Releases +- [PyPI v0.47.0] https://pypi.org/project/airbyte-api/0.47.0 - . + +## 2024-02-13 00:14:09 +### Changes +Based on: +- OpenAPI Doc 1.0.0 +- Speakeasy CLI 1.178.0 (2.253.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v0.47.0] . +### Releases - [PyPI v0.47.0] https://pypi.org/project/airbyte-api/0.47.0 - . \ No newline at end of file diff --git a/USAGE.md b/USAGE.md index e87ae5d2..9140b30c 100644 --- a/USAGE.md +++ b/USAGE.md @@ -15,25 +15,7 @@ s = airbyte.Airbyte( req = shared.ConnectionCreateRequest( destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', - configurations=shared.StreamConfigurations( - streams=[ - shared.StreamConfiguration( - name='string', - cursor_field=[ - 'string', - ], - primary_key=[ - [ - 'string', - ], - ], - ), - ], - ), namespace_format='${SOURCE_NAMESPACE}', - schedule=shared.ConnectionSchedule( - schedule_type=shared.ScheduleTypeEnum.CRON, - ), ) res = s.connections.create_connection(req) diff --git a/docs/models/operations/canceljobresponse.md b/docs/models/operations/canceljobresponse.md index 344ddd4e..6c9f5265 100644 --- a/docs/models/operations/canceljobresponse.md +++ b/docs/models/operations/canceljobresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `job_response` | [Optional[shared.JobResponse]](../../models/shared/jobresponse.md) | :heavy_minus_sign: | Cancel a Job. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `job_response` | [Optional[shared.JobResponse]](../../models/shared/jobresponse.md) | :heavy_minus_sign: | Cancel a Job. | {"id":"18dccc91-0ab1-4f72-9ed7-0b8fc27c5826","status":"running","jobType":"sync","startTime":"2023-03-25T01:30:50Z","duration":"PT8H6M12S"} | \ No newline at end of file diff --git a/docs/models/operations/createdestinationresponse.md b/docs/models/operations/createdestinationresponse.md index b705e661..9f4e3261 100644 --- a/docs/models/operations/createdestinationresponse.md +++ b/docs/models/operations/createdestinationresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `destination_response` | [Optional[shared.DestinationResponse]](../../models/shared/destinationresponse.md) | :heavy_minus_sign: | Successful operation | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `destination_response` | [Optional[shared.DestinationResponse]](../../models/shared/destinationresponse.md) | :heavy_minus_sign: | Successful operation | {"destinationId":"18dccc91-0ab1-4f72-9ed7-0b8fc27c5826","name":"Analytics Team Postgres","destinationType":"postgres","workspaceId":"871d9b60-11d1-44cb-8c92-c246d53bf87e"} | \ No newline at end of file diff --git a/docs/models/operations/createjobresponse.md b/docs/models/operations/createjobresponse.md index 9e33bf33..7115e993 100644 --- a/docs/models/operations/createjobresponse.md +++ b/docs/models/operations/createjobresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `job_response` | [Optional[shared.JobResponse]](../../models/shared/jobresponse.md) | :heavy_minus_sign: | Kicks off a new Job based on the JobType. The connectionId is the resource that Job will be run for. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `job_response` | [Optional[shared.JobResponse]](../../models/shared/jobresponse.md) | :heavy_minus_sign: | Kicks off a new Job based on the JobType. The connectionId is the resource that Job will be run for. | {"id":"18dccc91-0ab1-4f72-9ed7-0b8fc27c5826","status":"running","jobType":"sync","startTime":"2023-03-25T01:30:50Z","duration":"PT8H6M12S"} | \ No newline at end of file diff --git a/docs/models/operations/createsourceresponse.md b/docs/models/operations/createsourceresponse.md index 62a51392..7a96f566 100644 --- a/docs/models/operations/createsourceresponse.md +++ b/docs/models/operations/createsourceresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `source_response` | [Optional[shared.SourceResponse]](../../models/shared/sourceresponse.md) | :heavy_minus_sign: | Successful operation | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `source_response` | [Optional[shared.SourceResponse]](../../models/shared/sourceresponse.md) | :heavy_minus_sign: | Successful operation | {"sourceId":"18dccc91-0ab1-4f72-9ed7-0b8fc27c5826","name":"Analytics Team Postgres","sourceType":"postgres","workspaceId":"871d9b60-11d1-44cb-8c92-c246d53bf87e"} | \ No newline at end of file diff --git a/docs/models/operations/getdestinationresponse.md b/docs/models/operations/getdestinationresponse.md index eb46db32..d0d45c24 100644 --- a/docs/models/operations/getdestinationresponse.md +++ b/docs/models/operations/getdestinationresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `destination_response` | [Optional[shared.DestinationResponse]](../../models/shared/destinationresponse.md) | :heavy_minus_sign: | Get a Destination by the id in the path. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `destination_response` | [Optional[shared.DestinationResponse]](../../models/shared/destinationresponse.md) | :heavy_minus_sign: | Get a Destination by the id in the path. | {"destinationId":"18dccc91-0ab1-4f72-9ed7-0b8fc27c5826","name":"Analytics Team Postgres","destinationType":"postgres","workspaceId":"871d9b60-11d1-44cb-8c92-c246d53bf87e"} | \ No newline at end of file diff --git a/docs/models/operations/getjobresponse.md b/docs/models/operations/getjobresponse.md index 70425cd7..c93a490d 100644 --- a/docs/models/operations/getjobresponse.md +++ b/docs/models/operations/getjobresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `job_response` | [Optional[shared.JobResponse]](../../models/shared/jobresponse.md) | :heavy_minus_sign: | Get a Job by the id in the path. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `job_response` | [Optional[shared.JobResponse]](../../models/shared/jobresponse.md) | :heavy_minus_sign: | Get a Job by the id in the path. | {"id":"18dccc91-0ab1-4f72-9ed7-0b8fc27c5826","status":"running","jobType":"sync","startTime":"2023-03-25T01:30:50Z","duration":"PT8H6M12S"} | \ No newline at end of file diff --git a/docs/models/operations/getsourceresponse.md b/docs/models/operations/getsourceresponse.md index 88e6f03a..bec9dd33 100644 --- a/docs/models/operations/getsourceresponse.md +++ b/docs/models/operations/getsourceresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `source_response` | [Optional[shared.SourceResponse]](../../models/shared/sourceresponse.md) | :heavy_minus_sign: | Get a Source by the id in the path. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `source_response` | [Optional[shared.SourceResponse]](../../models/shared/sourceresponse.md) | :heavy_minus_sign: | Get a Source by the id in the path. | {"sourceId":"18dccc91-0ab1-4f72-9ed7-0b8fc27c5826","name":"Analytics Team Postgres","sourceType":"postgres","workspaceId":"871d9b60-11d1-44cb-8c92-c246d53bf87e"} | \ No newline at end of file diff --git a/docs/models/operations/listconnectionsresponse.md b/docs/models/operations/listconnectionsresponse.md index b5f291ab..bf76e3d1 100644 --- a/docs/models/operations/listconnectionsresponse.md +++ b/docs/models/operations/listconnectionsresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `connections_response` | [Optional[shared.ConnectionsResponse]](../../models/shared/connectionsresponse.md) | :heavy_minus_sign: | Successful operation | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `connections_response` | [Optional[shared.ConnectionsResponse]](../../models/shared/connectionsresponse.md) | :heavy_minus_sign: | Successful operation | {"next":"https://api.airbyte.com/v1/connections?limit=5&offset=10","previous":"https://api.airbyte.com/v1/connections?limit=5&offset=0","data":[{"name":"test-connection"},{"connection_id":"18dccc91-0ab1-4f72-9ed7-0b8fc27c5826"},{"sourceId":"49237019-645d-47d4-b45b-5eddf97775ce"},{"destinationId":"al312fs-0ab1-4f72-9ed7-0b8fc27c5826"},{"schedule":{"scheduleType":"manual"}},{"status":"active"},{"dataResidency":"auto"}]} | \ No newline at end of file diff --git a/docs/models/operations/listdestinationsresponse.md b/docs/models/operations/listdestinationsresponse.md index 13a19428..e2158449 100644 --- a/docs/models/operations/listdestinationsresponse.md +++ b/docs/models/operations/listdestinationsresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `destinations_response` | [Optional[shared.DestinationsResponse]](../../models/shared/destinationsresponse.md) | :heavy_minus_sign: | Successful operation | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `destinations_response` | [Optional[shared.DestinationsResponse]](../../models/shared/destinationsresponse.md) | :heavy_minus_sign: | Successful operation | {"next":"https://api.airbyte.com/v1/destinations?limit=5&offset=10","previous":"https://api.airbyte.com/v1/destinations?limit=5&offset=0","data":{"destinationId":"18dccc91-0ab1-4f72-9ed7-0b8fc27c5826","name":"Analytics Team Postgres","destinationType":"postgres","workspaceId":"871d9b60-11d1-44cb-8c92-c246d53bf87e"}} | \ No newline at end of file diff --git a/docs/models/operations/listjobsresponse.md b/docs/models/operations/listjobsresponse.md index f5a064d6..4209fbf0 100644 --- a/docs/models/operations/listjobsresponse.md +++ b/docs/models/operations/listjobsresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `jobs_response` | [Optional[shared.JobsResponse]](../../models/shared/jobsresponse.md) | :heavy_minus_sign: | List all the Jobs by connectionId. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `jobs_response` | [Optional[shared.JobsResponse]](../../models/shared/jobsresponse.md) | :heavy_minus_sign: | List all the Jobs by connectionId. | {"next":"https://api.airbyte.com/v1/jobs?limit=5&offset=10","previous":"https://api.airbyte.com/v1/jobs?limit=5&offset=0","data":[{"id":"18dccc91-0ab1-4f72-9ed7-0b8fc27c5826","status":"running","jobType":"sync","startTime":"2023-03-25T01:30:50Z"}]} | \ No newline at end of file diff --git a/docs/models/operations/listsourcesresponse.md b/docs/models/operations/listsourcesresponse.md index ceeaee56..3fff79fd 100644 --- a/docs/models/operations/listsourcesresponse.md +++ b/docs/models/operations/listsourcesresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `sources_response` | [Optional[shared.SourcesResponse]](../../models/shared/sourcesresponse.md) | :heavy_minus_sign: | Successful operation | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `sources_response` | [Optional[shared.SourcesResponse]](../../models/shared/sourcesresponse.md) | :heavy_minus_sign: | Successful operation | {"next":"https://api.airbyte.com/v1/sources?limit=5&offset=10","previous":"https://api.airbyte.com/v1/sources?limit=5&offset=0","data":{"sourceId":"18dccc91-0ab1-4f72-9ed7-0b8fc27c5826","name":"Analytics Team Postgres","sourceType":"postgres","workspaceId":"871d9b60-11d1-44cb-8c92-c246d53bf87e"}} | \ No newline at end of file diff --git a/docs/models/operations/listworkspacesresponse.md b/docs/models/operations/listworkspacesresponse.md index 7ff8bfa7..2103b7ae 100644 --- a/docs/models/operations/listworkspacesresponse.md +++ b/docs/models/operations/listworkspacesresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `workspaces_response` | [Optional[shared.WorkspacesResponse]](../../models/shared/workspacesresponse.md) | :heavy_minus_sign: | Successful operation | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `workspaces_response` | [Optional[shared.WorkspacesResponse]](../../models/shared/workspacesresponse.md) | :heavy_minus_sign: | Successful operation | {"next":"https://api.airbyte.com/v1/workspaces?limit=5&offset=10","previous":"https://api.airbyte.com/v1/workspaces?limit=5&offset=0","data":{"workspaceId":"18dccc91-0ab1-4f72-9ed7-0b8fc27c5826","name":"Acme Company","dataResidency":"auto"}} | \ No newline at end of file diff --git a/docs/models/operations/patchdestinationresponse.md b/docs/models/operations/patchdestinationresponse.md index 5b35a483..d2dfe56e 100644 --- a/docs/models/operations/patchdestinationresponse.md +++ b/docs/models/operations/patchdestinationresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `destination_response` | [Optional[shared.DestinationResponse]](../../models/shared/destinationresponse.md) | :heavy_minus_sign: | Update a Destination | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `destination_response` | [Optional[shared.DestinationResponse]](../../models/shared/destinationresponse.md) | :heavy_minus_sign: | Update a Destination | {"destinationId":"18dccc91-0ab1-4f72-9ed7-0b8fc27c5826","name":"Analytics Team Postgres","destinationType":"postgres","workspaceId":"871d9b60-11d1-44cb-8c92-c246d53bf87e"} | \ No newline at end of file diff --git a/docs/models/operations/patchsourceresponse.md b/docs/models/operations/patchsourceresponse.md index 93ff3cc2..f2bccfe8 100644 --- a/docs/models/operations/patchsourceresponse.md +++ b/docs/models/operations/patchsourceresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `source_response` | [Optional[shared.SourceResponse]](../../models/shared/sourceresponse.md) | :heavy_minus_sign: | Update a Source | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `source_response` | [Optional[shared.SourceResponse]](../../models/shared/sourceresponse.md) | :heavy_minus_sign: | Update a Source | {"sourceId":"18dccc91-0ab1-4f72-9ed7-0b8fc27c5826","name":"Analytics Team Postgres","sourceType":"postgres","workspaceId":"871d9b60-11d1-44cb-8c92-c246d53bf87e"} | \ No newline at end of file diff --git a/docs/models/operations/putdestinationresponse.md b/docs/models/operations/putdestinationresponse.md index 005358df..646d06a8 100644 --- a/docs/models/operations/putdestinationresponse.md +++ b/docs/models/operations/putdestinationresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `destination_response` | [Optional[shared.DestinationResponse]](../../models/shared/destinationresponse.md) | :heavy_minus_sign: | Update a Destination and fully overwrite it | \ No newline at end of file +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `destination_response` | [Optional[shared.DestinationResponse]](../../models/shared/destinationresponse.md) | :heavy_minus_sign: | Update a Destination and fully overwrite it | {"destinationId":"18dccc91-0ab1-4f72-9ed7-0b8fc27c5826","name":"Analytics Team Postgres","destinationType":"postgres","workspaceId":"871d9b60-11d1-44cb-8c92-c246d53bf87e"} | \ No newline at end of file diff --git a/docs/models/operations/putsourceresponse.md b/docs/models/operations/putsourceresponse.md index 7515a378..bcdda814 100644 --- a/docs/models/operations/putsourceresponse.md +++ b/docs/models/operations/putsourceresponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | -| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `source_response` | [Optional[shared.SourceResponse]](../../models/shared/sourceresponse.md) | :heavy_minus_sign: | Update a source and fully overwrite it | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | | +| `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `raw_response` | [requests.Response](https://requests.readthedocs.io/en/latest/api/#requests.Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `source_response` | [Optional[shared.SourceResponse]](../../models/shared/sourceresponse.md) | :heavy_minus_sign: | Update a source and fully overwrite it | {"sourceId":"18dccc91-0ab1-4f72-9ed7-0b8fc27c5826","name":"Analytics Team Postgres","sourceType":"postgres","workspaceId":"871d9b60-11d1-44cb-8c92-c246d53bf87e"} | \ No newline at end of file diff --git a/docs/models/shared/initiateoauthrequest.md b/docs/models/shared/initiateoauthrequest.md index e4540a59..9b6d808f 100644 --- a/docs/models/shared/initiateoauthrequest.md +++ b/docs/models/shared/initiateoauthrequest.md @@ -5,9 +5,9 @@ POST body for initiating OAuth via the public API ## Fields -| Field | Type | Required | Description | -| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `redirect_url` | *str* | :heavy_check_mark: | The URL to redirect the user to with the OAuth secret stored in the secret_id query string parameter after authentication is complete. | -| `source_type` | [shared.OAuthActorNames](../../models/shared/oauthactornames.md) | :heavy_check_mark: | N/A | -| `workspace_id` | *str* | :heavy_check_mark: | The workspace to create the secret and eventually the full source. | -| `o_auth_input_configuration` | [Optional[shared.OAuthInputConfiguration]](../../models/shared/oauthinputconfiguration.md) | :heavy_minus_sign: | Arbitrary vars to pass for OAuth depending on what the source/destination spec requires. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `redirect_url` | *str* | :heavy_check_mark: | The URL to redirect the user to with the OAuth secret stored in the secret_id query string parameter after authentication is complete. | | +| `source_type` | [shared.OAuthActorNames](../../models/shared/oauthactornames.md) | :heavy_check_mark: | N/A | | +| `workspace_id` | *str* | :heavy_check_mark: | The workspace to create the secret and eventually the full source. | | +| `o_auth_input_configuration` | [Optional[shared.OAuthInputConfiguration]](../../models/shared/oauthinputconfiguration.md) | :heavy_minus_sign: | Arbitrary vars to pass for OAuth depending on what the source/destination spec requires. | {"host":"test.snowflake.com"} | \ No newline at end of file diff --git a/docs/sdks/connections/README.md b/docs/sdks/connections/README.md index f0d5563c..0294375c 100644 --- a/docs/sdks/connections/README.md +++ b/docs/sdks/connections/README.md @@ -31,25 +31,7 @@ s = airbyte.Airbyte( req = shared.ConnectionCreateRequest( destination_id='c669dd1e-3620-483e-afc8-55914e0a570f', source_id='6dd427d8-3a55-4584-b835-842325b6c7b3', - configurations=shared.StreamConfigurations( - streams=[ - shared.StreamConfiguration( - name='string', - cursor_field=[ - 'string', - ], - primary_key=[ - [ - 'string', - ], - ], - ), - ], - ), namespace_format='${SOURCE_NAMESPACE}', - schedule=shared.ConnectionSchedule( - schedule_type=shared.ScheduleTypeEnum.CRON, - ), ) res = s.connections.create_connection(req) @@ -186,11 +168,7 @@ s = airbyte.Airbyte( ), ) -req = operations.ListConnectionsRequest( - workspace_ids=[ - 'bed8f6e5-32a5-45f7-9c2b-30682edc8796', - ], -) +req = operations.ListConnectionsRequest() res = s.connections.list_connections(req) @@ -236,25 +214,7 @@ s = airbyte.Airbyte( req = operations.PatchConnectionRequest( connection_patch_request=shared.ConnectionPatchRequest( - configurations=shared.StreamConfigurations( - streams=[ - shared.StreamConfiguration( - name='string', - cursor_field=[ - 'string', - ], - primary_key=[ - [ - 'string', - ], - ], - ), - ], - ), namespace_format='${SOURCE_NAMESPACE}', - schedule=shared.ConnectionSchedule( - schedule_type=shared.ScheduleTypeEnum.MANUAL, - ), ), connection_id='string', ) diff --git a/docs/sdks/destinations/README.md b/docs/sdks/destinations/README.md index cb3d69b4..d1aa8b2d 100644 --- a/docs/sdks/destinations/README.md +++ b/docs/sdks/destinations/README.md @@ -31,13 +31,13 @@ s = airbyte.Airbyte( req = shared.DestinationCreateRequest( configuration=shared.DestinationGoogleSheets( - credentials=shared.AuthenticationViaGoogleOAuth( - client_id='string', - client_secret='string', - refresh_token='string', + credentials=shared.AuthenticationViaGoogleOAuth( + client_id='string', + client_secret='string', + refresh_token='string', + ), + spreadsheet_id='https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG/edit', ), - spreadsheet_id='https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG/edit', -), name='string', workspace_id='8360860a-d46e-48e6-af62-08e5ba5019ef', ) @@ -176,11 +176,7 @@ s = airbyte.Airbyte( ), ) -req = operations.ListDestinationsRequest( - workspace_ids=[ - 'c2980b9a-8317-4202-845c-d26fb4455227', - ], -) +req = operations.ListDestinationsRequest() res = s.destinations.list_destinations(req) @@ -226,16 +222,6 @@ s = airbyte.Airbyte( req = operations.PatchDestinationRequest( destination_id='string', - destination_patch_request=shared.DestinationPatchRequest( - configuration=shared.DestinationGoogleSheets( - credentials=shared.AuthenticationViaGoogleOAuth( - client_id='string', - client_secret='string', - refresh_token='string', - ), - spreadsheet_id='https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG/edit', - ), - ), ) res = s.destinations.patch_destination(req) @@ -282,17 +268,6 @@ s = airbyte.Airbyte( req = operations.PutDestinationRequest( destination_id='string', - destination_put_request=shared.DestinationPutRequest( - configuration=shared.DestinationGoogleSheets( - credentials=shared.AuthenticationViaGoogleOAuth( - client_id='string', - client_secret='string', - refresh_token='string', - ), - spreadsheet_id='https://docs.google.com/spreadsheets/d/1hLd9Qqti3UyLXZB2aFfUWDT7BG/edit', - ), - name='string', - ), ) res = s.destinations.put_destination(req) diff --git a/docs/sdks/jobs/README.md b/docs/sdks/jobs/README.md index bc759de2..81dc3c09 100644 --- a/docs/sdks/jobs/README.md +++ b/docs/sdks/jobs/README.md @@ -74,7 +74,7 @@ s = airbyte.Airbyte( ) req = shared.JobCreateRequest( - connection_id='string', + connection_id='18dccc91-0ab1-4f72-9ed7-0b8fc27c5826', job_type=shared.JobTypeEnum.SYNC, ) @@ -155,7 +155,6 @@ List Jobs by sync type ```python import airbyte -import dateutil.parser from airbyte.models import operations, shared s = airbyte.Airbyte( @@ -167,11 +166,7 @@ s = airbyte.Airbyte( ), ) -req = operations.ListJobsRequest( - workspace_ids=[ - 'c60f91a7-de80-41f6-b5d3-71c05bc4dea6', - ], -) +req = operations.ListJobsRequest() res = s.jobs.list_jobs(req) diff --git a/docs/sdks/sources/README.md b/docs/sdks/sources/README.md index 80831701..7573a554 100644 --- a/docs/sdks/sources/README.md +++ b/docs/sdks/sources/README.md @@ -19,7 +19,6 @@ Creates a source given a name, workspace id, and a json blob containing the conf ```python import airbyte -import dateutil.parser from airbyte.models import shared s = airbyte.Airbyte( @@ -33,9 +32,9 @@ s = airbyte.Airbyte( req = shared.SourceCreateRequest( configuration=shared.SourceAha( - api_key='string', - url='https://complicated-seat.org', -), + api_key='string', + url='https://complicated-seat.org', + ), name='string', workspace_id='0f31f3dd-c984-48c3-8bdf-b109056aa6d6', ) @@ -179,9 +178,9 @@ s = airbyte.Airbyte( ) req = shared.InitiateOauthRequest( - redirect_url='string', + redirect_url='https://cloud.airbyte.io/v1/api/oauth/callback', source_type=shared.OAuthActorNames.GOOGLE_ADS, - workspace_id='fd28130d-9919-4ffa-a67d-4e12eb099447', + workspace_id='871d9b60-11d1-44cb-8c92-c246d53bf87e', o_auth_input_configuration=shared.OAuthInputConfiguration(), ) @@ -227,11 +226,7 @@ s = airbyte.Airbyte( ), ) -req = operations.ListSourcesRequest( - workspace_ids=[ - '74dbbb77-f80b-457c-8540-0c5d47a64428', - ], -) +req = operations.ListSourcesRequest() res = s.sources.list_sources(req) @@ -264,7 +259,6 @@ Update a Source ```python import airbyte -import dateutil.parser from airbyte.models import operations, shared s = airbyte.Airbyte( @@ -278,13 +272,6 @@ s = airbyte.Airbyte( req = operations.PatchSourceRequest( source_id='string', - source_patch_request=shared.SourcePatchRequest( - configuration=shared.SourceAha( - api_key='string', - url='http://apprehensive-visa.net', - ), - name='My source', - ), ) res = s.sources.patch_source(req) @@ -318,7 +305,6 @@ Update a Source and fully overwrite it ```python import airbyte -import dateutil.parser from airbyte.models import operations, shared s = airbyte.Airbyte( @@ -332,13 +318,6 @@ s = airbyte.Airbyte( req = operations.PutSourceRequest( source_id='string', - source_put_request=shared.SourcePutRequest( - configuration=shared.SourceAha( - api_key='string', - url='http://alienated-traveler.name', - ), - name='string', - ), ) res = s.sources.put_source(req) diff --git a/docs/sdks/workspaces/README.md b/docs/sdks/workspaces/README.md index 3bf627d9..48e03515 100644 --- a/docs/sdks/workspaces/README.md +++ b/docs/sdks/workspaces/README.md @@ -33,9 +33,7 @@ s = airbyte.Airbyte( req = operations.CreateOrUpdateWorkspaceOAuthCredentialsRequest( workspace_o_auth_credentials_request=shared.WorkspaceOAuthCredentialsRequest( actor_type=shared.ActorTypeEnum.DESTINATION, - configuration=shared.Airtable( - credentials=shared.Credentials(), - ), + configuration=shared.Airtable(), name=shared.OAuthActorNames.AMAZON_ADS, ), workspace_id='string', @@ -221,11 +219,7 @@ s = airbyte.Airbyte( ), ) -req = operations.ListWorkspacesRequest( - workspace_ids=[ - '4953f9aa-3803-487f-945d-389888ede307', - ], -) +req = operations.ListWorkspacesRequest() res = s.workspaces.list_workspaces(req) diff --git a/src/airbyte/models/shared/source_alloydb.py b/src/airbyte/models/shared/source_alloydb.py index 5104df44..42000f4c 100644 --- a/src/airbyte/models/shared/source_alloydb.py +++ b/src/airbyte/models/shared/source_alloydb.py @@ -36,6 +36,7 @@ class Plugin(str, Enum): @dataclasses.dataclass class LogicalReplicationCDC: r"""Logical replication uses the Postgres write-ahead log (WAL) to detect inserts, updates, and deletes. This needs to be configured on the source database itself. Only available on Postgres 10 and above. Read the docs.""" + UNSET='__SPEAKEASY_UNSET__' publication: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('publication') }}) r"""A Postgres publication used for consuming changes. Read about publications and replication identities.""" replication_slot: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('replication_slot') }}) @@ -76,6 +77,7 @@ class SourceAlloydbSchemasSSLModeSSLModes6Mode(str, Enum): @dataclasses.dataclass class SourceAlloydbVerifyFull: r"""This is the most secure mode. Always require encryption and verifies the identity of the source database server.""" + UNSET='__SPEAKEASY_UNSET__' ca_certificate: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ca_certificate') }}) r"""CA certificate""" additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) @@ -97,6 +99,7 @@ class SourceAlloydbSchemasSSLModeSSLModes5Mode(str, Enum): @dataclasses.dataclass class SourceAlloydbVerifyCa: r"""Always require encryption and verifies that the source database server has a valid SSL certificate.""" + UNSET='__SPEAKEASY_UNSET__' ca_certificate: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ca_certificate') }}) r"""CA certificate""" additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) @@ -118,6 +121,7 @@ class SourceAlloydbSchemasSSLModeSSLModesMode(str, Enum): @dataclasses.dataclass class SourceAlloydbRequire: r"""Always require encryption. If the source database server does not support encryption, connection will fail.""" + UNSET='__SPEAKEASY_UNSET__' additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) MODE: Final[SourceAlloydbSchemasSSLModeSSLModesMode] = dataclasses.field(default=SourceAlloydbSchemasSSLModeSSLModesMode.REQUIRE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -131,6 +135,7 @@ class SourceAlloydbSchemasSslModeMode(str, Enum): @dataclasses.dataclass class SourceAlloydbPrefer: r"""Allows unencrypted connection only if the source database does not support encryption.""" + UNSET='__SPEAKEASY_UNSET__' additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) MODE: Final[SourceAlloydbSchemasSslModeMode] = dataclasses.field(default=SourceAlloydbSchemasSslModeMode.PREFER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -144,6 +149,7 @@ class SourceAlloydbSchemasMode(str, Enum): @dataclasses.dataclass class SourceAlloydbAllow: r"""Enables encryption only when required by the source database.""" + UNSET='__SPEAKEASY_UNSET__' additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) MODE: Final[SourceAlloydbSchemasMode] = dataclasses.field(default=SourceAlloydbSchemasMode.ALLOW, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -157,6 +163,7 @@ class SourceAlloydbMode(str, Enum): @dataclasses.dataclass class SourceAlloydbDisable: r"""Disables encryption of communication between Airbyte and source database.""" + UNSET='__SPEAKEASY_UNSET__' additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) MODE: Final[SourceAlloydbMode] = dataclasses.field(default=SourceAlloydbMode.DISABLE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) diff --git a/src/airbyte/models/shared/source_e2e_test_cloud.py b/src/airbyte/models/shared/source_e2e_test_cloud.py index 1903e6f2..25aa79ba 100644 --- a/src/airbyte/models/shared/source_e2e_test_cloud.py +++ b/src/airbyte/models/shared/source_e2e_test_cloud.py @@ -49,6 +49,7 @@ class Type(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class ContinuousFeed: + UNSET='__SPEAKEASY_UNSET__' mock_catalog: Union[SingleSchema, MultiSchema] = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mock_catalog') }}) additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) max_messages: Optional[int] = dataclasses.field(default=100, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('max_messages'), 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_harvest.py b/src/airbyte/models/shared/source_harvest.py index 01e7fc06..5bf0e0fb 100644 --- a/src/airbyte/models/shared/source_harvest.py +++ b/src/airbyte/models/shared/source_harvest.py @@ -16,6 +16,7 @@ class SourceHarvestSchemasAuthType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceHarvestAuthenticateWithPersonalAccessToken: + UNSET='__SPEAKEASY_UNSET__' api_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_token') }}) r"""Log into Harvest and then create new personal access token.""" additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) @@ -30,6 +31,7 @@ class SourceHarvestAuthType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class AuthenticateViaHarvestOAuth: + UNSET='__SPEAKEASY_UNSET__' client_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_id') }}) r"""The Client ID of your Harvest developer application.""" client_secret: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_secret') }}) diff --git a/src/airbyte/models/shared/source_mongodb_v2.py b/src/airbyte/models/shared/source_mongodb_v2.py index 50495bfd..a1717a56 100644 --- a/src/airbyte/models/shared/source_mongodb_v2.py +++ b/src/airbyte/models/shared/source_mongodb_v2.py @@ -15,6 +15,7 @@ class SourceMongodbV2SchemasClusterType(str, Enum): @dataclasses.dataclass class SelfManagedReplicaSet: r"""MongoDB self-hosted cluster configured as a replica set""" + UNSET='__SPEAKEASY_UNSET__' connection_string: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('connection_string') }}) r"""The connection string of the cluster that you want to replicate. https://www.mongodb.com/docs/manual/reference/connection-string/#find-your-self-hosted-deployment-s-connection-string for more information.""" database: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('database') }}) @@ -40,6 +41,7 @@ class SourceMongodbV2ClusterType(str, Enum): @dataclasses.dataclass class MongoDBAtlasReplicaSet: r"""MongoDB Atlas-hosted cluster configured as a replica set""" + UNSET='__SPEAKEASY_UNSET__' connection_string: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('connection_string') }}) r"""The connection string of the cluster that you want to replicate.""" database: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('database') }}) diff --git a/src/airbyte/models/shared/source_pinterest.py b/src/airbyte/models/shared/source_pinterest.py index ff0d223c..aa974d7e 100644 --- a/src/airbyte/models/shared/source_pinterest.py +++ b/src/airbyte/models/shared/source_pinterest.py @@ -240,13 +240,14 @@ class Status(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourcePinterest: + UNSET='__SPEAKEASY_UNSET__' credentials: Optional[OAuth20] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('credentials'), 'exclude': lambda f: f is None }}) custom_reports: Optional[List[ReportConfig]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('custom_reports'), 'exclude': lambda f: f is None }}) r"""A list which contains ad statistics entries, each entry must have a name and can contains fields, breakdowns or action_breakdowns. Click on \\"add\\" to fill this field.""" SOURCE_TYPE: Final[Optional[SourcePinterestPinterest]] = dataclasses.field(default=SourcePinterestPinterest.PINTEREST, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType'), 'exclude': lambda f: f is None }}) start_date: Optional[date] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_date'), 'encoder': utils.dateisoformat(True), 'decoder': utils.datefromisoformat, 'exclude': lambda f: f is None }}) r"""A date in the format YYYY-MM-DD. If you have not set a date, it would be defaulted to latest allowed date by api (89 days from today).""" - status: Optional[List[Status]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status') }}) + status: Optional[List[Status]] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('status'), 'exclude': lambda f: f is SourcePinterest.UNSET }}) r"""For the ads, ad_groups, and campaigns streams, specifying a status will filter out records that do not match the specified ones. If a status is not specified, the source will default to records with a status of either ACTIVE or PAUSED.""" diff --git a/src/airbyte/models/shared/source_postgres.py b/src/airbyte/models/shared/source_postgres.py index 118da3cc..ffbbb515 100644 --- a/src/airbyte/models/shared/source_postgres.py +++ b/src/airbyte/models/shared/source_postgres.py @@ -48,6 +48,7 @@ class SourcePostgresPlugin(str, Enum): @dataclasses.dataclass class ReadChangesUsingWriteAheadLogCDC: r"""Recommended - Incrementally reads new inserts, updates, and deletes using the Postgres write-ahead log (WAL). This needs to be configured on the source database itself. Recommended for tables of any size.""" + UNSET='__SPEAKEASY_UNSET__' publication: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('publication') }}) r"""A Postgres publication used for consuming changes. Read about publications and replication identities.""" replication_slot: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('replication_slot') }}) @@ -76,6 +77,7 @@ class SourcePostgresSchemasSSLModeSSLModes6Mode(str, Enum): @dataclasses.dataclass class SourcePostgresVerifyFull: r"""This is the most secure mode. Always require encryption and verifies the identity of the source database server.""" + UNSET='__SPEAKEASY_UNSET__' ca_certificate: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ca_certificate') }}) r"""CA certificate""" additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) @@ -97,6 +99,7 @@ class SourcePostgresSchemasSSLModeSSLModes5Mode(str, Enum): @dataclasses.dataclass class SourcePostgresVerifyCa: r"""Always require encryption and verifies that the source database server has a valid SSL certificate.""" + UNSET='__SPEAKEASY_UNSET__' ca_certificate: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('ca_certificate') }}) r"""CA certificate""" additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) @@ -118,6 +121,7 @@ class SourcePostgresSchemasSSLModeSSLModesMode(str, Enum): @dataclasses.dataclass class SourcePostgresRequire: r"""Always require encryption. If the source database server does not support encryption, connection will fail.""" + UNSET='__SPEAKEASY_UNSET__' additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) MODE: Final[SourcePostgresSchemasSSLModeSSLModesMode] = dataclasses.field(default=SourcePostgresSchemasSSLModeSSLModesMode.REQUIRE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -131,6 +135,7 @@ class SourcePostgresSchemasSslModeMode(str, Enum): @dataclasses.dataclass class SourcePostgresPrefer: r"""Allows unencrypted connection only if the source database does not support encryption.""" + UNSET='__SPEAKEASY_UNSET__' additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) MODE: Final[SourcePostgresSchemasSslModeMode] = dataclasses.field(default=SourcePostgresSchemasSslModeMode.PREFER, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -144,6 +149,7 @@ class SourcePostgresSchemasMode(str, Enum): @dataclasses.dataclass class SourcePostgresAllow: r"""Enables encryption only when required by the source database.""" + UNSET='__SPEAKEASY_UNSET__' additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) MODE: Final[SourcePostgresSchemasMode] = dataclasses.field(default=SourcePostgresSchemasMode.ALLOW, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) @@ -157,6 +163,7 @@ class SourcePostgresMode(str, Enum): @dataclasses.dataclass class SourcePostgresDisable: r"""Disables encryption of communication between Airbyte and source database.""" + UNSET='__SPEAKEASY_UNSET__' additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) MODE: Final[SourcePostgresMode] = dataclasses.field(default=SourcePostgresMode.DISABLE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('mode') }}) diff --git a/src/airbyte/models/shared/source_retently.py b/src/airbyte/models/shared/source_retently.py index 1b55db58..b3dbea5f 100644 --- a/src/airbyte/models/shared/source_retently.py +++ b/src/airbyte/models/shared/source_retently.py @@ -14,6 +14,7 @@ class SourceRetentlySchemasAuthType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class AuthenticateWithAPIToken: + UNSET='__SPEAKEASY_UNSET__' api_key: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_key') }}) r"""Retently API Token. See the docs for more information on how to obtain this key.""" additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) @@ -28,6 +29,7 @@ class SourceRetentlyAuthType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class AuthenticateViaRetentlyOAuth: + UNSET='__SPEAKEASY_UNSET__' client_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_id') }}) r"""The Client ID of your Retently developer application.""" client_secret: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_secret') }}) diff --git a/src/airbyte/models/shared/source_youtube_analytics.py b/src/airbyte/models/shared/source_youtube_analytics.py index bd2da8ce..c974bf67 100644 --- a/src/airbyte/models/shared/source_youtube_analytics.py +++ b/src/airbyte/models/shared/source_youtube_analytics.py @@ -11,6 +11,7 @@ @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class AuthenticateViaOAuth20: + UNSET='__SPEAKEASY_UNSET__' client_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_id') }}) r"""The Client ID of your developer application""" client_secret: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_secret') }}) diff --git a/src/airbyte/models/shared/source_zendesk_support.py b/src/airbyte/models/shared/source_zendesk_support.py index 097bf5f6..5a5267ab 100644 --- a/src/airbyte/models/shared/source_zendesk_support.py +++ b/src/airbyte/models/shared/source_zendesk_support.py @@ -16,6 +16,7 @@ class SourceZendeskSupportSchemasCredentials(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceZendeskSupportAPIToken: + UNSET='__SPEAKEASY_UNSET__' api_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_token') }}) r"""The value of the API token generated. See our full documentation for more information on generating this token.""" email: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('email') }}) @@ -32,6 +33,7 @@ class SourceZendeskSupportCredentials(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceZendeskSupportOAuth20: + UNSET='__SPEAKEASY_UNSET__' access_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('access_token') }}) r"""The OAuth access token. See the Zendesk docs for more information on generating this token.""" additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) diff --git a/src/airbyte/models/shared/source_zendesk_talk.py b/src/airbyte/models/shared/source_zendesk_talk.py index 41b52947..5bf34695 100644 --- a/src/airbyte/models/shared/source_zendesk_talk.py +++ b/src/airbyte/models/shared/source_zendesk_talk.py @@ -16,6 +16,7 @@ class SourceZendeskTalkSchemasAuthType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceZendeskTalkOAuth20: + UNSET='__SPEAKEASY_UNSET__' access_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('access_token') }}) r"""The value of the API token generated. See the docs for more information.""" additional_properties: Optional[Dict[str, Any]] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'exclude': lambda f: f is None }}) @@ -34,6 +35,7 @@ class SourceZendeskTalkAuthType(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceZendeskTalkAPIToken: + UNSET='__SPEAKEASY_UNSET__' api_token: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('api_token') }}) r"""The value of the API token generated. See the docs for more information.""" email: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('email') }}) diff --git a/src/airbyte/models/shared/source_zoho_crm.py b/src/airbyte/models/shared/source_zoho_crm.py index 50d92bff..4e60cb63 100644 --- a/src/airbyte/models/shared/source_zoho_crm.py +++ b/src/airbyte/models/shared/source_zoho_crm.py @@ -39,6 +39,7 @@ class ZohoCrm(str, Enum): @dataclass_json(undefined=Undefined.EXCLUDE) @dataclasses.dataclass class SourceZohoCrm: + UNSET='__SPEAKEASY_UNSET__' client_id: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_id') }}) r"""OAuth2.0 Client ID""" client_secret: str = dataclasses.field(metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('client_secret') }}) @@ -52,7 +53,7 @@ class SourceZohoCrm: edition: Optional[ZohoCRMEdition] = dataclasses.field(default=ZohoCRMEdition.FREE, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('edition'), 'exclude': lambda f: f is None }}) r"""Choose your Edition of Zoho CRM to determine API Concurrency Limits""" SOURCE_TYPE: Final[ZohoCrm] = dataclasses.field(default=ZohoCrm.ZOHO_CRM, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('sourceType') }}) - start_datetime: Optional[datetime] = dataclasses.field(default=None, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_datetime'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse }}) + start_datetime: Optional[datetime] = dataclasses.field(default=UNSET, metadata={'dataclasses_json': { 'letter_case': utils.get_field_name('start_datetime'), 'encoder': utils.datetimeisoformat(True), 'decoder': dateutil.parser.isoparse, 'exclude': lambda f: f is SourceZohoCrm.UNSET }}) r"""ISO 8601, for instance: `YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS+HH:MM`""" diff --git a/src/airbyte/sdkconfiguration.py b/src/airbyte/sdkconfiguration.py index fe02b389..fa821f83 100644 --- a/src/airbyte/sdkconfiguration.py +++ b/src/airbyte/sdkconfiguration.py @@ -1,11 +1,12 @@ """Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.""" -import requests -from dataclasses import dataclass -from typing import Dict, Tuple, Callable, Union -from .utils.retries import RetryConfig + +import requests as requests_http from .utils import utils +from .utils.retries import RetryConfig from airbyte.models import shared +from dataclasses import dataclass +from typing import Callable, Dict, Tuple, Union SERVERS = [ @@ -16,15 +17,15 @@ @dataclass class SDKConfiguration: - client: requests.Session + client: requests_http.Session security: Union[shared.Security,Callable[[], shared.Security]] = None server_url: str = '' server_idx: int = 0 language: str = 'python' openapi_doc_version: str = '1.0.0' sdk_version: str = '0.47.0' - gen_version: str = '2.250.12' - user_agent: str = 'speakeasy-sdk/python 0.47.0 2.250.12 1.0.0 airbyte-api' + gen_version: str = '2.253.0' + user_agent: str = 'speakeasy-sdk/python 0.47.0 2.253.0 1.0.0 airbyte-api' retry_config: RetryConfig = None def get_server_details(self) -> Tuple[str, Dict[str, str]]: